aws-sdk-cognitoidentityprovider 1.64.0 → 1.65.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cognitoidentityprovider/client.rb +291 -248
- data/lib/aws-sdk-cognitoidentityprovider/client_api.rb +2 -1
- data/lib/aws-sdk-cognitoidentityprovider/types.rb +223 -129
- data/lib/aws-sdk-cognitoidentityprovider.rb +1 -1
- metadata +2 -2
@@ -461,8 +461,8 @@ module Aws::CognitoIdentityProvider
|
|
461
461
|
# can process the ClientMetadata value to enhance your workflow for your
|
462
462
|
# specific needs.
|
463
463
|
#
|
464
|
-
# For more information, see [Customizing
|
465
|
-
# Triggers][1] in the *Amazon Cognito Developer Guide*.
|
464
|
+
# For more information, see [ Customizing user pool Workflows with
|
465
|
+
# Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
|
466
466
|
#
|
467
467
|
# <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
|
468
468
|
# Cognito won't do the following:
|
@@ -511,22 +511,22 @@ module Aws::CognitoIdentityProvider
|
|
511
511
|
#
|
512
512
|
# <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
|
513
513
|
# US telecom carriers require you to register an origination phone
|
514
|
-
# number before you can send SMS messages to
|
514
|
+
# number before you can send SMS messages to US phone numbers. If you
|
515
515
|
# use SMS text messages in Amazon Cognito, you must register a phone
|
516
|
-
# number with [Amazon Pinpoint][1]. Amazon Cognito
|
517
|
-
#
|
518
|
-
#
|
519
|
-
#
|
516
|
+
# number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
|
517
|
+
# number automatically. Otherwise, Amazon Cognito users who must receive
|
518
|
+
# SMS messages might not be able to sign up, activate their accounts, or
|
519
|
+
# sign in.
|
520
520
|
#
|
521
521
|
# If you have never used SMS text messages with Amazon Cognito or any
|
522
522
|
# other Amazon Web Service, Amazon Simple Notification Service might
|
523
|
-
# place your account in SMS sandbox. In <i> <a
|
523
|
+
# place your account in the SMS sandbox. In <i> <a
|
524
524
|
# href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
525
|
-
# mode</a> </i>, you
|
526
|
-
#
|
527
|
-
#
|
528
|
-
#
|
529
|
-
#
|
525
|
+
# mode</a> </i>, you can send messages only to verified phone numbers.
|
526
|
+
# After you test your app while in the sandbox environment, you can move
|
527
|
+
# out of the sandbox and into production. For more information, see [
|
528
|
+
# SMS message settings for Amazon Cognito user pools][2] in the *Amazon
|
529
|
+
# Cognito Developer Guide*.
|
530
530
|
#
|
531
531
|
# </note>
|
532
532
|
#
|
@@ -663,8 +663,8 @@ module Aws::CognitoIdentityProvider
|
|
663
663
|
# your function code in Lambda, you can process the `clientMetadata`
|
664
664
|
# value to enhance your workflow for your specific needs.
|
665
665
|
#
|
666
|
-
# For more information, see [Customizing
|
667
|
-
# Triggers][1] in the *Amazon Cognito Developer Guide*.
|
666
|
+
# For more information, see [ Customizing user pool Workflows with
|
667
|
+
# Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
|
668
668
|
#
|
669
669
|
# <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
|
670
670
|
# Cognito won't do the following:
|
@@ -805,14 +805,14 @@ module Aws::CognitoIdentityProvider
|
|
805
805
|
req.send_request(options)
|
806
806
|
end
|
807
807
|
|
808
|
-
#
|
809
|
-
# social) identity provider. If the user
|
810
|
-
#
|
811
|
-
# use their password to sign in. If the user to deactivate is a
|
812
|
-
# external identity provider (IdP) user, any link between that
|
813
|
-
# an existing user is removed.
|
814
|
-
# longer attached to the previously linked
|
815
|
-
#
|
808
|
+
# Prevents the user from signing in with the specified external (SAML or
|
809
|
+
# social) identity provider. If the user that you want to deactivate is
|
810
|
+
# a Amazon Cognito user pools native username + password user, they
|
811
|
+
# can't use their password to sign in. If the user to deactivate is a
|
812
|
+
# linked external identity provider (IdP) user, any link between that
|
813
|
+
# user and an existing user is removed. When the external user signs in
|
814
|
+
# again, and the user is no longer attached to the previously linked
|
815
|
+
# `DestinationUser`, the user must create a new user account. See
|
816
816
|
# [AdminLinkProviderForUser][1].
|
817
817
|
#
|
818
818
|
# This action is enabled only for admin access and requires developer
|
@@ -1066,22 +1066,22 @@ module Aws::CognitoIdentityProvider
|
|
1066
1066
|
#
|
1067
1067
|
# <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
|
1068
1068
|
# US telecom carriers require you to register an origination phone
|
1069
|
-
# number before you can send SMS messages to
|
1069
|
+
# number before you can send SMS messages to US phone numbers. If you
|
1070
1070
|
# use SMS text messages in Amazon Cognito, you must register a phone
|
1071
|
-
# number with [Amazon Pinpoint][1]. Amazon Cognito
|
1072
|
-
#
|
1073
|
-
#
|
1074
|
-
#
|
1071
|
+
# number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
|
1072
|
+
# number automatically. Otherwise, Amazon Cognito users who must receive
|
1073
|
+
# SMS messages might not be able to sign up, activate their accounts, or
|
1074
|
+
# sign in.
|
1075
1075
|
#
|
1076
1076
|
# If you have never used SMS text messages with Amazon Cognito or any
|
1077
1077
|
# other Amazon Web Service, Amazon Simple Notification Service might
|
1078
|
-
# place your account in SMS sandbox. In <i> <a
|
1078
|
+
# place your account in the SMS sandbox. In <i> <a
|
1079
1079
|
# href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
1080
|
-
# mode</a> </i>, you
|
1081
|
-
#
|
1082
|
-
#
|
1083
|
-
#
|
1084
|
-
#
|
1080
|
+
# mode</a> </i>, you can send messages only to verified phone numbers.
|
1081
|
+
# After you test your app while in the sandbox environment, you can move
|
1082
|
+
# out of the sandbox and into production. For more information, see [
|
1083
|
+
# SMS message settings for Amazon Cognito user pools][2] in the *Amazon
|
1084
|
+
# Cognito Developer Guide*.
|
1085
1085
|
#
|
1086
1086
|
# </note>
|
1087
1087
|
#
|
@@ -1194,8 +1194,8 @@ module Aws::CognitoIdentityProvider
|
|
1194
1194
|
#
|
1195
1195
|
# * Verify auth challenge
|
1196
1196
|
#
|
1197
|
-
# For more information, see [Customizing
|
1198
|
-
# Triggers][1] in the *Amazon Cognito Developer Guide*.
|
1197
|
+
# For more information, see [ Customizing user pool Workflows with
|
1198
|
+
# Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
|
1199
1199
|
#
|
1200
1200
|
# <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
|
1201
1201
|
# Cognito won't do the following:
|
@@ -1312,12 +1312,13 @@ module Aws::CognitoIdentityProvider
|
|
1312
1312
|
# The user pool ID for the user pool.
|
1313
1313
|
#
|
1314
1314
|
# @option params [required, Types::ProviderUserIdentifierType] :destination_user
|
1315
|
-
# The existing user in the user pool
|
1316
|
-
# identity provider user account.
|
1317
|
-
# Amazon Cognito
|
1318
|
-
# SAML or Facebook user). If the user doesn't
|
1319
|
-
#
|
1320
|
-
# linked identity provider
|
1315
|
+
# The existing user in the user pool that you want to assign to the
|
1316
|
+
# external identity provider user account. This user can be a native
|
1317
|
+
# (Username + Password) Amazon Cognito user pools user or a federated
|
1318
|
+
# user (for example, a SAML or Facebook user). If the user doesn't
|
1319
|
+
# exist, Amazon Cognito generates an exception. Amazon Cognito returns
|
1320
|
+
# this user when the new user (with the linked identity provider
|
1321
|
+
# attribute) signs in.
|
1321
1322
|
#
|
1322
1323
|
# For a native username + password user, the `ProviderAttributeValue`
|
1323
1324
|
# for the `DestinationUser` should be the username in the user pool. For
|
@@ -1601,22 +1602,22 @@ module Aws::CognitoIdentityProvider
|
|
1601
1602
|
#
|
1602
1603
|
# <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
|
1603
1604
|
# US telecom carriers require you to register an origination phone
|
1604
|
-
# number before you can send SMS messages to
|
1605
|
+
# number before you can send SMS messages to US phone numbers. If you
|
1605
1606
|
# use SMS text messages in Amazon Cognito, you must register a phone
|
1606
|
-
# number with [Amazon Pinpoint][1]. Amazon Cognito
|
1607
|
-
#
|
1608
|
-
#
|
1609
|
-
#
|
1607
|
+
# number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
|
1608
|
+
# number automatically. Otherwise, Amazon Cognito users who must receive
|
1609
|
+
# SMS messages might not be able to sign up, activate their accounts, or
|
1610
|
+
# sign in.
|
1610
1611
|
#
|
1611
1612
|
# If you have never used SMS text messages with Amazon Cognito or any
|
1612
1613
|
# other Amazon Web Service, Amazon Simple Notification Service might
|
1613
|
-
# place your account in SMS sandbox. In <i> <a
|
1614
|
+
# place your account in the SMS sandbox. In <i> <a
|
1614
1615
|
# href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
1615
|
-
# mode</a> </i>, you
|
1616
|
-
#
|
1617
|
-
#
|
1618
|
-
#
|
1619
|
-
#
|
1616
|
+
# mode</a> </i>, you can send messages only to verified phone numbers.
|
1617
|
+
# After you test your app while in the sandbox environment, you can move
|
1618
|
+
# out of the sandbox and into production. For more information, see [
|
1619
|
+
# SMS message settings for Amazon Cognito user pools][2] in the *Amazon
|
1620
|
+
# Cognito Developer Guide*.
|
1620
1621
|
#
|
1621
1622
|
# </note>
|
1622
1623
|
#
|
@@ -1649,8 +1650,8 @@ module Aws::CognitoIdentityProvider
|
|
1649
1650
|
# `clientMetadata` value to enhance your workflow for your specific
|
1650
1651
|
# needs.
|
1651
1652
|
#
|
1652
|
-
# For more information, see [Customizing
|
1653
|
-
# Triggers][1] in the *Amazon Cognito Developer Guide*.
|
1653
|
+
# For more information, see [ Customizing user pool Workflows with
|
1654
|
+
# Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
|
1654
1655
|
#
|
1655
1656
|
# <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
|
1656
1657
|
# Cognito won't do the following:
|
@@ -1696,22 +1697,22 @@ module Aws::CognitoIdentityProvider
|
|
1696
1697
|
#
|
1697
1698
|
# <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
|
1698
1699
|
# US telecom carriers require you to register an origination phone
|
1699
|
-
# number before you can send SMS messages to
|
1700
|
+
# number before you can send SMS messages to US phone numbers. If you
|
1700
1701
|
# use SMS text messages in Amazon Cognito, you must register a phone
|
1701
|
-
# number with [Amazon Pinpoint][1]. Amazon Cognito
|
1702
|
-
#
|
1703
|
-
#
|
1704
|
-
#
|
1702
|
+
# number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
|
1703
|
+
# number automatically. Otherwise, Amazon Cognito users who must receive
|
1704
|
+
# SMS messages might not be able to sign up, activate their accounts, or
|
1705
|
+
# sign in.
|
1705
1706
|
#
|
1706
1707
|
# If you have never used SMS text messages with Amazon Cognito or any
|
1707
1708
|
# other Amazon Web Service, Amazon Simple Notification Service might
|
1708
|
-
# place your account in SMS sandbox. In <i> <a
|
1709
|
+
# place your account in the SMS sandbox. In <i> <a
|
1709
1710
|
# href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
1710
|
-
# mode</a> </i>, you
|
1711
|
-
#
|
1712
|
-
#
|
1713
|
-
#
|
1714
|
-
#
|
1711
|
+
# mode</a> </i>, you can send messages only to verified phone numbers.
|
1712
|
+
# After you test your app while in the sandbox environment, you can move
|
1713
|
+
# out of the sandbox and into production. For more information, see [
|
1714
|
+
# SMS message settings for Amazon Cognito user pools][2] in the *Amazon
|
1715
|
+
# Cognito Developer Guide*.
|
1715
1716
|
#
|
1716
1717
|
# </note>
|
1717
1718
|
#
|
@@ -1790,20 +1791,35 @@ module Aws::CognitoIdentityProvider
|
|
1790
1791
|
#
|
1791
1792
|
# You create custom workflows by assigning Lambda functions to user pool
|
1792
1793
|
# triggers. When you use the AdminRespondToAuthChallenge API action,
|
1793
|
-
# Amazon Cognito invokes any functions that
|
1794
|
-
# following triggers:
|
1795
|
-
#
|
1796
|
-
#
|
1797
|
-
#
|
1798
|
-
#
|
1799
|
-
#
|
1800
|
-
#
|
1801
|
-
#
|
1802
|
-
#
|
1803
|
-
#
|
1794
|
+
# Amazon Cognito invokes any functions that you have assigned to the
|
1795
|
+
# following triggers:
|
1796
|
+
#
|
1797
|
+
# * pre sign-up
|
1798
|
+
#
|
1799
|
+
# * custom message
|
1800
|
+
#
|
1801
|
+
# * post authentication
|
1802
|
+
#
|
1803
|
+
# * user migration
|
1804
|
+
#
|
1805
|
+
# * pre token generation
|
1806
|
+
#
|
1807
|
+
# * define auth challenge
|
1808
|
+
#
|
1809
|
+
# * create auth challenge
|
1810
|
+
#
|
1811
|
+
# * verify auth challenge response
|
1804
1812
|
#
|
1805
|
-
#
|
1806
|
-
#
|
1813
|
+
# When Amazon Cognito invokes any of these functions, it passes a JSON
|
1814
|
+
# payload, which the function receives as input. This payload contains a
|
1815
|
+
# `clientMetadata` attribute that provides the data that you assigned to
|
1816
|
+
# the ClientMetadata parameter in your AdminRespondToAuthChallenge
|
1817
|
+
# request. In your function code in Lambda, you can process the
|
1818
|
+
# `clientMetadata` value to enhance your workflow for your specific
|
1819
|
+
# needs.
|
1820
|
+
#
|
1821
|
+
# For more information, see [ Customizing user pool Workflows with
|
1822
|
+
# Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
|
1807
1823
|
#
|
1808
1824
|
# <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
|
1809
1825
|
# Cognito won't do the following:
|
@@ -2103,22 +2119,22 @@ module Aws::CognitoIdentityProvider
|
|
2103
2119
|
#
|
2104
2120
|
# <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
|
2105
2121
|
# US telecom carriers require you to register an origination phone
|
2106
|
-
# number before you can send SMS messages to
|
2122
|
+
# number before you can send SMS messages to US phone numbers. If you
|
2107
2123
|
# use SMS text messages in Amazon Cognito, you must register a phone
|
2108
|
-
# number with [Amazon Pinpoint][1]. Amazon Cognito
|
2109
|
-
#
|
2110
|
-
#
|
2111
|
-
#
|
2124
|
+
# number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
|
2125
|
+
# number automatically. Otherwise, Amazon Cognito users who must receive
|
2126
|
+
# SMS messages might not be able to sign up, activate their accounts, or
|
2127
|
+
# sign in.
|
2112
2128
|
#
|
2113
2129
|
# If you have never used SMS text messages with Amazon Cognito or any
|
2114
2130
|
# other Amazon Web Service, Amazon Simple Notification Service might
|
2115
|
-
# place your account in SMS sandbox. In <i> <a
|
2131
|
+
# place your account in the SMS sandbox. In <i> <a
|
2116
2132
|
# href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
2117
|
-
# mode</a> </i>, you
|
2118
|
-
#
|
2119
|
-
#
|
2120
|
-
#
|
2121
|
-
#
|
2133
|
+
# mode</a> </i>, you can send messages only to verified phone numbers.
|
2134
|
+
# After you test your app while in the sandbox environment, you can move
|
2135
|
+
# out of the sandbox and into production. For more information, see [
|
2136
|
+
# SMS message settings for Amazon Cognito user pools][2] in the *Amazon
|
2137
|
+
# Cognito Developer Guide*.
|
2122
2138
|
#
|
2123
2139
|
# </note>
|
2124
2140
|
#
|
@@ -2157,8 +2173,8 @@ module Aws::CognitoIdentityProvider
|
|
2157
2173
|
# you can process the `clientMetadata` value to enhance your workflow
|
2158
2174
|
# for your specific needs.
|
2159
2175
|
#
|
2160
|
-
# For more information, see [Customizing
|
2161
|
-
# Triggers][1] in the *Amazon Cognito Developer Guide*.
|
2176
|
+
# For more information, see [ Customizing user pool Workflows with
|
2177
|
+
# Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
|
2162
2178
|
#
|
2163
2179
|
# <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
|
2164
2180
|
# Cognito won't do the following:
|
@@ -2410,8 +2426,8 @@ module Aws::CognitoIdentityProvider
|
|
2410
2426
|
# can process the `clientMetadata` value to enhance your workflow for
|
2411
2427
|
# your specific needs.
|
2412
2428
|
#
|
2413
|
-
# For more information, see [Customizing
|
2414
|
-
# Triggers][1] in the *Amazon Cognito Developer Guide*.
|
2429
|
+
# For more information, see [ Customizing user pool Workflows with
|
2430
|
+
# Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
|
2415
2431
|
#
|
2416
2432
|
# <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
|
2417
2433
|
# Cognito won't do the following:
|
@@ -2512,8 +2528,8 @@ module Aws::CognitoIdentityProvider
|
|
2512
2528
|
# function code in Lambda, you can process the `clientMetadata` value to
|
2513
2529
|
# enhance your workflow for your specific needs.
|
2514
2530
|
#
|
2515
|
-
# For more information, see [Customizing
|
2516
|
-
# Triggers][1] in the *Amazon Cognito Developer Guide*.
|
2531
|
+
# For more information, see [ Customizing user pool Workflows with
|
2532
|
+
# Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
|
2517
2533
|
#
|
2518
2534
|
# <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
|
2519
2535
|
# Cognito won't do the following:
|
@@ -2868,22 +2884,22 @@ module Aws::CognitoIdentityProvider
|
|
2868
2884
|
#
|
2869
2885
|
# <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
|
2870
2886
|
# US telecom carriers require you to register an origination phone
|
2871
|
-
# number before you can send SMS messages to
|
2887
|
+
# number before you can send SMS messages to US phone numbers. If you
|
2872
2888
|
# use SMS text messages in Amazon Cognito, you must register a phone
|
2873
|
-
# number with [Amazon Pinpoint][1]. Amazon Cognito
|
2874
|
-
#
|
2875
|
-
#
|
2876
|
-
#
|
2889
|
+
# number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
|
2890
|
+
# number automatically. Otherwise, Amazon Cognito users who must receive
|
2891
|
+
# SMS messages might not be able to sign up, activate their accounts, or
|
2892
|
+
# sign in.
|
2877
2893
|
#
|
2878
2894
|
# If you have never used SMS text messages with Amazon Cognito or any
|
2879
2895
|
# other Amazon Web Service, Amazon Simple Notification Service might
|
2880
|
-
# place your account in SMS sandbox. In <i> <a
|
2896
|
+
# place your account in the SMS sandbox. In <i> <a
|
2881
2897
|
# href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
2882
|
-
# mode</a> </i>, you
|
2883
|
-
#
|
2884
|
-
#
|
2885
|
-
#
|
2886
|
-
#
|
2898
|
+
# mode</a> </i>, you can send messages only to verified phone numbers.
|
2899
|
+
# After you test your app while in the sandbox environment, you can move
|
2900
|
+
# out of the sandbox and into production. For more information, see [
|
2901
|
+
# SMS message settings for Amazon Cognito user pools][2] in the *Amazon
|
2902
|
+
# Cognito Developer Guide*.
|
2887
2903
|
#
|
2888
2904
|
# </note>
|
2889
2905
|
#
|
@@ -2967,10 +2983,17 @@ module Aws::CognitoIdentityProvider
|
|
2967
2983
|
# The device configuration.
|
2968
2984
|
#
|
2969
2985
|
# @option params [Types::EmailConfigurationType] :email_configuration
|
2970
|
-
# The email configuration.
|
2986
|
+
# The email configuration of your user pool. The email configuration
|
2987
|
+
# type sets your preferred sending method, Amazon Web Services Region,
|
2988
|
+
# and sender for messages from your user pool.
|
2971
2989
|
#
|
2972
2990
|
# @option params [Types::SmsConfigurationType] :sms_configuration
|
2973
|
-
# The SMS configuration
|
2991
|
+
# The SMS configuration with the settings that your Amazon Cognito user
|
2992
|
+
# pool must use to send an SMS message from your Amazon Web Services
|
2993
|
+
# account through Amazon Simple Notification Service. To send SMS
|
2994
|
+
# messages with Amazon SNS in the Amazon Web Services Region that you
|
2995
|
+
# want, the Amazon Cognito user pool uses an Identity and Access
|
2996
|
+
# Management (IAM) role in your Amazon Web Services account.
|
2974
2997
|
#
|
2975
2998
|
# @option params [Hash<String,String>] :user_pool_tags
|
2976
2999
|
# The tag keys and values to assign to the user pool. A tag is a label
|
@@ -3078,6 +3101,7 @@ module Aws::CognitoIdentityProvider
|
|
3078
3101
|
# sms_configuration: {
|
3079
3102
|
# sns_caller_arn: "ArnType", # required
|
3080
3103
|
# external_id: "StringType",
|
3104
|
+
# sns_region: "RegionCodeType",
|
3081
3105
|
# },
|
3082
3106
|
# user_pool_tags: {
|
3083
3107
|
# "TagKeysType" => "TagValueType",
|
@@ -3189,6 +3213,7 @@ module Aws::CognitoIdentityProvider
|
|
3189
3213
|
# resp.user_pool.email_configuration.configuration_set #=> String
|
3190
3214
|
# resp.user_pool.sms_configuration.sns_caller_arn #=> String
|
3191
3215
|
# resp.user_pool.sms_configuration.external_id #=> String
|
3216
|
+
# resp.user_pool.sms_configuration.sns_region #=> String
|
3192
3217
|
# resp.user_pool.user_pool_tags #=> Hash
|
3193
3218
|
# resp.user_pool.user_pool_tags["TagKeysType"] #=> String
|
3194
3219
|
# resp.user_pool.sms_configuration_failure #=> String
|
@@ -3262,13 +3287,13 @@ module Aws::CognitoIdentityProvider
|
|
3262
3287
|
# The user pool attributes that the app client can write to.
|
3263
3288
|
#
|
3264
3289
|
# If your app client allows users to sign in through an identity
|
3265
|
-
# provider, this array must include all attributes that
|
3266
|
-
# identity provider attributes. Amazon Cognito updates mapped
|
3267
|
-
# when users sign in to your application through an identity
|
3268
|
-
# If your app client
|
3269
|
-
# Cognito throws an error when it tries to update the
|
3270
|
-
# more information, see [Specifying Identity Provider
|
3271
|
-
# for Your
|
3290
|
+
# provider, this array must include all attributes that you have mapped
|
3291
|
+
# to identity provider attributes. Amazon Cognito updates mapped
|
3292
|
+
# attributes when users sign in to your application through an identity
|
3293
|
+
# provider. If your app client does not have write access to a mapped
|
3294
|
+
# attribute, Amazon Cognito throws an error when it tries to update the
|
3295
|
+
# attribute. For more information, see [Specifying Identity Provider
|
3296
|
+
# Attribute Mappings for Your user pool][1].
|
3272
3297
|
#
|
3273
3298
|
#
|
3274
3299
|
#
|
@@ -3277,8 +3302,12 @@ module Aws::CognitoIdentityProvider
|
|
3277
3302
|
# @option params [Array<String>] :explicit_auth_flows
|
3278
3303
|
# The authentication flows that are supported by the user pool clients.
|
3279
3304
|
# Flow names without the `ALLOW_` prefix are no longer supported, in
|
3280
|
-
# favor of new names with the `ALLOW_` prefix.
|
3281
|
-
#
|
3305
|
+
# favor of new names with the `ALLOW_` prefix.
|
3306
|
+
#
|
3307
|
+
# <note markdown="1"> Values with `ALLOW_` prefix must be used only along with the `ALLOW_`
|
3308
|
+
# prefix.
|
3309
|
+
#
|
3310
|
+
# </note>
|
3282
3311
|
#
|
3283
3312
|
# Valid values include:
|
3284
3313
|
#
|
@@ -3376,14 +3405,14 @@ module Aws::CognitoIdentityProvider
|
|
3376
3405
|
# interacting with Amazon Cognito user pools.
|
3377
3406
|
#
|
3378
3407
|
# @option params [Types::AnalyticsConfigurationType] :analytics_configuration
|
3379
|
-
# The
|
3380
|
-
#
|
3408
|
+
# The user pool analytics configuration for collecting metrics and
|
3409
|
+
# sending them to your Amazon Pinpoint campaign.
|
3381
3410
|
#
|
3382
|
-
# <note markdown="1"> In Amazon Web Services Regions where isn't available,
|
3383
|
-
#
|
3384
|
-
# Services Region us-east-1. In Regions where
|
3385
|
-
#
|
3386
|
-
# same Region.
|
3411
|
+
# <note markdown="1"> In Amazon Web Services Regions where Amazon Pinpoint isn't available,
|
3412
|
+
# user pools only support sending events to Amazon Pinpoint projects in
|
3413
|
+
# Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint
|
3414
|
+
# is available, user pools support sending events to Amazon Pinpoint
|
3415
|
+
# projects within that same Region.
|
3387
3416
|
#
|
3388
3417
|
# </note>
|
3389
3418
|
#
|
@@ -4029,6 +4058,7 @@ module Aws::CognitoIdentityProvider
|
|
4029
4058
|
# resp.user_pool.email_configuration.configuration_set #=> String
|
4030
4059
|
# resp.user_pool.sms_configuration.sns_caller_arn #=> String
|
4031
4060
|
# resp.user_pool.sms_configuration.external_id #=> String
|
4061
|
+
# resp.user_pool.sms_configuration.sns_region #=> String
|
4032
4062
|
# resp.user_pool.user_pool_tags #=> Hash
|
4033
4063
|
# resp.user_pool.user_pool_tags["TagKeysType"] #=> String
|
4034
4064
|
# resp.user_pool.sms_configuration_failure #=> String
|
@@ -4200,22 +4230,22 @@ module Aws::CognitoIdentityProvider
|
|
4200
4230
|
#
|
4201
4231
|
# <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
|
4202
4232
|
# US telecom carriers require you to register an origination phone
|
4203
|
-
# number before you can send SMS messages to
|
4233
|
+
# number before you can send SMS messages to US phone numbers. If you
|
4204
4234
|
# use SMS text messages in Amazon Cognito, you must register a phone
|
4205
|
-
# number with [Amazon Pinpoint][3]. Amazon Cognito
|
4206
|
-
#
|
4207
|
-
#
|
4208
|
-
#
|
4235
|
+
# number with [Amazon Pinpoint][3]. Amazon Cognito uses the registered
|
4236
|
+
# number automatically. Otherwise, Amazon Cognito users who must receive
|
4237
|
+
# SMS messages might not be able to sign up, activate their accounts, or
|
4238
|
+
# sign in.
|
4209
4239
|
#
|
4210
4240
|
# If you have never used SMS text messages with Amazon Cognito or any
|
4211
4241
|
# other Amazon Web Service, Amazon Simple Notification Service might
|
4212
|
-
# place your account in SMS sandbox. In <i> <a
|
4242
|
+
# place your account in the SMS sandbox. In <i> <a
|
4213
4243
|
# href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
4214
|
-
# mode</a> </i>, you
|
4215
|
-
#
|
4216
|
-
#
|
4217
|
-
#
|
4218
|
-
#
|
4244
|
+
# mode</a> </i>, you can send messages only to verified phone numbers.
|
4245
|
+
# After you test your app while in the sandbox environment, you can move
|
4246
|
+
# out of the sandbox and into production. For more information, see [
|
4247
|
+
# SMS message settings for Amazon Cognito user pools][4] in the *Amazon
|
4248
|
+
# Cognito Developer Guide*.
|
4219
4249
|
#
|
4220
4250
|
# </note>
|
4221
4251
|
#
|
@@ -4262,8 +4292,8 @@ module Aws::CognitoIdentityProvider
|
|
4262
4292
|
# your function code in Lambda, you can process the `clientMetadata`
|
4263
4293
|
# value to enhance your workflow for your specific needs.
|
4264
4294
|
#
|
4265
|
-
# For more information, see [Customizing
|
4266
|
-
# Triggers][1] in the *Amazon Cognito Developer Guide*.
|
4295
|
+
# For more information, see [ Customizing user pool Workflows with
|
4296
|
+
# Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
|
4267
4297
|
#
|
4268
4298
|
# <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
|
4269
4299
|
# Cognito won't do the following:
|
@@ -4591,22 +4621,22 @@ module Aws::CognitoIdentityProvider
|
|
4591
4621
|
#
|
4592
4622
|
# <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
|
4593
4623
|
# US telecom carriers require you to register an origination phone
|
4594
|
-
# number before you can send SMS messages to
|
4624
|
+
# number before you can send SMS messages to US phone numbers. If you
|
4595
4625
|
# use SMS text messages in Amazon Cognito, you must register a phone
|
4596
|
-
# number with [Amazon Pinpoint][1]. Amazon Cognito
|
4597
|
-
#
|
4598
|
-
#
|
4599
|
-
#
|
4626
|
+
# number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
|
4627
|
+
# number automatically. Otherwise, Amazon Cognito users who must receive
|
4628
|
+
# SMS messages might not be able to sign up, activate their accounts, or
|
4629
|
+
# sign in.
|
4600
4630
|
#
|
4601
4631
|
# If you have never used SMS text messages with Amazon Cognito or any
|
4602
4632
|
# other Amazon Web Service, Amazon Simple Notification Service might
|
4603
|
-
# place your account in SMS sandbox. In <i> <a
|
4633
|
+
# place your account in the SMS sandbox. In <i> <a
|
4604
4634
|
# href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
4605
|
-
# mode</a> </i>, you
|
4606
|
-
#
|
4607
|
-
#
|
4608
|
-
#
|
4609
|
-
#
|
4635
|
+
# mode</a> </i>, you can send messages only to verified phone numbers.
|
4636
|
+
# After you test your app while in the sandbox environment, you can move
|
4637
|
+
# out of the sandbox and into production. For more information, see [
|
4638
|
+
# SMS message settings for Amazon Cognito user pools][2] in the *Amazon
|
4639
|
+
# Cognito Developer Guide*.
|
4610
4640
|
#
|
4611
4641
|
# </note>
|
4612
4642
|
#
|
@@ -4638,8 +4668,8 @@ module Aws::CognitoIdentityProvider
|
|
4638
4668
|
# Lambda, you can process the `clientMetadata` value to enhance your
|
4639
4669
|
# workflow for your specific needs.
|
4640
4670
|
#
|
4641
|
-
# For more information, see [Customizing
|
4642
|
-
# Triggers][1] in the *Amazon Cognito Developer Guide*.
|
4671
|
+
# For more information, see [ Customizing user pool Workflows with
|
4672
|
+
# Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
|
4643
4673
|
#
|
4644
4674
|
# <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
|
4645
4675
|
# Cognito won't do the following:
|
@@ -4711,6 +4741,7 @@ module Aws::CognitoIdentityProvider
|
|
4711
4741
|
# resp.sms_mfa_configuration.sms_authentication_message #=> String
|
4712
4742
|
# resp.sms_mfa_configuration.sms_configuration.sns_caller_arn #=> String
|
4713
4743
|
# resp.sms_mfa_configuration.sms_configuration.external_id #=> String
|
4744
|
+
# resp.sms_mfa_configuration.sms_configuration.sns_region #=> String
|
4714
4745
|
# resp.software_token_mfa_configuration.enabled #=> Boolean
|
4715
4746
|
# resp.mfa_configuration #=> String, one of "OFF", "ON", "OPTIONAL"
|
4716
4747
|
#
|
@@ -4752,22 +4783,22 @@ module Aws::CognitoIdentityProvider
|
|
4752
4783
|
#
|
4753
4784
|
# <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
|
4754
4785
|
# US telecom carriers require you to register an origination phone
|
4755
|
-
# number before you can send SMS messages to
|
4786
|
+
# number before you can send SMS messages to US phone numbers. If you
|
4756
4787
|
# use SMS text messages in Amazon Cognito, you must register a phone
|
4757
|
-
# number with [Amazon Pinpoint][1]. Amazon Cognito
|
4758
|
-
#
|
4759
|
-
#
|
4760
|
-
#
|
4788
|
+
# number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
|
4789
|
+
# number automatically. Otherwise, Amazon Cognito users who must receive
|
4790
|
+
# SMS messages might not be able to sign up, activate their accounts, or
|
4791
|
+
# sign in.
|
4761
4792
|
#
|
4762
4793
|
# If you have never used SMS text messages with Amazon Cognito or any
|
4763
4794
|
# other Amazon Web Service, Amazon Simple Notification Service might
|
4764
|
-
# place your account in SMS sandbox. In <i> <a
|
4795
|
+
# place your account in the SMS sandbox. In <i> <a
|
4765
4796
|
# href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
4766
|
-
# mode</a> </i>, you
|
4767
|
-
#
|
4768
|
-
#
|
4769
|
-
#
|
4770
|
-
#
|
4797
|
+
# mode</a> </i>, you can send messages only to verified phone numbers.
|
4798
|
+
# After you test your app while in the sandbox environment, you can move
|
4799
|
+
# out of the sandbox and into production. For more information, see [
|
4800
|
+
# SMS message settings for Amazon Cognito user pools][2] in the *Amazon
|
4801
|
+
# Cognito Developer Guide*.
|
4771
4802
|
#
|
4772
4803
|
# </note>
|
4773
4804
|
#
|
@@ -4865,8 +4896,8 @@ module Aws::CognitoIdentityProvider
|
|
4865
4896
|
#
|
4866
4897
|
# * Verify auth challenge
|
4867
4898
|
#
|
4868
|
-
# For more information, see [Customizing
|
4869
|
-
# Triggers][1] in the *Amazon Cognito Developer Guide*.
|
4899
|
+
# For more information, see [ Customizing user pool Workflows with
|
4900
|
+
# Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
|
4870
4901
|
#
|
4871
4902
|
# <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
|
4872
4903
|
# Cognito won't do the following:
|
@@ -5524,22 +5555,22 @@ module Aws::CognitoIdentityProvider
|
|
5524
5555
|
#
|
5525
5556
|
# <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
|
5526
5557
|
# US telecom carriers require you to register an origination phone
|
5527
|
-
# number before you can send SMS messages to
|
5558
|
+
# number before you can send SMS messages to US phone numbers. If you
|
5528
5559
|
# use SMS text messages in Amazon Cognito, you must register a phone
|
5529
|
-
# number with [Amazon Pinpoint][1]. Amazon Cognito
|
5530
|
-
#
|
5531
|
-
#
|
5532
|
-
#
|
5560
|
+
# number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
|
5561
|
+
# number automatically. Otherwise, Amazon Cognito users who must receive
|
5562
|
+
# SMS messages might not be able to sign up, activate their accounts, or
|
5563
|
+
# sign in.
|
5533
5564
|
#
|
5534
5565
|
# If you have never used SMS text messages with Amazon Cognito or any
|
5535
5566
|
# other Amazon Web Service, Amazon Simple Notification Service might
|
5536
|
-
# place your account in SMS sandbox. In <i> <a
|
5567
|
+
# place your account in the SMS sandbox. In <i> <a
|
5537
5568
|
# href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
5538
|
-
# mode</a> </i>, you
|
5539
|
-
#
|
5540
|
-
#
|
5541
|
-
#
|
5542
|
-
#
|
5569
|
+
# mode</a> </i>, you can send messages only to verified phone numbers.
|
5570
|
+
# After you test your app while in the sandbox environment, you can move
|
5571
|
+
# out of the sandbox and into production. For more information, see [
|
5572
|
+
# SMS message settings for Amazon Cognito user pools][2] in the *Amazon
|
5573
|
+
# Cognito Developer Guide*.
|
5543
5574
|
#
|
5544
5575
|
# </note>
|
5545
5576
|
#
|
@@ -5584,8 +5615,8 @@ module Aws::CognitoIdentityProvider
|
|
5584
5615
|
# `clientMetadata` value to enhance your workflow for your specific
|
5585
5616
|
# needs.
|
5586
5617
|
#
|
5587
|
-
# For more information, see [Customizing
|
5588
|
-
# Triggers][1] in the *Amazon Cognito Developer Guide*.
|
5618
|
+
# For more information, see [ Customizing user pool Workflows with
|
5619
|
+
# Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
|
5589
5620
|
#
|
5590
5621
|
# <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
|
5591
5622
|
# Cognito won't do the following:
|
@@ -5646,22 +5677,22 @@ module Aws::CognitoIdentityProvider
|
|
5646
5677
|
#
|
5647
5678
|
# <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
|
5648
5679
|
# US telecom carriers require you to register an origination phone
|
5649
|
-
# number before you can send SMS messages to
|
5680
|
+
# number before you can send SMS messages to US phone numbers. If you
|
5650
5681
|
# use SMS text messages in Amazon Cognito, you must register a phone
|
5651
|
-
# number with [Amazon Pinpoint][1]. Amazon Cognito
|
5652
|
-
#
|
5653
|
-
#
|
5654
|
-
#
|
5682
|
+
# number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
|
5683
|
+
# number automatically. Otherwise, Amazon Cognito users who must receive
|
5684
|
+
# SMS messages might not be able to sign up, activate their accounts, or
|
5685
|
+
# sign in.
|
5655
5686
|
#
|
5656
5687
|
# If you have never used SMS text messages with Amazon Cognito or any
|
5657
5688
|
# other Amazon Web Service, Amazon Simple Notification Service might
|
5658
|
-
# place your account in SMS sandbox. In <i> <a
|
5689
|
+
# place your account in the SMS sandbox. In <i> <a
|
5659
5690
|
# href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
5660
|
-
# mode</a> </i>, you
|
5661
|
-
#
|
5662
|
-
#
|
5663
|
-
#
|
5664
|
-
#
|
5691
|
+
# mode</a> </i>, you can send messages only to verified phone numbers.
|
5692
|
+
# After you test your app while in the sandbox environment, you can move
|
5693
|
+
# out of the sandbox and into production. For more information, see [
|
5694
|
+
# SMS message settings for Amazon Cognito user pools][2] in the *Amazon
|
5695
|
+
# Cognito Developer Guide*.
|
5665
5696
|
#
|
5666
5697
|
# </note>
|
5667
5698
|
#
|
@@ -5749,8 +5780,8 @@ module Aws::CognitoIdentityProvider
|
|
5749
5780
|
# `clientMetadata` value to enhance your workflow for your specific
|
5750
5781
|
# needs.
|
5751
5782
|
#
|
5752
|
-
# For more information, see [Customizing
|
5753
|
-
# Triggers][1] in the *Amazon Cognito Developer Guide*.
|
5783
|
+
# For more information, see [ Customizing user pool Workflows with
|
5784
|
+
# Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
|
5754
5785
|
#
|
5755
5786
|
# <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
|
5756
5787
|
# Cognito won't do the following:
|
@@ -6089,22 +6120,22 @@ module Aws::CognitoIdentityProvider
|
|
6089
6120
|
#
|
6090
6121
|
# <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
|
6091
6122
|
# US telecom carriers require you to register an origination phone
|
6092
|
-
# number before you can send SMS messages to
|
6123
|
+
# number before you can send SMS messages to US phone numbers. If you
|
6093
6124
|
# use SMS text messages in Amazon Cognito, you must register a phone
|
6094
|
-
# number with [Amazon Pinpoint][1]. Amazon Cognito
|
6095
|
-
#
|
6096
|
-
#
|
6097
|
-
#
|
6125
|
+
# number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
|
6126
|
+
# number automatically. Otherwise, Amazon Cognito users who must receive
|
6127
|
+
# SMS messages might not be able to sign up, activate their accounts, or
|
6128
|
+
# sign in.
|
6098
6129
|
#
|
6099
6130
|
# If you have never used SMS text messages with Amazon Cognito or any
|
6100
6131
|
# other Amazon Web Service, Amazon Simple Notification Service might
|
6101
|
-
# place your account in SMS sandbox. In <i> <a
|
6132
|
+
# place your account in the SMS sandbox. In <i> <a
|
6102
6133
|
# href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
6103
|
-
# mode</a> </i>, you
|
6104
|
-
#
|
6105
|
-
#
|
6106
|
-
#
|
6107
|
-
#
|
6134
|
+
# mode</a> </i>, you can send messages only to verified phone numbers.
|
6135
|
+
# After you test your app while in the sandbox environment, you can move
|
6136
|
+
# out of the sandbox and into production. For more information, see [
|
6137
|
+
# SMS message settings for Amazon Cognito user pools][2] in the *Amazon
|
6138
|
+
# Cognito Developer Guide*.
|
6108
6139
|
#
|
6109
6140
|
# </note>
|
6110
6141
|
#
|
@@ -6124,9 +6155,9 @@ module Aws::CognitoIdentityProvider
|
|
6124
6155
|
#
|
6125
6156
|
# @option params [String] :mfa_configuration
|
6126
6157
|
# The MFA configuration. If you set the MfaConfiguration value to ‘ON’,
|
6127
|
-
# only users
|
6128
|
-
# [Adding Multi-Factor Authentication (MFA) to a
|
6129
|
-
#
|
6158
|
+
# only users who have set up an MFA factor can sign in. To learn more,
|
6159
|
+
# see [Adding Multi-Factor Authentication (MFA) to a user
|
6160
|
+
# pool](cognito/latest/developerguide/user-pool-settings-mfa.html).
|
6130
6161
|
# Valid values include:
|
6131
6162
|
#
|
6132
6163
|
# * `OFF` MFA won't be used for any users.
|
@@ -6151,6 +6182,7 @@ module Aws::CognitoIdentityProvider
|
|
6151
6182
|
# sms_configuration: {
|
6152
6183
|
# sns_caller_arn: "ArnType", # required
|
6153
6184
|
# external_id: "StringType",
|
6185
|
+
# sns_region: "RegionCodeType",
|
6154
6186
|
# },
|
6155
6187
|
# },
|
6156
6188
|
# software_token_mfa_configuration: {
|
@@ -6164,6 +6196,7 @@ module Aws::CognitoIdentityProvider
|
|
6164
6196
|
# resp.sms_mfa_configuration.sms_authentication_message #=> String
|
6165
6197
|
# resp.sms_mfa_configuration.sms_configuration.sns_caller_arn #=> String
|
6166
6198
|
# resp.sms_mfa_configuration.sms_configuration.external_id #=> String
|
6199
|
+
# resp.sms_mfa_configuration.sms_configuration.sns_region #=> String
|
6167
6200
|
# resp.software_token_mfa_configuration.enabled #=> Boolean
|
6168
6201
|
# resp.mfa_configuration #=> String, one of "OFF", "ON", "OPTIONAL"
|
6169
6202
|
#
|
@@ -6220,22 +6253,22 @@ module Aws::CognitoIdentityProvider
|
|
6220
6253
|
#
|
6221
6254
|
# <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
|
6222
6255
|
# US telecom carriers require you to register an origination phone
|
6223
|
-
# number before you can send SMS messages to
|
6256
|
+
# number before you can send SMS messages to US phone numbers. If you
|
6224
6257
|
# use SMS text messages in Amazon Cognito, you must register a phone
|
6225
|
-
# number with [Amazon Pinpoint][1]. Amazon Cognito
|
6226
|
-
#
|
6227
|
-
#
|
6228
|
-
#
|
6258
|
+
# number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
|
6259
|
+
# number automatically. Otherwise, Amazon Cognito users who must receive
|
6260
|
+
# SMS messages might not be able to sign up, activate their accounts, or
|
6261
|
+
# sign in.
|
6229
6262
|
#
|
6230
6263
|
# If you have never used SMS text messages with Amazon Cognito or any
|
6231
6264
|
# other Amazon Web Service, Amazon Simple Notification Service might
|
6232
|
-
# place your account in SMS sandbox. In <i> <a
|
6265
|
+
# place your account in the SMS sandbox. In <i> <a
|
6233
6266
|
# href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
6234
|
-
# mode</a> </i>, you
|
6235
|
-
#
|
6236
|
-
#
|
6237
|
-
#
|
6238
|
-
#
|
6267
|
+
# mode</a> </i>, you can send messages only to verified phone numbers.
|
6268
|
+
# After you test your app while in the sandbox environment, you can move
|
6269
|
+
# out of the sandbox and into production. For more information, see [
|
6270
|
+
# SMS message settings for Amazon Cognito user pools][2] in the *Amazon
|
6271
|
+
# Cognito Developer Guide*.
|
6239
6272
|
#
|
6240
6273
|
# </note>
|
6241
6274
|
#
|
@@ -6291,8 +6324,8 @@ module Aws::CognitoIdentityProvider
|
|
6291
6324
|
# function code in Lambda, you can process the `clientMetadata` value to
|
6292
6325
|
# enhance your workflow for your specific needs.
|
6293
6326
|
#
|
6294
|
-
# For more information, see [Customizing
|
6295
|
-
# Triggers][1] in the *Amazon Cognito Developer Guide*.
|
6327
|
+
# For more information, see [ Customizing user pool Workflows with
|
6328
|
+
# Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
|
6296
6329
|
#
|
6297
6330
|
# <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
|
6298
6331
|
# Cognito won't do the following:
|
@@ -6777,22 +6810,22 @@ module Aws::CognitoIdentityProvider
|
|
6777
6810
|
#
|
6778
6811
|
# <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
|
6779
6812
|
# US telecom carriers require you to register an origination phone
|
6780
|
-
# number before you can send SMS messages to
|
6813
|
+
# number before you can send SMS messages to US phone numbers. If you
|
6781
6814
|
# use SMS text messages in Amazon Cognito, you must register a phone
|
6782
|
-
# number with [Amazon Pinpoint][1]. Amazon Cognito
|
6783
|
-
#
|
6784
|
-
#
|
6785
|
-
#
|
6815
|
+
# number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
|
6816
|
+
# number automatically. Otherwise, Amazon Cognito users who must receive
|
6817
|
+
# SMS messages might not be able to sign up, activate their accounts, or
|
6818
|
+
# sign in.
|
6786
6819
|
#
|
6787
6820
|
# If you have never used SMS text messages with Amazon Cognito or any
|
6788
6821
|
# other Amazon Web Service, Amazon Simple Notification Service might
|
6789
|
-
# place your account in SMS sandbox. In <i> <a
|
6822
|
+
# place your account in the SMS sandbox. In <i> <a
|
6790
6823
|
# href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
6791
|
-
# mode</a> </i>, you
|
6792
|
-
#
|
6793
|
-
#
|
6794
|
-
#
|
6795
|
-
#
|
6824
|
+
# mode</a> </i>, you can send messages only to verified phone numbers.
|
6825
|
+
# After you test your app while in the sandbox environment, you can move
|
6826
|
+
# out of the sandbox and into production. For more information, see [
|
6827
|
+
# SMS message settings for Amazon Cognito user pools][2] in the *Amazon
|
6828
|
+
# Cognito Developer Guide*.
|
6796
6829
|
#
|
6797
6830
|
# </note>
|
6798
6831
|
#
|
@@ -6824,8 +6857,8 @@ module Aws::CognitoIdentityProvider
|
|
6824
6857
|
# In your function code in Lambda, you can process the `clientMetadata`
|
6825
6858
|
# value to enhance your workflow for your specific needs.
|
6826
6859
|
#
|
6827
|
-
# For more information, see [Customizing
|
6828
|
-
# Triggers][1] in the *Amazon Cognito Developer Guide*.
|
6860
|
+
# For more information, see [ Customizing user pool Workflows with
|
6861
|
+
# Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
|
6829
6862
|
#
|
6830
6863
|
# <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
|
6831
6864
|
# Cognito won't do the following:
|
@@ -6888,22 +6921,22 @@ module Aws::CognitoIdentityProvider
|
|
6888
6921
|
#
|
6889
6922
|
# <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
|
6890
6923
|
# US telecom carriers require you to register an origination phone
|
6891
|
-
# number before you can send SMS messages to
|
6924
|
+
# number before you can send SMS messages to US phone numbers. If you
|
6892
6925
|
# use SMS text messages in Amazon Cognito, you must register a phone
|
6893
|
-
# number with [Amazon Pinpoint][2]. Amazon Cognito
|
6894
|
-
#
|
6895
|
-
#
|
6896
|
-
#
|
6926
|
+
# number with [Amazon Pinpoint][2]. Amazon Cognito uses the registered
|
6927
|
+
# number automatically. Otherwise, Amazon Cognito users who must receive
|
6928
|
+
# SMS messages might not be able to sign up, activate their accounts, or
|
6929
|
+
# sign in.
|
6897
6930
|
#
|
6898
6931
|
# If you have never used SMS text messages with Amazon Cognito or any
|
6899
6932
|
# other Amazon Web Service, Amazon Simple Notification Service might
|
6900
|
-
# place your account in SMS sandbox. In <i> <a
|
6933
|
+
# place your account in the SMS sandbox. In <i> <a
|
6901
6934
|
# href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
6902
|
-
# mode</a> </i>, you
|
6903
|
-
#
|
6904
|
-
#
|
6905
|
-
#
|
6906
|
-
#
|
6935
|
+
# mode</a> </i>, you can send messages only to verified phone numbers.
|
6936
|
+
# After you test your app while in the sandbox environment, you can move
|
6937
|
+
# out of the sandbox and into production. For more information, see [
|
6938
|
+
# SMS message settings for Amazon Cognito user pools][3] in the *Amazon
|
6939
|
+
# Cognito Developer Guide*.
|
6907
6940
|
#
|
6908
6941
|
# </note>
|
6909
6942
|
#
|
@@ -6964,10 +6997,18 @@ module Aws::CognitoIdentityProvider
|
|
6964
6997
|
# Device configuration.
|
6965
6998
|
#
|
6966
6999
|
# @option params [Types::EmailConfigurationType] :email_configuration
|
6967
|
-
#
|
7000
|
+
# The email configuration of your user pool. The email configuration
|
7001
|
+
# type sets your preferred sending method, Amazon Web Services Region,
|
7002
|
+
# and sender for email invitation and verification messages from your
|
7003
|
+
# user pool.
|
6968
7004
|
#
|
6969
7005
|
# @option params [Types::SmsConfigurationType] :sms_configuration
|
6970
|
-
# SMS configuration
|
7006
|
+
# The SMS configuration with the settings that your Amazon Cognito user
|
7007
|
+
# pool must use to send an SMS message from your Amazon Web Services
|
7008
|
+
# account through Amazon Simple Notification Service. To send SMS
|
7009
|
+
# messages with Amazon SNS in the Amazon Web Services Region that you
|
7010
|
+
# want, the Amazon Cognito user pool uses an Identity and Access
|
7011
|
+
# Management (IAM) role in your Amazon Web Services account.
|
6971
7012
|
#
|
6972
7013
|
# @option params [Hash<String,String>] :user_pool_tags
|
6973
7014
|
# The tag keys and values to assign to the user pool. A tag is a label
|
@@ -7056,6 +7097,7 @@ module Aws::CognitoIdentityProvider
|
|
7056
7097
|
# sms_configuration: {
|
7057
7098
|
# sns_caller_arn: "ArnType", # required
|
7058
7099
|
# external_id: "StringType",
|
7100
|
+
# sns_region: "RegionCodeType",
|
7059
7101
|
# },
|
7060
7102
|
# user_pool_tags: {
|
7061
7103
|
# "TagKeysType" => "TagValueType",
|
@@ -7244,10 +7286,11 @@ module Aws::CognitoIdentityProvider
|
|
7244
7286
|
# The Amazon Pinpoint analytics configuration for collecting metrics for
|
7245
7287
|
# this user pool.
|
7246
7288
|
#
|
7247
|
-
# <note markdown="1"> In Amazon Web Services Regions where isn't available,
|
7248
|
-
#
|
7249
|
-
# Regions where Pinpoint is available,
|
7250
|
-
# events to Amazon Pinpoint projects within that same
|
7289
|
+
# <note markdown="1"> In Amazon Web Services Regions where Amazon Pinpoint isn't available,
|
7290
|
+
# user pools only support sending events to Amazon Pinpoint projects in
|
7291
|
+
# us-east-1. In Regions where Amazon Pinpoint is available, user pools
|
7292
|
+
# support sending events to Amazon Pinpoint projects within that same
|
7293
|
+
# Region.
|
7251
7294
|
#
|
7252
7295
|
# </note>
|
7253
7296
|
#
|
@@ -7539,7 +7582,7 @@ module Aws::CognitoIdentityProvider
|
|
7539
7582
|
params: params,
|
7540
7583
|
config: config)
|
7541
7584
|
context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
|
7542
|
-
context[:gem_version] = '1.
|
7585
|
+
context[:gem_version] = '1.65.0'
|
7543
7586
|
Seahorse::Client::Request.new(handlers, context)
|
7544
7587
|
end
|
7545
7588
|
|