aws-sdk-cognitoidentityprovider 1.51.0 → 1.52.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6d3d64050f79e1fcb7d4883eca09cc07d23444b08f7c9d761904372451c9cebb
4
- data.tar.gz: bd98c31f566339d42c190942a3ebeea3411b1c4351bb375b446a8efcc9474d07
3
+ metadata.gz: be13d2b8566a685d618491947b99c96481d64beeaf99c92caf50e8d23326be96
4
+ data.tar.gz: fde0fc9c7ade2ea51df0fab0a4f2c56a50ff16078189c15b964882cfc4ad8838
5
5
  SHA512:
6
- metadata.gz: e9f46f53363bea3ec058191702966534af925eb4e20d23f5f8689abf95b1ff58f8f5d55be5358919715d43a7f336dbac28b47981cbd5b8db857921c443303164
7
- data.tar.gz: e5275ea362c4655546c887233ef8b5494f1e474903a769539b7b4f86a4ea97d76fa95bd287eb6df64d24921cc685d7f7f2e665be95619be61741ac7828b24e6e
6
+ metadata.gz: 132a83ca21f4a8a35f272bafbbd644014a2cd5919732db6663ae51435f280a61e378685506b49616bb435b04cd4049e086f8fea899596ecf2ad262a065987bc5
7
+ data.tar.gz: d2762571d2100c675049202761bb5ccc1bbe2644b9e9cfd0592d2c15072bc583103f9832023b9ad372723a10d0ab0bc60168e4a3e410d82becdda330fc8197ea
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.52.0 (2021-06-08)
5
+ ------------------
6
+
7
+ * Feature - Documentation updates for cognito-idp
8
+
4
9
  1.51.0 (2021-04-22)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.51.0
1
+ 1.52.0
@@ -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.0'
51
+ GEM_VERSION = '1.52.0'
52
52
 
53
53
  end
@@ -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
  #
@@ -1974,8 +2078,34 @@ module Aws::CognitoIdentityProvider
1974
2078
  # In addition to updating user attributes, this API can also be used to
1975
2079
  # mark phone and email as verified.
1976
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
+ #
1977
2102
  # Calling this action requires developer credentials.
1978
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
+ #
1979
2109
  # @option params [required, String] :user_pool_id
1980
2110
  # The user pool ID for the user pool where you want to update user
1981
2111
  # attributes.
@@ -2089,6 +2219,16 @@ module Aws::CognitoIdentityProvider
2089
2219
  # account. The request takes an access token or a session string, but
2090
2220
  # not both.
2091
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
+ #
2092
2232
  # @option params [String] :access_token
2093
2233
  # The access token.
2094
2234
  #
@@ -2704,6 +2844,32 @@ module Aws::CognitoIdentityProvider
2704
2844
  # Creates a new Amazon Cognito user pool and sets the password policy
2705
2845
  # for the pool.
2706
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
+ #
2707
2873
  # @option params [required, String] :pool_name
2708
2874
  # A string used to name the user pool.
2709
2875
  #
@@ -3986,10 +4152,33 @@ module Aws::CognitoIdentityProvider
3986
4152
  # `InvalidParameterException` is thrown. To use the confirmation code
3987
4153
  # for resetting the password, call [ConfirmForgotPassword][2].
3988
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
+ #
3989
4176
  #
3990
4177
  #
3991
4178
  # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-recover-a-user-account.html
3992
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
3993
4182
  #
3994
4183
  # @option params [required, String] :client_id
3995
4184
  # The ID of the client associated with the user pool.
@@ -4354,6 +4543,32 @@ module Aws::CognitoIdentityProvider
4354
4543
  # Gets the user attribute verification code for the specified attribute
4355
4544
  # name.
4356
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
+ #
4357
4572
  # @option params [required, String] :access_token
4358
4573
  # The access token returned by the server response to get the user
4359
4574
  # attribute verification code.
@@ -4490,6 +4705,32 @@ module Aws::CognitoIdentityProvider
4490
4705
 
4491
4706
  # Initiates the authentication flow.
4492
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
+ #
4493
4734
  # @option params [required, String] :auth_flow
4494
4735
  # The authentication flow for this call to execute. The API action will
4495
4736
  # depend on this value. For example:
@@ -5226,6 +5467,32 @@ module Aws::CognitoIdentityProvider
5226
5467
  # Resends the confirmation (for confirmation of registration) to a
5227
5468
  # specific user in the user pool.
5228
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
+ #
5229
5496
  # @option params [required, String] :client_id
5230
5497
  # The ID of the client associated with the user pool.
5231
5498
  #
@@ -5323,6 +5590,32 @@ module Aws::CognitoIdentityProvider
5323
5590
 
5324
5591
  # Responds to the authentication challenge.
5325
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
+ #
5326
5619
  # @option params [required, String] :client_id
5327
5620
  # The app client ID.
5328
5621
  #
@@ -5704,6 +5997,32 @@ module Aws::CognitoIdentityProvider
5704
5997
 
5705
5998
  # Set the user pool multi-factor authentication (MFA) configuration.
5706
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
+ #
5707
6026
  # @option params [required, String] :user_pool_id
5708
6027
  # The user pool ID.
5709
6028
  #
@@ -5808,6 +6127,32 @@ module Aws::CognitoIdentityProvider
5808
6127
  # Registers the user in the specified user pool and creates a user name,
5809
6128
  # password, and user attributes.
5810
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
+ #
5811
6156
  # @option params [required, String] :client_id
5812
6157
  # The ID of the client associated with the user pool.
5813
6158
  #
@@ -6342,6 +6687,32 @@ module Aws::CognitoIdentityProvider
6342
6687
 
6343
6688
  # Allows a user to update a specific attribute (one at a time).
6344
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
+ #
6345
6716
  # @option params [required, Array<Types::AttributeType>] :user_attributes
6346
6717
  # An array of name-value pairs representing user attributes.
6347
6718
  #
@@ -6426,14 +6797,35 @@ module Aws::CognitoIdentityProvider
6426
6797
 
6427
6798
  # Updates the specified user pool with the specified attributes. You can
6428
6799
  # get a list of the current user pool settings using
6429
- # [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*.
6430
6821
  #
6431
- # If you don't provide a value for an attribute, it will be set to the
6432
- # default value.
6822
+ # </note>
6433
6823
  #
6434
6824
  #
6435
6825
  #
6436
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
6437
6829
  #
6438
6830
  # @option params [required, String] :user_pool_id
6439
6831
  # The user pool ID for the user pool you want to update.
@@ -7048,7 +7440,7 @@ module Aws::CognitoIdentityProvider
7048
7440
  params: params,
7049
7441
  config: config)
7050
7442
  context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
7051
- context[:gem_version] = '1.51.0'
7443
+ context[:gem_version] = '1.52.0'
7052
7444
  Seahorse::Client::Request.new(handlers, context)
7053
7445
  end
7054
7446
 
@@ -5664,8 +5664,6 @@ module Aws::CognitoIdentityProvider
5664
5664
  # * jwks\_uri *if not available from discovery URL specified by
5665
5665
  # oidc\_issuer key*
5666
5666
  #
5667
- # * authorize\_scopes
5668
- #
5669
5667
  # * For SAML providers:
5670
5668
  #
5671
5669
  # * MetadataFile OR MetadataURL
@@ -10348,6 +10346,24 @@ module Aws::CognitoIdentityProvider
10348
10346
  # @!attribute [rw] sms_configuration_failure
10349
10347
  # The reason why the SMS configuration cannot send the messages to
10350
10348
  # your users.
10349
+ #
10350
+ # This message might include comma-separated values to describe why
10351
+ # your SMS configuration can't send messages to user pool end users.
10352
+ #
10353
+ # * InvalidSmsRoleAccessPolicyException - The IAM role which Cognito
10354
+ # uses to send SMS messages is not properly configured. For more
10355
+ # information, see [SmsConfigurationType][1].
10356
+ #
10357
+ # * SNSSandbox - The AWS account is in SNS Sandbox and messages won’t
10358
+ # reach unverified end users. This parameter won’t get populated
10359
+ # with SNSSandbox if the IAM user creating the user pool doesn’t
10360
+ # have SNS permissions. To learn how to move your AWS account out of
10361
+ # the sandbox, see [Moving out of the SMS sandbox][2].
10362
+ #
10363
+ #
10364
+ #
10365
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SmsConfigurationType.html
10366
+ # [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox-moving-to-production.html
10351
10367
  # @return [String]
10352
10368
  #
10353
10369
  # @!attribute [rw] email_configuration_failure
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-cognitoidentityprovider
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.51.0
4
+ version: 1.52.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-04-22 00:00:00.000000000 Z
11
+ date: 2021-06-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -83,8 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
83
83
  - !ruby/object:Gem::Version
84
84
  version: '0'
85
85
  requirements: []
86
- rubyforge_project:
87
- rubygems_version: 2.7.6.3
86
+ rubygems_version: 3.1.6
88
87
  signing_key:
89
88
  specification_version: 4
90
89
  summary: AWS SDK for Ruby - Amazon Cognito Identity Provider