aws-sdk-cognitoidentityprovider 1.63.0 → 1.66.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
29
  require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
30
31
  require 'aws-sdk-core/plugins/defaults_mode.rb'
31
32
  require 'aws-sdk-core/plugins/recursion_detection.rb'
32
33
  require 'aws-sdk-core/plugins/signature_v4.rb'
@@ -75,6 +76,7 @@ module Aws::CognitoIdentityProvider
75
76
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
76
77
  add_plugin(Aws::Plugins::TransferEncoding)
77
78
  add_plugin(Aws::Plugins::HttpChecksum)
79
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
78
80
  add_plugin(Aws::Plugins::DefaultsMode)
79
81
  add_plugin(Aws::Plugins::RecursionDetection)
80
82
  add_plugin(Aws::Plugins::SignatureV4)
@@ -459,8 +461,8 @@ module Aws::CognitoIdentityProvider
459
461
  # can process the ClientMetadata value to enhance your workflow for your
460
462
  # specific needs.
461
463
  #
462
- # For more information, see [Customizing User Pool Workflows with Lambda
463
- # 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*.
464
466
  #
465
467
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
466
468
  # Cognito won't do the following:
@@ -509,22 +511,22 @@ module Aws::CognitoIdentityProvider
509
511
  #
510
512
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
511
513
  # US telecom carriers require you to register an origination phone
512
- # number before you can send SMS messages to U.S. phone numbers. If you
514
+ # number before you can send SMS messages to US phone numbers. If you
513
515
  # use SMS text messages in Amazon Cognito, you must register a phone
514
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
515
- # registered number automatically. Otherwise, Amazon Cognito users that
516
- # must receive SMS messages might be unable to sign up, activate their
517
- # accounts, or sign in.
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.
518
520
  #
519
521
  # If you have never used SMS text messages with Amazon Cognito or any
520
522
  # other Amazon Web Service, Amazon Simple Notification Service might
521
- # place your account in SMS sandbox. In <i> <a
523
+ # place your account in the SMS sandbox. In <i> <a
522
524
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
523
- # mode</a> </i>, you will have limitations, such as sending messages
524
- # only to verified phone numbers. After testing in the sandbox
525
- # environment, you can move out of the SMS sandbox and into production.
526
- # For more information, see [ SMS message settings for Amazon Cognito
527
- # User Pools][2] in the *Amazon Cognito Developer Guide*.
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*.
528
530
  #
529
531
  # </note>
530
532
  #
@@ -661,8 +663,8 @@ module Aws::CognitoIdentityProvider
661
663
  # your function code in Lambda, you can process the `clientMetadata`
662
664
  # value to enhance your workflow for your specific needs.
663
665
  #
664
- # For more information, see [Customizing User Pool Workflows with Lambda
665
- # 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*.
666
668
  #
667
669
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
668
670
  # Cognito won't do the following:
@@ -803,14 +805,14 @@ module Aws::CognitoIdentityProvider
803
805
  req.send_request(options)
804
806
  end
805
807
 
806
- # Disables the user from signing in with the specified external (SAML or
807
- # social) identity provider. If the user to disable is a Amazon Cognito
808
- # User Pools native username + password user, they aren't permitted to
809
- # use their password to sign in. If the user to deactivate is a linked
810
- # external identity provider (IdP) user, any link between that user and
811
- # an existing user is removed. The next time the external user (no
812
- # longer attached to the previously linked `DestinationUser`) signs in,
813
- # they must create a new user account. See
808
+ # Prevents the user from signing in with the specified external (SAML or
809
+ # social) identity provider (IdP). If the user that you want to
810
+ # deactivate is a Amazon Cognito user pools native username + password
811
+ # user, they can't use their password to sign in. If the user to
812
+ # deactivate is a linked external IdP user, any link between that user
813
+ # 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
814
816
  # [AdminLinkProviderForUser][1].
815
817
  #
816
818
  # This action is enabled only for admin access and requires developer
@@ -825,9 +827,9 @@ module Aws::CognitoIdentityProvider
825
827
  # is used in the user pool for the user.
826
828
  #
827
829
  # The `ProviderAttributeName` must always be `Cognito_Subject` for
828
- # social identity providers. The `ProviderAttributeValue` must always be
829
- # the exact subject that was used when the user was originally linked as
830
- # a source user.
830
+ # social IdPs. The `ProviderAttributeValue` must always be the exact
831
+ # subject that was used when the user was originally linked as a source
832
+ # user.
831
833
  #
832
834
  # For de-linking a SAML identity, there are two scenarios. If the linked
833
835
  # identity has not yet been used to sign in, the `ProviderAttributeName`
@@ -1064,22 +1066,22 @@ module Aws::CognitoIdentityProvider
1064
1066
  #
1065
1067
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
1066
1068
  # US telecom carriers require you to register an origination phone
1067
- # number before you can send SMS messages to U.S. phone numbers. If you
1069
+ # number before you can send SMS messages to US phone numbers. If you
1068
1070
  # use SMS text messages in Amazon Cognito, you must register a phone
1069
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
1070
- # registered number automatically. Otherwise, Amazon Cognito users that
1071
- # must receive SMS messages might be unable to sign up, activate their
1072
- # accounts, or sign in.
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.
1073
1075
  #
1074
1076
  # If you have never used SMS text messages with Amazon Cognito or any
1075
1077
  # other Amazon Web Service, Amazon Simple Notification Service might
1076
- # place your account in SMS sandbox. In <i> <a
1078
+ # place your account in the SMS sandbox. In <i> <a
1077
1079
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
1078
- # mode</a> </i>, you will have limitations, such as sending messages
1079
- # only to verified phone numbers. After testing in the sandbox
1080
- # environment, you can move out of the SMS sandbox and into production.
1081
- # For more information, see [ SMS message settings for Amazon Cognito
1082
- # User Pools][2] in the *Amazon Cognito Developer Guide*.
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*.
1083
1085
  #
1084
1086
  # </note>
1085
1087
  #
@@ -1192,8 +1194,8 @@ module Aws::CognitoIdentityProvider
1192
1194
  #
1193
1195
  # * Verify auth challenge
1194
1196
  #
1195
- # For more information, see [Customizing User Pool Workflows with Lambda
1196
- # 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*.
1197
1199
  #
1198
1200
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
1199
1201
  # Cognito won't do the following:
@@ -1283,26 +1285,25 @@ module Aws::CognitoIdentityProvider
1283
1285
  end
1284
1286
 
1285
1287
  # Links an existing user account in a user pool (`DestinationUser`) to
1286
- # an identity from an external identity provider (`SourceUser`) based on
1287
- # a specified attribute name and value from the external identity
1288
- # provider. This allows you to create a link from the existing user
1289
- # account to an external federated user identity that has not yet been
1290
- # used to sign in. You can then use the federated user identity to sign
1291
- # in as the existing user account.
1288
+ # an identity from an external IdP (`SourceUser`) based on a specified
1289
+ # attribute name and value from the external IdP. This allows you to
1290
+ # create a link from the existing user account to an external federated
1291
+ # user identity that has not yet been used to sign in. You can then use
1292
+ # the federated user identity to sign in as the existing user account.
1292
1293
  #
1293
1294
  # For example, if there is an existing user with a username and
1294
1295
  # password, this API links that user to a federated user identity. When
1295
1296
  # the user signs in with a federated user identity, they sign in as the
1296
1297
  # existing user account.
1297
1298
  #
1298
- # <note markdown="1"> The maximum number of federated identities linked to a user is 5.
1299
+ # <note markdown="1"> The maximum number of federated identities linked to a user is five.
1299
1300
  #
1300
1301
  # </note>
1301
1302
  #
1302
1303
  # Because this API allows a user with an external federated identity to
1303
1304
  # sign in as an existing user in the user pool, it is critical that it
1304
- # only be used with external identity providers and provider attributes
1305
- # that have been trusted by the application owner.
1305
+ # only be used with external IdPs and provider attributes that have been
1306
+ # trusted by the application owner.
1306
1307
  #
1307
1308
  # This action is administrative and requires developer credentials.
1308
1309
  #
@@ -1310,12 +1311,12 @@ module Aws::CognitoIdentityProvider
1310
1311
  # The user pool ID for the user pool.
1311
1312
  #
1312
1313
  # @option params [required, Types::ProviderUserIdentifierType] :destination_user
1313
- # The existing user in the user pool to be linked to the external
1314
- # identity provider user account. Can be a native (Username + Password)
1315
- # Amazon Cognito User Pools user or a federated user (for example, a
1316
- # SAML or Facebook user). If the user doesn't exist, an exception is
1317
- # thrown. This is the user that is returned when the new user (with the
1318
- # linked identity provider attribute) signs in.
1314
+ # The existing user in the user pool that you want to assign to the
1315
+ # external IdP user account. This user can be a native (Username +
1316
+ # Password) Amazon Cognito user pools user or a federated user (for
1317
+ # example, a SAML or Facebook user). If the user doesn't exist, Amazon
1318
+ # Cognito generates an exception. Amazon Cognito returns this user when
1319
+ # the new user (with the linked IdP attribute) signs in.
1319
1320
  #
1320
1321
  # For a native username + password user, the `ProviderAttributeValue`
1321
1322
  # for the `DestinationUser` should be the username in the user pool. For
@@ -1331,27 +1332,26 @@ module Aws::CognitoIdentityProvider
1331
1332
  # won't succeed.
1332
1333
  #
1333
1334
  # @option params [required, Types::ProviderUserIdentifierType] :source_user
1334
- # An external identity provider account for a user who doesn't exist
1335
- # yet in the user pool. This user must be a federated user (for example,
1336
- # a SAML or Facebook user), not another native user.
1335
+ # An external IdP account for a user who doesn't exist yet in the user
1336
+ # pool. This user must be a federated user (for example, a SAML or
1337
+ # Facebook user), not another native user.
1337
1338
  #
1338
- # If the `SourceUser` is using a federated social identity provider,
1339
- # such as Facebook, Google, or Login with Amazon, you must set the
1340
- # `ProviderAttributeName` to `Cognito_Subject`. For social identity
1341
- # providers, the `ProviderName` will be `Facebook`, `Google`, or
1342
- # `LoginWithAmazon`, and Amazon Cognito will automatically parse the
1343
- # Facebook, Google, and Login with Amazon tokens for `id`, `sub`, and
1344
- # `user_id`, respectively. The `ProviderAttributeValue` for the user
1345
- # must be the same value as the `id`, `sub`, or `user_id` value found in
1346
- # the social identity provider token.
1339
+ # If the `SourceUser` is using a federated social IdP, such as Facebook,
1340
+ # Google, or Login with Amazon, you must set the `ProviderAttributeName`
1341
+ # to `Cognito_Subject`. For social IdPs, the `ProviderName` will be
1342
+ # `Facebook`, `Google`, or `LoginWithAmazon`, and Amazon Cognito will
1343
+ # automatically parse the Facebook, Google, and Login with Amazon tokens
1344
+ # for `id`, `sub`, and `user_id`, respectively. The
1345
+ # `ProviderAttributeValue` for the user must be the same value as the
1346
+ # `id`, `sub`, or `user_id` value found in the social IdP token.
1347
1347
  #
1348
1348
  #
1349
1349
  #
1350
1350
  # For SAML, the `ProviderAttributeName` can be any value that matches a
1351
1351
  # claim in the SAML assertion. If you want to link SAML users based on
1352
1352
  # the subject of the SAML assertion, you should map the subject to a
1353
- # claim through the SAML identity provider and submit that claim name as
1354
- # the `ProviderAttributeName`. If you set `ProviderAttributeName` to
1353
+ # claim through the SAML IdP and submit that claim name as the
1354
+ # `ProviderAttributeName`. If you set `ProviderAttributeName` to
1355
1355
  # `Cognito_Subject`, Amazon Cognito will automatically parse the default
1356
1356
  # unique identifier found in the subject from the SAML token.
1357
1357
  #
@@ -1599,22 +1599,22 @@ module Aws::CognitoIdentityProvider
1599
1599
  #
1600
1600
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
1601
1601
  # US telecom carriers require you to register an origination phone
1602
- # number before you can send SMS messages to U.S. phone numbers. If you
1602
+ # number before you can send SMS messages to US phone numbers. If you
1603
1603
  # use SMS text messages in Amazon Cognito, you must register a phone
1604
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
1605
- # registered number automatically. Otherwise, Amazon Cognito users that
1606
- # must receive SMS messages might be unable to sign up, activate their
1607
- # accounts, or sign in.
1604
+ # number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
1605
+ # number automatically. Otherwise, Amazon Cognito users who must receive
1606
+ # SMS messages might not be able to sign up, activate their accounts, or
1607
+ # sign in.
1608
1608
  #
1609
1609
  # If you have never used SMS text messages with Amazon Cognito or any
1610
1610
  # other Amazon Web Service, Amazon Simple Notification Service might
1611
- # place your account in SMS sandbox. In <i> <a
1611
+ # place your account in the SMS sandbox. In <i> <a
1612
1612
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
1613
- # mode</a> </i>, you will have limitations, such as sending messages
1614
- # only to verified phone numbers. After testing in the sandbox
1615
- # environment, you can move out of the SMS sandbox and into production.
1616
- # For more information, see [ SMS message settings for Amazon Cognito
1617
- # User Pools][2] in the *Amazon Cognito Developer Guide*.
1613
+ # mode</a> </i>, you can send messages only to verified phone numbers.
1614
+ # After you test your app while in the sandbox environment, you can move
1615
+ # out of the sandbox and into production. For more information, see [
1616
+ # SMS message settings for Amazon Cognito user pools][2] in the *Amazon
1617
+ # Cognito Developer Guide*.
1618
1618
  #
1619
1619
  # </note>
1620
1620
  #
@@ -1647,8 +1647,8 @@ module Aws::CognitoIdentityProvider
1647
1647
  # `clientMetadata` value to enhance your workflow for your specific
1648
1648
  # needs.
1649
1649
  #
1650
- # For more information, see [Customizing User Pool Workflows with Lambda
1651
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
1650
+ # For more information, see [ Customizing user pool Workflows with
1651
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
1652
1652
  #
1653
1653
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
1654
1654
  # Cognito won't do the following:
@@ -1694,22 +1694,22 @@ module Aws::CognitoIdentityProvider
1694
1694
  #
1695
1695
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
1696
1696
  # US telecom carriers require you to register an origination phone
1697
- # number before you can send SMS messages to U.S. phone numbers. If you
1697
+ # number before you can send SMS messages to US phone numbers. If you
1698
1698
  # use SMS text messages in Amazon Cognito, you must register a phone
1699
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
1700
- # registered number automatically. Otherwise, Amazon Cognito users that
1701
- # must receive SMS messages might be unable to sign up, activate their
1702
- # accounts, or sign in.
1699
+ # number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
1700
+ # number automatically. Otherwise, Amazon Cognito users who must receive
1701
+ # SMS messages might not be able to sign up, activate their accounts, or
1702
+ # sign in.
1703
1703
  #
1704
1704
  # If you have never used SMS text messages with Amazon Cognito or any
1705
1705
  # other Amazon Web Service, Amazon Simple Notification Service might
1706
- # place your account in SMS sandbox. In <i> <a
1706
+ # place your account in the SMS sandbox. In <i> <a
1707
1707
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
1708
- # mode</a> </i>, you will have limitations, such as sending messages
1709
- # only to verified phone numbers. After testing in the sandbox
1710
- # environment, you can move out of the SMS sandbox and into production.
1711
- # For more information, see [ SMS message settings for Amazon Cognito
1712
- # User Pools][2] in the *Amazon Cognito Developer Guide*.
1708
+ # mode</a> </i>, you can send messages only to verified phone numbers.
1709
+ # After you test your app while in the sandbox environment, you can move
1710
+ # out of the sandbox and into production. For more information, see [
1711
+ # SMS message settings for Amazon Cognito user pools][2] in the *Amazon
1712
+ # Cognito Developer Guide*.
1713
1713
  #
1714
1714
  # </note>
1715
1715
  #
@@ -1752,9 +1752,22 @@ module Aws::CognitoIdentityProvider
1752
1752
  # * `ADMIN_NO_SRP_AUTH`\: `PASSWORD`, `USERNAME`, `SECRET_HASH` (if app
1753
1753
  # client is configured with client secret).
1754
1754
  #
1755
- # * `NEW_PASSWORD_REQUIRED`\: `NEW_PASSWORD`, any other required
1756
- # attributes, `USERNAME`, `SECRET_HASH` (if app client is configured
1757
- # with client secret).
1755
+ # * `NEW_PASSWORD_REQUIRED`\: `NEW_PASSWORD`, `USERNAME`, `SECRET_HASH`
1756
+ # (if app client is configured with client secret). To set any
1757
+ # required attributes that Amazon Cognito returned as
1758
+ # `requiredAttributes` in the `AdminInitiateAuth` response, add a
1759
+ # `userAttributes.attributename ` parameter. This parameter can also
1760
+ # set values for writable attributes that aren't required by your
1761
+ # user pool.
1762
+ #
1763
+ # <note markdown="1"> In a `NEW_PASSWORD_REQUIRED` challenge response, you can't modify a
1764
+ # required attribute that already has a value. In
1765
+ # `AdminRespondToAuthChallenge`, set a value for any keys that Amazon
1766
+ # Cognito returned in the `requiredAttributes` parameter, then use the
1767
+ # `AdminUpdateUserAttributes` API operation to modify the value of any
1768
+ # additional attributes.
1769
+ #
1770
+ # </note>
1758
1771
  #
1759
1772
  # * `MFA_SETUP` requires `USERNAME`, plus you must use the session value
1760
1773
  # returned by `VerifySoftwareToken` in the `Session` parameter.
@@ -1788,20 +1801,35 @@ module Aws::CognitoIdentityProvider
1788
1801
  #
1789
1802
  # You create custom workflows by assigning Lambda functions to user pool
1790
1803
  # triggers. When you use the AdminRespondToAuthChallenge API action,
1791
- # Amazon Cognito invokes any functions that are assigned to the
1792
- # following triggers: *pre sign-up*, *custom message*, *post
1793
- # authentication*, *user migration*, *pre token generation*, *define
1794
- # auth challenge*, *create auth challenge*, and *verify auth challenge
1795
- # response*. When Amazon Cognito invokes any of these functions, it
1796
- # passes a JSON payload, which the function receives as input. This
1797
- # payload contains a `clientMetadata` attribute, which provides the data
1798
- # that you assigned to the ClientMetadata parameter in your
1799
- # AdminRespondToAuthChallenge request. In your function code in Lambda,
1800
- # you can process the `clientMetadata` value to enhance your workflow
1801
- # for your specific needs.
1804
+ # Amazon Cognito invokes any functions that you have assigned to the
1805
+ # following triggers:
1806
+ #
1807
+ # * pre sign-up
1808
+ #
1809
+ # * custom message
1810
+ #
1811
+ # * post authentication
1802
1812
  #
1803
- # For more information, see [Customizing User Pool Workflows with Lambda
1804
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
1813
+ # * user migration
1814
+ #
1815
+ # * pre token generation
1816
+ #
1817
+ # * define auth challenge
1818
+ #
1819
+ # * create auth challenge
1820
+ #
1821
+ # * verify auth challenge response
1822
+ #
1823
+ # When Amazon Cognito invokes any of these functions, it passes a JSON
1824
+ # payload, which the function receives as input. This payload contains a
1825
+ # `clientMetadata` attribute that provides the data that you assigned to
1826
+ # the ClientMetadata parameter in your AdminRespondToAuthChallenge
1827
+ # request. In your function code in Lambda, you can process the
1828
+ # `clientMetadata` value to enhance your workflow for your specific
1829
+ # needs.
1830
+ #
1831
+ # For more information, see [ Customizing user pool Workflows with
1832
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
1805
1833
  #
1806
1834
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
1807
1835
  # Cognito won't do the following:
@@ -2101,22 +2129,22 @@ module Aws::CognitoIdentityProvider
2101
2129
  #
2102
2130
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
2103
2131
  # US telecom carriers require you to register an origination phone
2104
- # number before you can send SMS messages to U.S. phone numbers. If you
2132
+ # number before you can send SMS messages to US phone numbers. If you
2105
2133
  # use SMS text messages in Amazon Cognito, you must register a phone
2106
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
2107
- # registered number automatically. Otherwise, Amazon Cognito users that
2108
- # must receive SMS messages might be unable to sign up, activate their
2109
- # accounts, or sign in.
2134
+ # number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
2135
+ # number automatically. Otherwise, Amazon Cognito users who must receive
2136
+ # SMS messages might not be able to sign up, activate their accounts, or
2137
+ # sign in.
2110
2138
  #
2111
2139
  # If you have never used SMS text messages with Amazon Cognito or any
2112
2140
  # other Amazon Web Service, Amazon Simple Notification Service might
2113
- # place your account in SMS sandbox. In <i> <a
2141
+ # place your account in the SMS sandbox. In <i> <a
2114
2142
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
2115
- # mode</a> </i>, you will have limitations, such as sending messages
2116
- # only to verified phone numbers. After testing in the sandbox
2117
- # environment, you can move out of the SMS sandbox and into production.
2118
- # For more information, see [ SMS message settings for Amazon Cognito
2119
- # User Pools][2] in the *Amazon Cognito Developer Guide*.
2143
+ # mode</a> </i>, you can send messages only to verified phone numbers.
2144
+ # After you test your app while in the sandbox environment, you can move
2145
+ # out of the sandbox and into production. For more information, see [
2146
+ # SMS message settings for Amazon Cognito user pools][2] in the *Amazon
2147
+ # Cognito Developer Guide*.
2120
2148
  #
2121
2149
  # </note>
2122
2150
  #
@@ -2140,6 +2168,21 @@ module Aws::CognitoIdentityProvider
2140
2168
  # For custom attributes, you must prepend the `custom:` prefix to the
2141
2169
  # attribute name.
2142
2170
  #
2171
+ # If your user pool requires verification before Amazon Cognito updates
2172
+ # an attribute value that you specify in this request, Amazon Cognito
2173
+ # doesn’t immediately update the value of that attribute. After your
2174
+ # user receives and responds to a verification message to verify the new
2175
+ # value, Amazon Cognito updates the attribute value. Your user can sign
2176
+ # in and receive messages with the original attribute value until they
2177
+ # verify the new value.
2178
+ #
2179
+ # To update the value of an attribute that requires verification in the
2180
+ # same API request, include the `email_verified` or
2181
+ # `phone_number_verified` attribute, with a value of `true`. If you set
2182
+ # the `email_verified` or `phone_number_verified` value for an `email`
2183
+ # or `phone_number` attribute that requires verification to `true`,
2184
+ # Amazon Cognito doesn’t send a verification message to your user.
2185
+ #
2143
2186
  # @option params [Hash<String,String>] :client_metadata
2144
2187
  # A map of custom key-value pairs that you can provide as input for any
2145
2188
  # custom workflows that this action triggers.
@@ -2155,8 +2198,8 @@ module Aws::CognitoIdentityProvider
2155
2198
  # you can process the `clientMetadata` value to enhance your workflow
2156
2199
  # for your specific needs.
2157
2200
  #
2158
- # For more information, see [Customizing User Pool Workflows with Lambda
2159
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
2201
+ # For more information, see [ Customizing user pool Workflows with
2202
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
2160
2203
  #
2161
2204
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
2162
2205
  # Cognito won't do the following:
@@ -2204,10 +2247,14 @@ module Aws::CognitoIdentityProvider
2204
2247
  req.send_request(options)
2205
2248
  end
2206
2249
 
2207
- # Signs out users from all devices, as an administrator. It also
2208
- # invalidates all refresh tokens issued to a user. The user's current
2209
- # access and Id tokens remain valid until their expiry. Access and Id
2210
- # tokens expire one hour after they're issued.
2250
+ # Signs out a user from all devices. You must sign
2251
+ # `AdminUserGlobalSignOut` requests with Amazon Web Services
2252
+ # credentials. It also invalidates all refresh tokens that Amazon
2253
+ # Cognito has issued to a user. The user's current access and ID tokens
2254
+ # remain valid until they expire. By default, access and ID tokens
2255
+ # expire one hour after they're issued. A user can still use a hosted
2256
+ # UI cookie to retrieve new tokens for the duration of the cookie
2257
+ # validity period of 1 hour.
2211
2258
  #
2212
2259
  # Calling this action requires developer credentials.
2213
2260
  #
@@ -2250,7 +2297,8 @@ module Aws::CognitoIdentityProvider
2250
2297
  # </note>
2251
2298
  #
2252
2299
  # @option params [String] :access_token
2253
- # The access token.
2300
+ # A valid access token that Amazon Cognito issued to the user whose
2301
+ # software token you want to generate.
2254
2302
  #
2255
2303
  # @option params [String] :session
2256
2304
  # The session that should be passed both ways in challenge-response
@@ -2292,7 +2340,8 @@ module Aws::CognitoIdentityProvider
2292
2340
  # The new password.
2293
2341
  #
2294
2342
  # @option params [required, String] :access_token
2295
- # The access token.
2343
+ # A valid access token that Amazon Cognito issued to the user whose
2344
+ # password you want to change.
2296
2345
  #
2297
2346
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2298
2347
  #
@@ -2317,7 +2366,8 @@ module Aws::CognitoIdentityProvider
2317
2366
  # device tracking.
2318
2367
  #
2319
2368
  # @option params [required, String] :access_token
2320
- # The access token.
2369
+ # A valid access token that Amazon Cognito issued to the user whose
2370
+ # device you want to confirm.
2321
2371
  #
2322
2372
  # @option params [required, String] :device_key
2323
2373
  # The device key.
@@ -2408,8 +2458,8 @@ module Aws::CognitoIdentityProvider
2408
2458
  # can process the `clientMetadata` value to enhance your workflow for
2409
2459
  # your specific needs.
2410
2460
  #
2411
- # For more information, see [Customizing User Pool Workflows with Lambda
2412
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
2461
+ # For more information, see [ Customizing user pool Workflows with
2462
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
2413
2463
  #
2414
2464
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
2415
2465
  # Cognito won't do the following:
@@ -2460,8 +2510,7 @@ module Aws::CognitoIdentityProvider
2460
2510
  req.send_request(options)
2461
2511
  end
2462
2512
 
2463
- # Confirms registration of a user and handles the existing alias from a
2464
- # previous user.
2513
+ # Confirms registration of a new user.
2465
2514
  #
2466
2515
  # @option params [required, String] :client_id
2467
2516
  # The ID of the app client associated with the user pool.
@@ -2510,8 +2559,8 @@ module Aws::CognitoIdentityProvider
2510
2559
  # function code in Lambda, you can process the `clientMetadata` value to
2511
2560
  # enhance your workflow for your specific needs.
2512
2561
  #
2513
- # For more information, see [Customizing User Pool Workflows with Lambda
2514
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
2562
+ # For more information, see [ Customizing user pool Workflows with
2563
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
2515
2564
  #
2516
2565
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
2517
2566
  # Cognito won't do the following:
@@ -2582,7 +2631,7 @@ module Aws::CognitoIdentityProvider
2582
2631
  # A non-negative integer value that specifies the precedence of this
2583
2632
  # group relative to the other groups that a user can belong to in the
2584
2633
  # user pool. Zero is the highest precedence value. Groups with lower
2585
- # `Precedence` values take precedence over groups with higher ornull
2634
+ # `Precedence` values take precedence over groups with higher or null
2586
2635
  # `Precedence` values. If a user belongs to two or more groups, it is
2587
2636
  # the group with the lowest precedence value whose role ARN is given in
2588
2637
  # the user's tokens for the `cognito:roles` and
@@ -2595,7 +2644,8 @@ module Aws::CognitoIdentityProvider
2595
2644
  # the two groups have different role ARNs, the `cognito:preferred_role`
2596
2645
  # claim isn't set in users' tokens.
2597
2646
  #
2598
- # The default `Precedence` value is null.
2647
+ # The default `Precedence` value is null. The maximum `Precedence` value
2648
+ # is `2^31-1`.
2599
2649
  #
2600
2650
  # @return [Types::CreateGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2601
2651
  #
@@ -2630,20 +2680,20 @@ module Aws::CognitoIdentityProvider
2630
2680
  req.send_request(options)
2631
2681
  end
2632
2682
 
2633
- # Creates an identity provider for a user pool.
2683
+ # Creates an IdP for a user pool.
2634
2684
  #
2635
2685
  # @option params [required, String] :user_pool_id
2636
2686
  # The user pool ID.
2637
2687
  #
2638
2688
  # @option params [required, String] :provider_name
2639
- # The identity provider name.
2689
+ # The IdP name.
2640
2690
  #
2641
2691
  # @option params [required, String] :provider_type
2642
- # The identity provider type.
2692
+ # The IdP type.
2643
2693
  #
2644
2694
  # @option params [required, Hash<String,String>] :provider_details
2645
- # The identity provider details. The following list describes the
2646
- # provider detail keys for each identity provider type.
2695
+ # The IdP details. The following list describes the provider detail keys
2696
+ # for each IdP type.
2647
2697
  #
2648
2698
  # * For Google and Login with Amazon:
2649
2699
  #
@@ -2687,33 +2737,36 @@ module Aws::CognitoIdentityProvider
2687
2737
  #
2688
2738
  # * authorize\_scopes
2689
2739
  #
2690
- # * authorize\_url *if not available from discovery URL specified by
2691
- # oidc\_issuer key*
2740
+ # * The following keys are only present if Amazon Cognito didn't
2741
+ # discover them at the `oidc_issuer` URL.
2742
+ #
2743
+ # * authorize\_url
2744
+ #
2745
+ # * token\_url
2746
+ #
2747
+ # * attributes\_url
2692
2748
  #
2693
- # * token\_url *if not available from discovery URL specified by
2694
- # oidc\_issuer key*
2749
+ # * jwks\_uri
2695
2750
  #
2696
- # * attributes\_url *if not available from discovery URL specified by
2697
- # oidc\_issuer key*
2751
+ # * Amazon Cognito sets the value of the following keys automatically.
2752
+ # They are read-only.
2698
2753
  #
2699
- # * jwks\_uri *if not available from discovery URL specified by
2700
- # oidc\_issuer key*
2754
+ # * attributes\_url\_add\_attributes
2701
2755
  #
2702
- # * attributes\_url\_add\_attributes *a read-only property that is set
2703
- # automatically*
2756
+ # ^
2704
2757
  #
2705
2758
  # * For SAML providers:
2706
2759
  #
2707
- # * MetadataFile OR MetadataURL
2760
+ # * MetadataFile or MetadataURL
2708
2761
  #
2709
- # * IDPSignout (optional)
2762
+ # * IDPSignout *optional*
2710
2763
  #
2711
2764
  # @option params [Hash<String,String>] :attribute_mapping
2712
- # A mapping of identity provider attributes to standard and custom user
2713
- # pool attributes.
2765
+ # A mapping of IdP attributes to standard and custom user pool
2766
+ # attributes.
2714
2767
  #
2715
2768
  # @option params [Array<String>] :idp_identifiers
2716
- # A list of identity provider identifiers.
2769
+ # A list of IdP identifiers.
2717
2770
  #
2718
2771
  # @return [Types::CreateIdentityProviderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2719
2772
  #
@@ -2866,22 +2919,22 @@ module Aws::CognitoIdentityProvider
2866
2919
  #
2867
2920
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
2868
2921
  # US telecom carriers require you to register an origination phone
2869
- # number before you can send SMS messages to U.S. phone numbers. If you
2922
+ # number before you can send SMS messages to US phone numbers. If you
2870
2923
  # use SMS text messages in Amazon Cognito, you must register a phone
2871
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
2872
- # registered number automatically. Otherwise, Amazon Cognito users that
2873
- # must receive SMS messages might be unable to sign up, activate their
2874
- # accounts, or sign in.
2924
+ # number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
2925
+ # number automatically. Otherwise, Amazon Cognito users who must receive
2926
+ # SMS messages might not be able to sign up, activate their accounts, or
2927
+ # sign in.
2875
2928
  #
2876
2929
  # If you have never used SMS text messages with Amazon Cognito or any
2877
2930
  # other Amazon Web Service, Amazon Simple Notification Service might
2878
- # place your account in SMS sandbox. In <i> <a
2931
+ # place your account in the SMS sandbox. In <i> <a
2879
2932
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
2880
- # mode</a> </i>, you will have limitations, such as sending messages
2881
- # only to verified phone numbers. After testing in the sandbox
2882
- # environment, you can move out of the SMS sandbox and into production.
2883
- # For more information, see [ SMS message settings for Amazon Cognito
2884
- # User Pools][2] in the *Amazon Cognito Developer Guide*.
2933
+ # mode</a> </i>, you can send messages only to verified phone numbers.
2934
+ # After you test your app while in the sandbox environment, you can move
2935
+ # out of the sandbox and into production. For more information, see [
2936
+ # SMS message settings for Amazon Cognito user pools][2] in the *Amazon
2937
+ # Cognito Developer Guide*.
2885
2938
  #
2886
2939
  # </note>
2887
2940
  #
@@ -2961,14 +3014,23 @@ module Aws::CognitoIdentityProvider
2961
3014
  # @option params [String] :mfa_configuration
2962
3015
  # Specifies MFA configuration details.
2963
3016
  #
3017
+ # @option params [Types::UserAttributeUpdateSettingsType] :user_attribute_update_settings
3018
+ #
2964
3019
  # @option params [Types::DeviceConfigurationType] :device_configuration
2965
3020
  # The device configuration.
2966
3021
  #
2967
3022
  # @option params [Types::EmailConfigurationType] :email_configuration
2968
- # The email configuration.
3023
+ # The email configuration of your user pool. The email configuration
3024
+ # type sets your preferred sending method, Amazon Web Services Region,
3025
+ # and sender for messages from your user pool.
2969
3026
  #
2970
3027
  # @option params [Types::SmsConfigurationType] :sms_configuration
2971
- # The SMS configuration.
3028
+ # The SMS configuration with the settings that your Amazon Cognito user
3029
+ # pool must use to send an SMS message from your Amazon Web Services
3030
+ # account through Amazon Simple Notification Service. To send SMS
3031
+ # messages with Amazon SNS in the Amazon Web Services Region that you
3032
+ # want, the Amazon Cognito user pool uses an Identity and Access
3033
+ # Management (IAM) role in your Amazon Web Services account.
2972
3034
  #
2973
3035
  # @option params [Hash<String,String>] :user_pool_tags
2974
3036
  # The tag keys and values to assign to the user pool. A tag is a label
@@ -3062,6 +3124,9 @@ module Aws::CognitoIdentityProvider
3062
3124
  # },
3063
3125
  # sms_authentication_message: "SmsVerificationMessageType",
3064
3126
  # mfa_configuration: "OFF", # accepts OFF, ON, OPTIONAL
3127
+ # user_attribute_update_settings: {
3128
+ # attributes_require_verification_before_update: ["phone_number"], # accepts phone_number, email
3129
+ # },
3065
3130
  # device_configuration: {
3066
3131
  # challenge_required_on_new_device: false,
3067
3132
  # device_only_remembered_on_user_prompt: false,
@@ -3076,6 +3141,7 @@ module Aws::CognitoIdentityProvider
3076
3141
  # sms_configuration: {
3077
3142
  # sns_caller_arn: "ArnType", # required
3078
3143
  # external_id: "StringType",
3144
+ # sns_region: "RegionCodeType",
3079
3145
  # },
3080
3146
  # user_pool_tags: {
3081
3147
  # "TagKeysType" => "TagValueType",
@@ -3176,6 +3242,8 @@ module Aws::CognitoIdentityProvider
3176
3242
  # resp.user_pool.verification_message_template.email_subject_by_link #=> String
3177
3243
  # resp.user_pool.verification_message_template.default_email_option #=> String, one of "CONFIRM_WITH_LINK", "CONFIRM_WITH_CODE"
3178
3244
  # resp.user_pool.sms_authentication_message #=> String
3245
+ # resp.user_pool.user_attribute_update_settings.attributes_require_verification_before_update #=> Array
3246
+ # resp.user_pool.user_attribute_update_settings.attributes_require_verification_before_update[0] #=> String, one of "phone_number", "email"
3179
3247
  # resp.user_pool.mfa_configuration #=> String, one of "OFF", "ON", "OPTIONAL"
3180
3248
  # resp.user_pool.device_configuration.challenge_required_on_new_device #=> Boolean
3181
3249
  # resp.user_pool.device_configuration.device_only_remembered_on_user_prompt #=> Boolean
@@ -3187,6 +3255,7 @@ module Aws::CognitoIdentityProvider
3187
3255
  # resp.user_pool.email_configuration.configuration_set #=> String
3188
3256
  # resp.user_pool.sms_configuration.sns_caller_arn #=> String
3189
3257
  # resp.user_pool.sms_configuration.external_id #=> String
3258
+ # resp.user_pool.sms_configuration.sns_region #=> String
3190
3259
  # resp.user_pool.user_pool_tags #=> Hash
3191
3260
  # resp.user_pool.user_pool_tags["TagKeysType"] #=> String
3192
3261
  # resp.user_pool.sms_configuration_failure #=> String
@@ -3236,22 +3305,50 @@ module Aws::CognitoIdentityProvider
3236
3305
  # pool client being created.
3237
3306
  #
3238
3307
  # @option params [Integer] :refresh_token_validity
3239
- # The time limit, in days, after which the refresh token is no longer
3240
- # valid and can't be used.
3308
+ # The refresh token time limit. After this limit expires, your user
3309
+ # can't use their refresh token. To specify the time unit for
3310
+ # `RefreshTokenValidity` as `seconds`, `minutes`, `hours`, or `days`,
3311
+ # set a `TokenValidityUnits` value in your API request.
3312
+ #
3313
+ # For example, when you set `RefreshTokenValidity` as `10` and
3314
+ # `TokenValidityUnits` as `days`, your user can refresh their session
3315
+ # and retrieve new access and ID tokens for 10 days.
3316
+ #
3317
+ # The default time unit for `RefreshTokenValidity` in an API request is
3318
+ # days. You can't set `RefreshTokenValidity` to 0. If you do, Amazon
3319
+ # Cognito overrides the value with the default value of 30 days. *Valid
3320
+ # range* is displayed below in seconds.
3241
3321
  #
3242
3322
  # @option params [Integer] :access_token_validity
3243
- # The time limit, between 5 minutes and 1 day, after which the access
3244
- # token is no longer valid and can't be used. If you supply a
3245
- # TokenValidityUnits value, you will override the default time unit.
3323
+ # The access token time limit. After this limit expires, your user
3324
+ # can't use their access token. To specify the time unit for
3325
+ # `AccessTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set
3326
+ # a `TokenValidityUnits` value in your API request.
3327
+ #
3328
+ # For example, when you set `AccessTokenValidity` to `10` and
3329
+ # `TokenValidityUnits` to `hours`, your user can authorize access with
3330
+ # their access token for 10 hours.
3331
+ #
3332
+ # The default time unit for `AccessTokenValidity` in an API request is
3333
+ # hours. *Valid range* is displayed below in seconds.
3246
3334
  #
3247
3335
  # @option params [Integer] :id_token_validity
3248
- # The time limit, between 5 minutes and 1 day, after which the access
3249
- # token is no longer valid and can't be used. If you supply a
3250
- # TokenValidityUnits value, you will override the default time unit.
3336
+ # The ID token time limit. After this limit expires, your user can't
3337
+ # use their ID token. To specify the time unit for `IdTokenValidity` as
3338
+ # `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits`
3339
+ # value in your API request.
3340
+ #
3341
+ # For example, when you set `IdTokenValidity` as `10` and
3342
+ # `TokenValidityUnits` as `hours`, your user can authenticate their
3343
+ # session with their ID token for 10 hours.
3344
+ #
3345
+ # The default time unit for `AccessTokenValidity` in an API request is
3346
+ # hours. *Valid range* is displayed below in seconds.
3251
3347
  #
3252
3348
  # @option params [Types::TokenValidityUnitsType] :token_validity_units
3253
- # The units in which the validity times are represented. Default for
3254
- # RefreshToken is days, and default for ID and access tokens are hours.
3349
+ # The units in which the validity times are represented. The default
3350
+ # unit for RefreshToken is days, and default for ID and access tokens
3351
+ # are hours.
3255
3352
  #
3256
3353
  # @option params [Array<String>] :read_attributes
3257
3354
  # The read attributes.
@@ -3259,14 +3356,13 @@ module Aws::CognitoIdentityProvider
3259
3356
  # @option params [Array<String>] :write_attributes
3260
3357
  # The user pool attributes that the app client can write to.
3261
3358
  #
3262
- # If your app client allows users to sign in through an identity
3263
- # provider, this array must include all attributes that are mapped to
3264
- # identity provider attributes. Amazon Cognito updates mapped attributes
3265
- # when users sign in to your application through an identity provider.
3266
- # If your app client lacks write access to a mapped attribute, Amazon
3267
- # Cognito throws an error when it tries to update the attribute. For
3268
- # more information, see [Specifying Identity Provider Attribute Mappings
3269
- # for Your User Pool][1].
3359
+ # If your app client allows users to sign in through an IdP, this array
3360
+ # must include all attributes that you have mapped to IdP attributes.
3361
+ # Amazon Cognito updates mapped attributes when users sign in to your
3362
+ # application through an IdP. If your app client does not have write
3363
+ # access to a mapped attribute, Amazon Cognito throws an error when it
3364
+ # tries to update the attribute. For more information, see [Specifying
3365
+ # IdP Attribute Mappings for Your user pool][1].
3270
3366
  #
3271
3367
  #
3272
3368
  #
@@ -3275,8 +3371,12 @@ module Aws::CognitoIdentityProvider
3275
3371
  # @option params [Array<String>] :explicit_auth_flows
3276
3372
  # The authentication flows that are supported by the user pool clients.
3277
3373
  # Flow names without the `ALLOW_` prefix are no longer supported, in
3278
- # favor of new names with the `ALLOW_` prefix. Note that values with
3279
- # `ALLOW_` prefix must be used only along with the `ALLOW_` prefix.
3374
+ # favor of new names with the `ALLOW_` prefix.
3375
+ #
3376
+ # <note markdown="1"> Values with `ALLOW_` prefix must be used only along with the `ALLOW_`
3377
+ # prefix.
3378
+ #
3379
+ # </note>
3280
3380
  #
3281
3381
  # Valid values include:
3282
3382
  #
@@ -3297,13 +3397,17 @@ module Aws::CognitoIdentityProvider
3297
3397
  #
3298
3398
  # * `ALLOW_REFRESH_TOKEN_AUTH`\: Enable authflow to refresh tokens.
3299
3399
  #
3400
+ # If you don't specify a value for `ExplicitAuthFlows`, your app client
3401
+ # activates the `ALLOW_USER_SRP_AUTH` and `ALLOW_CUSTOM_AUTH`
3402
+ # authentication flows.
3403
+ #
3300
3404
  # @option params [Array<String>] :supported_identity_providers
3301
- # A list of provider names for the identity providers that are supported
3302
- # on this client. The following are supported: `COGNITO`, `Facebook`,
3303
- # `Google` and `LoginWithAmazon`.
3405
+ # A list of provider names for the IdPs that this client supports. The
3406
+ # following are supported: `COGNITO`, `Facebook`, `Google`
3407
+ # `LoginWithAmazon`, and the names of your own SAML and OIDC providers.
3304
3408
  #
3305
3409
  # @option params [Array<String>] :callback_urls
3306
- # A list of allowed redirect (callback) URLs for the identity providers.
3410
+ # A list of allowed redirect (callback) URLs for the IdPs.
3307
3411
  #
3308
3412
  # A redirect URI must:
3309
3413
  #
@@ -3325,7 +3429,7 @@ module Aws::CognitoIdentityProvider
3325
3429
  # [1]: https://tools.ietf.org/html/rfc6749#section-3.1.2
3326
3430
  #
3327
3431
  # @option params [Array<String>] :logout_urls
3328
- # A list of allowed logout URLs for the identity providers.
3432
+ # A list of allowed logout URLs for the IdPs.
3329
3433
  #
3330
3434
  # @option params [String] :default_redirect_uri
3331
3435
  # The default redirect URI. Must be in the `CallbackURLs` list.
@@ -3352,36 +3456,42 @@ module Aws::CognitoIdentityProvider
3352
3456
  # @option params [Array<String>] :allowed_o_auth_flows
3353
3457
  # The allowed OAuth flows.
3354
3458
  #
3355
- # Set to `code` to initiate a code grant flow, which provides an
3356
- # authorization code as the response. This code can be exchanged for
3357
- # access tokens with the token endpoint.
3459
+ # code
3460
+ #
3461
+ # : Use a code grant flow, which provides an authorization code as the
3462
+ # response. This code can be exchanged for access tokens with the
3463
+ # `/oauth2/token` endpoint.
3464
+ #
3465
+ # implicit
3466
+ #
3467
+ # : Issue the access token (and, optionally, ID token, based on scopes)
3468
+ # directly to your user.
3358
3469
  #
3359
- # Set to `implicit` to specify that the client should get the access
3360
- # token (and, optionally, ID token, based on scopes) directly.
3470
+ # client\_credentials
3361
3471
  #
3362
- # Set to `client_credentials` to specify that the client should get the
3363
- # access token (and, optionally, ID token, based on scopes) from the
3364
- # token endpoint using a combination of client and client\_secret.
3472
+ # : Issue the access token from the `/oauth2/token` endpoint directly to
3473
+ # a non-person user using a combination of the client ID and client
3474
+ # secret.
3365
3475
  #
3366
3476
  # @option params [Array<String>] :allowed_o_auth_scopes
3367
- # The allowed OAuth scopes. Possible values provided by OAuth are:
3477
+ # The allowed OAuth scopes. Possible values provided by OAuth are
3368
3478
  # `phone`, `email`, `openid`, and `profile`. Possible values provided by
3369
- # Amazon Web Services are: `aws.cognito.signin.user.admin`. Custom
3370
- # scopes created in Resource Servers are also supported.
3479
+ # Amazon Web Services are `aws.cognito.signin.user.admin`. Custom scopes
3480
+ # created in Resource Servers are also supported.
3371
3481
  #
3372
3482
  # @option params [Boolean] :allowed_o_auth_flows_user_pool_client
3373
3483
  # Set to true if the client is allowed to follow the OAuth protocol when
3374
3484
  # interacting with Amazon Cognito user pools.
3375
3485
  #
3376
3486
  # @option params [Types::AnalyticsConfigurationType] :analytics_configuration
3377
- # The Amazon Pinpoint analytics configuration for collecting metrics for
3378
- # this user pool.
3487
+ # The user pool analytics configuration for collecting metrics and
3488
+ # sending them to your Amazon Pinpoint campaign.
3379
3489
  #
3380
- # <note markdown="1"> In Amazon Web Services Regions where isn't available, User Pools only
3381
- # supports sending events to Amazon Pinpoint projects in Amazon Web
3382
- # Services Region us-east-1. In Regions where is available, User Pools
3383
- # will support sending events to Amazon Pinpoint projects within that
3384
- # same Region.
3490
+ # <note markdown="1"> In Amazon Web Services Regions where Amazon Pinpoint isn't available,
3491
+ # user pools only support sending events to Amazon Pinpoint projects in
3492
+ # Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint
3493
+ # is available, user pools support sending events to Amazon Pinpoint
3494
+ # projects within that same Region.
3385
3495
  #
3386
3496
  # </note>
3387
3497
  #
@@ -3582,13 +3692,13 @@ module Aws::CognitoIdentityProvider
3582
3692
  req.send_request(options)
3583
3693
  end
3584
3694
 
3585
- # Deletes an identity provider for a user pool.
3695
+ # Deletes an IdP for a user pool.
3586
3696
  #
3587
3697
  # @option params [required, String] :user_pool_id
3588
3698
  # The user pool ID.
3589
3699
  #
3590
3700
  # @option params [required, String] :provider_name
3591
- # The identity provider name.
3701
+ # The IdP name.
3592
3702
  #
3593
3703
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3594
3704
  #
@@ -3637,7 +3747,8 @@ module Aws::CognitoIdentityProvider
3637
3747
  # Allows a user to delete himself or herself.
3638
3748
  #
3639
3749
  # @option params [required, String] :access_token
3640
- # The access token from a request to delete a user.
3750
+ # A valid access token that Amazon Cognito issued to the user whose user
3751
+ # profile you want to delete.
3641
3752
  #
3642
3753
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3643
3754
  #
@@ -3666,7 +3777,8 @@ module Aws::CognitoIdentityProvider
3666
3777
  # the front of the attribute name.
3667
3778
  #
3668
3779
  # @option params [required, String] :access_token
3669
- # The access token used in the request to delete user attributes.
3780
+ # A valid access token that Amazon Cognito issued to the user whose
3781
+ # attributes you want to delete.
3670
3782
  #
3671
3783
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3672
3784
  #
@@ -3763,13 +3875,13 @@ module Aws::CognitoIdentityProvider
3763
3875
  req.send_request(options)
3764
3876
  end
3765
3877
 
3766
- # Gets information about a specific identity provider.
3878
+ # Gets information about a specific IdP.
3767
3879
  #
3768
3880
  # @option params [required, String] :user_pool_id
3769
3881
  # The user pool ID.
3770
3882
  #
3771
3883
  # @option params [required, String] :provider_name
3772
- # The identity provider name.
3884
+ # The IdP name.
3773
3885
  #
3774
3886
  # @return [Types::DescribeIdentityProviderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3775
3887
  #
@@ -4016,6 +4128,8 @@ module Aws::CognitoIdentityProvider
4016
4128
  # resp.user_pool.verification_message_template.email_subject_by_link #=> String
4017
4129
  # resp.user_pool.verification_message_template.default_email_option #=> String, one of "CONFIRM_WITH_LINK", "CONFIRM_WITH_CODE"
4018
4130
  # resp.user_pool.sms_authentication_message #=> String
4131
+ # resp.user_pool.user_attribute_update_settings.attributes_require_verification_before_update #=> Array
4132
+ # resp.user_pool.user_attribute_update_settings.attributes_require_verification_before_update[0] #=> String, one of "phone_number", "email"
4019
4133
  # resp.user_pool.mfa_configuration #=> String, one of "OFF", "ON", "OPTIONAL"
4020
4134
  # resp.user_pool.device_configuration.challenge_required_on_new_device #=> Boolean
4021
4135
  # resp.user_pool.device_configuration.device_only_remembered_on_user_prompt #=> Boolean
@@ -4027,6 +4141,7 @@ module Aws::CognitoIdentityProvider
4027
4141
  # resp.user_pool.email_configuration.configuration_set #=> String
4028
4142
  # resp.user_pool.sms_configuration.sns_caller_arn #=> String
4029
4143
  # resp.user_pool.sms_configuration.external_id #=> String
4144
+ # resp.user_pool.sms_configuration.sns_region #=> String
4030
4145
  # resp.user_pool.user_pool_tags #=> Hash
4031
4146
  # resp.user_pool.user_pool_tags["TagKeysType"] #=> String
4032
4147
  # resp.user_pool.sms_configuration_failure #=> String
@@ -4163,7 +4278,8 @@ module Aws::CognitoIdentityProvider
4163
4278
  # Forgets the specified device.
4164
4279
  #
4165
4280
  # @option params [String] :access_token
4166
- # The access token for the forgotten device request.
4281
+ # A valid access token that Amazon Cognito issued to the user whose
4282
+ # registered device you want to forget.
4167
4283
  #
4168
4284
  # @option params [required, String] :device_key
4169
4285
  # The device key.
@@ -4198,22 +4314,22 @@ module Aws::CognitoIdentityProvider
4198
4314
  #
4199
4315
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
4200
4316
  # US telecom carriers require you to register an origination phone
4201
- # number before you can send SMS messages to U.S. phone numbers. If you
4317
+ # number before you can send SMS messages to US phone numbers. If you
4202
4318
  # use SMS text messages in Amazon Cognito, you must register a phone
4203
- # number with [Amazon Pinpoint][3]. Amazon Cognito will use the
4204
- # registered number automatically. Otherwise, Amazon Cognito users that
4205
- # must receive SMS messages might be unable to sign up, activate their
4206
- # accounts, or sign in.
4319
+ # number with [Amazon Pinpoint][3]. Amazon Cognito uses the registered
4320
+ # number automatically. Otherwise, Amazon Cognito users who must receive
4321
+ # SMS messages might not be able to sign up, activate their accounts, or
4322
+ # sign in.
4207
4323
  #
4208
4324
  # If you have never used SMS text messages with Amazon Cognito or any
4209
4325
  # other Amazon Web Service, Amazon Simple Notification Service might
4210
- # place your account in SMS sandbox. In <i> <a
4326
+ # place your account in the SMS sandbox. In <i> <a
4211
4327
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
4212
- # mode</a> </i>, you will have limitations, such as sending messages
4213
- # only to verified phone numbers. After testing in the sandbox
4214
- # environment, you can move out of the SMS sandbox and into production.
4215
- # For more information, see [ SMS message settings for Amazon Cognito
4216
- # User Pools][4] in the *Amazon Cognito Developer Guide*.
4328
+ # mode</a> </i>, you can send messages only to verified phone numbers.
4329
+ # After you test your app while in the sandbox environment, you can move
4330
+ # out of the sandbox and into production. For more information, see [
4331
+ # SMS message settings for Amazon Cognito user pools][4] in the *Amazon
4332
+ # Cognito Developer Guide*.
4217
4333
  #
4218
4334
  # </note>
4219
4335
  #
@@ -4242,8 +4358,8 @@ module Aws::CognitoIdentityProvider
4242
4358
  # forgotten password.
4243
4359
  #
4244
4360
  # @option params [Types::AnalyticsMetadataType] :analytics_metadata
4245
- # The Amazon Pinpoint analytics metadata for collecting metrics for
4246
- # `ForgotPassword` calls.
4361
+ # The Amazon Pinpoint analytics metadata that contributes to your
4362
+ # metrics for `ForgotPassword` calls.
4247
4363
  #
4248
4364
  # @option params [Hash<String,String>] :client_metadata
4249
4365
  # A map of custom key-value pairs that you can provide as input for any
@@ -4260,8 +4376,8 @@ module Aws::CognitoIdentityProvider
4260
4376
  # your function code in Lambda, you can process the `clientMetadata`
4261
4377
  # value to enhance your workflow for your specific needs.
4262
4378
  #
4263
- # For more information, see [Customizing User Pool Workflows with Lambda
4264
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
4379
+ # For more information, see [ Customizing user pool Workflows with
4380
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
4265
4381
  #
4266
4382
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
4267
4383
  # Cognito won't do the following:
@@ -4357,7 +4473,8 @@ module Aws::CognitoIdentityProvider
4357
4473
  # The device key.
4358
4474
  #
4359
4475
  # @option params [String] :access_token
4360
- # The access token.
4476
+ # A valid access token that Amazon Cognito issued to the user whose
4477
+ # device information you want to request.
4361
4478
  #
4362
4479
  # @return [Types::GetDeviceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4363
4480
  #
@@ -4429,13 +4546,13 @@ module Aws::CognitoIdentityProvider
4429
4546
  req.send_request(options)
4430
4547
  end
4431
4548
 
4432
- # Gets the specified identity provider.
4549
+ # Gets the specified IdP.
4433
4550
  #
4434
4551
  # @option params [required, String] :user_pool_id
4435
4552
  # The user pool ID.
4436
4553
  #
4437
4554
  # @option params [required, String] :idp_identifier
4438
- # The identity provider ID.
4555
+ # The IdP identifier.
4439
4556
  #
4440
4557
  # @return [Types::GetIdentityProviderByIdentifierResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4441
4558
  #
@@ -4545,8 +4662,8 @@ module Aws::CognitoIdentityProvider
4545
4662
  # Gets the user attributes and metadata for a user.
4546
4663
  #
4547
4664
  # @option params [required, String] :access_token
4548
- # The access token returned by the server response to get information
4549
- # about the user.
4665
+ # A non-expired access token for the user whose information you want to
4666
+ # query.
4550
4667
  #
4551
4668
  # @return [Types::GetUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4552
4669
  #
@@ -4584,27 +4701,28 @@ module Aws::CognitoIdentityProvider
4584
4701
  req.send_request(options)
4585
4702
  end
4586
4703
 
4587
- # Gets the user attribute verification code for the specified attribute
4588
- # name.
4704
+ # Generates a user attribute verification code for the specified
4705
+ # attribute name. Sends a message to a user with a code that they must
4706
+ # return in a VerifyUserAttribute request.
4589
4707
  #
4590
4708
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
4591
4709
  # US telecom carriers require you to register an origination phone
4592
- # number before you can send SMS messages to U.S. phone numbers. If you
4710
+ # number before you can send SMS messages to US phone numbers. If you
4593
4711
  # use SMS text messages in Amazon Cognito, you must register a phone
4594
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
4595
- # registered number automatically. Otherwise, Amazon Cognito users that
4596
- # must receive SMS messages might be unable to sign up, activate their
4597
- # accounts, or sign in.
4712
+ # number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
4713
+ # number automatically. Otherwise, Amazon Cognito users who must receive
4714
+ # SMS messages might not be able to sign up, activate their accounts, or
4715
+ # sign in.
4598
4716
  #
4599
4717
  # If you have never used SMS text messages with Amazon Cognito or any
4600
4718
  # other Amazon Web Service, Amazon Simple Notification Service might
4601
- # place your account in SMS sandbox. In <i> <a
4719
+ # place your account in the SMS sandbox. In <i> <a
4602
4720
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
4603
- # mode</a> </i>, you will have limitations, such as sending messages
4604
- # only to verified phone numbers. After testing in the sandbox
4605
- # environment, you can move out of the SMS sandbox and into production.
4606
- # For more information, see [ SMS message settings for Amazon Cognito
4607
- # User Pools][2] in the *Amazon Cognito Developer Guide*.
4721
+ # mode</a> </i>, you can send messages only to verified phone numbers.
4722
+ # After you test your app while in the sandbox environment, you can move
4723
+ # out of the sandbox and into production. For more information, see [
4724
+ # SMS message settings for Amazon Cognito user pools][2] in the *Amazon
4725
+ # Cognito Developer Guide*.
4608
4726
  #
4609
4727
  # </note>
4610
4728
  #
@@ -4614,8 +4732,8 @@ module Aws::CognitoIdentityProvider
4614
4732
  # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html
4615
4733
  #
4616
4734
  # @option params [required, String] :access_token
4617
- # The access token returned by the server response to get the user
4618
- # attribute verification code.
4735
+ # A non-expired access token for the user whose attribute verification
4736
+ # code you want to generate.
4619
4737
  #
4620
4738
  # @option params [required, String] :attribute_name
4621
4739
  # The attribute name returned by the server response to get the user
@@ -4636,8 +4754,8 @@ module Aws::CognitoIdentityProvider
4636
4754
  # Lambda, you can process the `clientMetadata` value to enhance your
4637
4755
  # workflow for your specific needs.
4638
4756
  #
4639
- # For more information, see [Customizing User Pool Workflows with Lambda
4640
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
4757
+ # For more information, see [ Customizing user pool Workflows with
4758
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
4641
4759
  #
4642
4760
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
4643
4761
  # Cognito won't do the following:
@@ -4709,6 +4827,7 @@ module Aws::CognitoIdentityProvider
4709
4827
  # resp.sms_mfa_configuration.sms_authentication_message #=> String
4710
4828
  # resp.sms_mfa_configuration.sms_configuration.sns_caller_arn #=> String
4711
4829
  # resp.sms_mfa_configuration.sms_configuration.external_id #=> String
4830
+ # resp.sms_mfa_configuration.sms_configuration.sns_region #=> String
4712
4831
  # resp.software_token_mfa_configuration.enabled #=> Boolean
4713
4832
  # resp.mfa_configuration #=> String, one of "OFF", "ON", "OPTIONAL"
4714
4833
  #
@@ -4722,12 +4841,15 @@ module Aws::CognitoIdentityProvider
4722
4841
  end
4723
4842
 
4724
4843
  # Signs out users from all devices. It also invalidates all refresh
4725
- # tokens issued to a user. The user's current access and ID tokens
4726
- # remain valid until their expiry. Access and Id tokens expire one hour
4727
- # after they're issued.
4844
+ # tokens that Amazon Cognito has issued to a user. The user's current
4845
+ # access and ID tokens remain valid until their expiry. By default,
4846
+ # access and ID tokens expire one hour after Amazon Cognito issues them.
4847
+ # A user can still use a hosted UI cookie to retrieve new tokens for the
4848
+ # duration of the cookie validity period of 1 hour.
4728
4849
  #
4729
4850
  # @option params [required, String] :access_token
4730
- # The access token.
4851
+ # A valid access token that Amazon Cognito issued to the user who you
4852
+ # want to sign out.
4731
4853
  #
4732
4854
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
4733
4855
  #
@@ -4746,33 +4868,37 @@ module Aws::CognitoIdentityProvider
4746
4868
  req.send_request(options)
4747
4869
  end
4748
4870
 
4749
- # Initiates the authentication flow.
4871
+ # Initiates sign-in for a user in the Amazon Cognito user directory. You
4872
+ # can't sign in a user with a federated IdP with `InitiateAuth`. For
4873
+ # more information, see [ Adding user pool sign-in through a third
4874
+ # party][1].
4750
4875
  #
4751
4876
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
4752
4877
  # US telecom carriers require you to register an origination phone
4753
- # number before you can send SMS messages to U.S. phone numbers. If you
4878
+ # number before you can send SMS messages to US phone numbers. If you
4754
4879
  # use SMS text messages in Amazon Cognito, you must register a phone
4755
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
4756
- # registered number automatically. Otherwise, Amazon Cognito users that
4757
- # must receive SMS messages might be unable to sign up, activate their
4758
- # accounts, or sign in.
4880
+ # number with [Amazon Pinpoint][2]. Amazon Cognito uses the registered
4881
+ # number automatically. Otherwise, Amazon Cognito users who must receive
4882
+ # SMS messages might not be able to sign up, activate their accounts, or
4883
+ # sign in.
4759
4884
  #
4760
4885
  # If you have never used SMS text messages with Amazon Cognito or any
4761
4886
  # other Amazon Web Service, Amazon Simple Notification Service might
4762
- # place your account in SMS sandbox. In <i> <a
4887
+ # place your account in the SMS sandbox. In <i> <a
4763
4888
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
4764
- # mode</a> </i>, you will have limitations, such as sending messages
4765
- # only to verified phone numbers. After testing in the sandbox
4766
- # environment, you can move out of the SMS sandbox and into production.
4767
- # For more information, see [ SMS message settings for Amazon Cognito
4768
- # User Pools][2] in the *Amazon Cognito Developer Guide*.
4889
+ # mode</a> </i>, you can send messages only to verified phone numbers.
4890
+ # After you test your app while in the sandbox environment, you can move
4891
+ # out of the sandbox and into production. For more information, see [
4892
+ # SMS message settings for Amazon Cognito user pools][3] in the *Amazon
4893
+ # Cognito Developer Guide*.
4769
4894
  #
4770
4895
  # </note>
4771
4896
  #
4772
4897
  #
4773
4898
  #
4774
- # [1]: https://console.aws.amazon.com/pinpoint/home/
4775
- # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html
4899
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html
4900
+ # [2]: https://console.aws.amazon.com/pinpoint/home/
4901
+ # [3]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html
4776
4902
  #
4777
4903
  # @option params [required, String] :auth_flow
4778
4904
  # The authentication flow for this call to run. The API action will
@@ -4798,10 +4924,10 @@ module Aws::CognitoIdentityProvider
4798
4924
  #
4799
4925
  # * `CUSTOM_AUTH`\: Custom authentication flow.
4800
4926
  #
4801
- # * `USER_PASSWORD_AUTH`\: Non-SRP authentication flow; USERNAME and
4802
- # PASSWORD are passed directly. If a user migration Lambda trigger is
4927
+ # * `USER_PASSWORD_AUTH`\: Non-SRP authentication flow; user name and
4928
+ # password are passed directly. If a user migration Lambda trigger is
4803
4929
  # set, this flow will invoke the user migration Lambda if it doesn't
4804
- # find the USERNAME in the user pool.
4930
+ # find the user name in the user pool.
4805
4931
  #
4806
4932
  # `ADMIN_NO_SRP_AUTH` isn't a valid value.
4807
4933
  #
@@ -4863,8 +4989,8 @@ module Aws::CognitoIdentityProvider
4863
4989
  #
4864
4990
  # * Verify auth challenge
4865
4991
  #
4866
- # For more information, see [Customizing User Pool Workflows with Lambda
4867
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
4992
+ # For more information, see [ Customizing user pool Workflows with
4993
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
4868
4994
  #
4869
4995
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
4870
4996
  # Cognito won't do the following:
@@ -4889,8 +5015,8 @@ module Aws::CognitoIdentityProvider
4889
5015
  # The app client ID.
4890
5016
  #
4891
5017
  # @option params [Types::AnalyticsMetadataType] :analytics_metadata
4892
- # The Amazon Pinpoint analytics metadata for collecting metrics for
4893
- # `InitiateAuth` calls.
5018
+ # The Amazon Pinpoint analytics metadata that contributes to your
5019
+ # metrics for `InitiateAuth` calls.
4894
5020
  #
4895
5021
  # @option params [Types::UserContextDataType] :user_context_data
4896
5022
  # Contextual data such as the user's device fingerprint, IP address, or
@@ -4946,10 +5072,12 @@ module Aws::CognitoIdentityProvider
4946
5072
  req.send_request(options)
4947
5073
  end
4948
5074
 
4949
- # Lists the devices.
5075
+ # Lists the sign-in devices that Amazon Cognito has registered to the
5076
+ # current user.
4950
5077
  #
4951
5078
  # @option params [required, String] :access_token
4952
- # The access tokens for the request to list devices.
5079
+ # A valid access token that Amazon Cognito issued to the user whose list
5080
+ # of devices you want to view.
4953
5081
  #
4954
5082
  # @option params [Integer] :limit
4955
5083
  # The limit of the device request.
@@ -5042,13 +5170,13 @@ module Aws::CognitoIdentityProvider
5042
5170
  req.send_request(options)
5043
5171
  end
5044
5172
 
5045
- # Lists information about all identity providers for a user pool.
5173
+ # Lists information about all IdPs for a user pool.
5046
5174
  #
5047
5175
  # @option params [required, String] :user_pool_id
5048
5176
  # The user pool ID.
5049
5177
  #
5050
5178
  # @option params [Integer] :max_results
5051
- # The maximum number of identity providers to return.
5179
+ # The maximum number of IdPs to return.
5052
5180
  #
5053
5181
  # @option params [String] :next_token
5054
5182
  # A pagination token.
@@ -5392,8 +5520,8 @@ module Aws::CognitoIdentityProvider
5392
5520
  # Custom attributes aren't searchable.
5393
5521
  #
5394
5522
  # <note markdown="1"> You can also list users with a client-side filter. The server-side
5395
- # filter matches no more than 1 attribute. For an advanced search, use a
5396
- # client-side filter with the `--query` parameter of the `list-users`
5523
+ # filter matches no more than one attribute. For an advanced search, use
5524
+ # a client-side filter with the `--query` parameter of the `list-users`
5397
5525
  # action in the CLI. When you use a client-side filter, ListUsers
5398
5526
  # returns a paginated list of zero or more users. You can receive
5399
5527
  # multiple pages in a row with zero results. Repeat the query with each
@@ -5522,22 +5650,22 @@ module Aws::CognitoIdentityProvider
5522
5650
  #
5523
5651
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
5524
5652
  # US telecom carriers require you to register an origination phone
5525
- # number before you can send SMS messages to U.S. phone numbers. If you
5653
+ # number before you can send SMS messages to US phone numbers. If you
5526
5654
  # use SMS text messages in Amazon Cognito, you must register a phone
5527
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
5528
- # registered number automatically. Otherwise, Amazon Cognito users that
5529
- # must receive SMS messages might be unable to sign up, activate their
5530
- # accounts, or sign in.
5655
+ # number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
5656
+ # number automatically. Otherwise, Amazon Cognito users who must receive
5657
+ # SMS messages might not be able to sign up, activate their accounts, or
5658
+ # sign in.
5531
5659
  #
5532
5660
  # If you have never used SMS text messages with Amazon Cognito or any
5533
5661
  # other Amazon Web Service, Amazon Simple Notification Service might
5534
- # place your account in SMS sandbox. In <i> <a
5662
+ # place your account in the SMS sandbox. In <i> <a
5535
5663
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
5536
- # mode</a> </i>, you will have limitations, such as sending messages
5537
- # only to verified phone numbers. After testing in the sandbox
5538
- # environment, you can move out of the SMS sandbox and into production.
5539
- # For more information, see [ SMS message settings for Amazon Cognito
5540
- # User Pools][2] in the *Amazon Cognito Developer Guide*.
5664
+ # mode</a> </i>, you can send messages only to verified phone numbers.
5665
+ # After you test your app while in the sandbox environment, you can move
5666
+ # out of the sandbox and into production. For more information, see [
5667
+ # SMS message settings for Amazon Cognito user pools][2] in the *Amazon
5668
+ # Cognito Developer Guide*.
5541
5669
  #
5542
5670
  # </note>
5543
5671
  #
@@ -5564,8 +5692,8 @@ module Aws::CognitoIdentityProvider
5564
5692
  # confirmation code.
5565
5693
  #
5566
5694
  # @option params [Types::AnalyticsMetadataType] :analytics_metadata
5567
- # The Amazon Pinpoint analytics metadata for collecting metrics for
5568
- # `ResendConfirmationCode` calls.
5695
+ # The Amazon Pinpoint analytics metadata that contributes to your
5696
+ # metrics for `ResendConfirmationCode` calls.
5569
5697
  #
5570
5698
  # @option params [Hash<String,String>] :client_metadata
5571
5699
  # A map of custom key-value pairs that you can provide as input for any
@@ -5582,8 +5710,8 @@ module Aws::CognitoIdentityProvider
5582
5710
  # `clientMetadata` value to enhance your workflow for your specific
5583
5711
  # needs.
5584
5712
  #
5585
- # For more information, see [Customizing User Pool Workflows with Lambda
5586
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
5713
+ # For more information, see [ Customizing user pool Workflows with
5714
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
5587
5715
  #
5588
5716
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
5589
5717
  # Cognito won't do the following:
@@ -5644,22 +5772,22 @@ module Aws::CognitoIdentityProvider
5644
5772
  #
5645
5773
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
5646
5774
  # US telecom carriers require you to register an origination phone
5647
- # number before you can send SMS messages to U.S. phone numbers. If you
5775
+ # number before you can send SMS messages to US phone numbers. If you
5648
5776
  # use SMS text messages in Amazon Cognito, you must register a phone
5649
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
5650
- # registered number automatically. Otherwise, Amazon Cognito users that
5651
- # must receive SMS messages might be unable to sign up, activate their
5652
- # accounts, or sign in.
5777
+ # number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
5778
+ # number automatically. Otherwise, Amazon Cognito users who must receive
5779
+ # SMS messages might not be able to sign up, activate their accounts, or
5780
+ # sign in.
5653
5781
  #
5654
5782
  # If you have never used SMS text messages with Amazon Cognito or any
5655
5783
  # other Amazon Web Service, Amazon Simple Notification Service might
5656
- # place your account in SMS sandbox. In <i> <a
5784
+ # place your account in the SMS sandbox. In <i> <a
5657
5785
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
5658
- # mode</a> </i>, you will have limitations, such as sending messages
5659
- # only to verified phone numbers. After testing in the sandbox
5660
- # environment, you can move out of the SMS sandbox and into production.
5661
- # For more information, see [ SMS message settings for Amazon Cognito
5662
- # User Pools][2] in the *Amazon Cognito Developer Guide*.
5786
+ # mode</a> </i>, you can send messages only to verified phone numbers.
5787
+ # After you test your app while in the sandbox environment, you can move
5788
+ # out of the sandbox and into production. For more information, see [
5789
+ # SMS message settings for Amazon Cognito user pools][2] in the *Amazon
5790
+ # Cognito Developer Guide*.
5663
5791
  #
5664
5792
  # </note>
5665
5793
  #
@@ -5701,13 +5829,27 @@ module Aws::CognitoIdentityProvider
5701
5829
  # * `PASSWORD_VERIFIER`\: `PASSWORD_CLAIM_SIGNATURE`,
5702
5830
  # `PASSWORD_CLAIM_SECRET_BLOCK`, `TIMESTAMP`, `USERNAME`.
5703
5831
  #
5704
- # <note markdown="1"> `PASSWORD_VERIFIER` requires `DEVICE_KEY` when signing in with a
5832
+ # <note markdown="1"> `PASSWORD_VERIFIER` requires `DEVICE_KEY` when you sign in with a
5705
5833
  # remembered device.
5706
5834
  #
5707
5835
  # </note>
5708
5836
  #
5709
- # * `NEW_PASSWORD_REQUIRED`\: `NEW_PASSWORD`, any other required
5710
- # attributes, `USERNAME`.
5837
+ # * `NEW_PASSWORD_REQUIRED`\: `NEW_PASSWORD`, `USERNAME`, `SECRET_HASH`
5838
+ # (if app client is configured with client secret). To set any
5839
+ # required attributes that Amazon Cognito returned as
5840
+ # `requiredAttributes` in the `InitiateAuth` response, add a
5841
+ # `userAttributes.attributename ` parameter. This parameter can also
5842
+ # set values for writable attributes that aren't required by your
5843
+ # user pool.
5844
+ #
5845
+ # <note markdown="1"> In a `NEW_PASSWORD_REQUIRED` challenge response, you can't modify a
5846
+ # required attribute that already has a value. In
5847
+ # `RespondToAuthChallenge`, set a value for any keys that Amazon
5848
+ # Cognito returned in the `requiredAttributes` parameter, then use the
5849
+ # `UpdateUserAttributes` API operation to modify the value of any
5850
+ # additional attributes.
5851
+ #
5852
+ # </note>
5711
5853
  #
5712
5854
  # * `SOFTWARE_TOKEN_MFA`\: `USERNAME` and `SOFTWARE_TOKEN_MFA_CODE` are
5713
5855
  # required attributes.
@@ -5722,8 +5864,8 @@ module Aws::CognitoIdentityProvider
5722
5864
  # returned by `VerifySoftwareToken` in the `Session` parameter.
5723
5865
  #
5724
5866
  # @option params [Types::AnalyticsMetadataType] :analytics_metadata
5725
- # The Amazon Pinpoint analytics metadata for collecting metrics for
5726
- # `RespondToAuthChallenge` calls.
5867
+ # The Amazon Pinpoint analytics metadata that contributes to your
5868
+ # metrics for `RespondToAuthChallenge` calls.
5727
5869
  #
5728
5870
  # @option params [Types::UserContextDataType] :user_context_data
5729
5871
  # Contextual data such as the user's device fingerprint, IP address, or
@@ -5747,8 +5889,8 @@ module Aws::CognitoIdentityProvider
5747
5889
  # `clientMetadata` value to enhance your workflow for your specific
5748
5890
  # needs.
5749
5891
  #
5750
- # For more information, see [Customizing User Pool Workflows with Lambda
5751
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
5892
+ # For more information, see [ Customizing user pool Workflows with
5893
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
5752
5894
  #
5753
5895
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
5754
5896
  # Cognito won't do the following:
@@ -6056,7 +6198,8 @@ module Aws::CognitoIdentityProvider
6056
6198
  # The time-based one-time password software token MFA settings.
6057
6199
  #
6058
6200
  # @option params [required, String] :access_token
6059
- # The access token for the user.
6201
+ # A valid access token that Amazon Cognito issued to the user whose MFA
6202
+ # preference you want to set.
6060
6203
  #
6061
6204
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
6062
6205
  #
@@ -6087,22 +6230,22 @@ module Aws::CognitoIdentityProvider
6087
6230
  #
6088
6231
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
6089
6232
  # US telecom carriers require you to register an origination phone
6090
- # number before you can send SMS messages to U.S. phone numbers. If you
6233
+ # number before you can send SMS messages to US phone numbers. If you
6091
6234
  # use SMS text messages in Amazon Cognito, you must register a phone
6092
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
6093
- # registered number automatically. Otherwise, Amazon Cognito users that
6094
- # must receive SMS messages might be unable to sign up, activate their
6095
- # accounts, or sign in.
6235
+ # number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
6236
+ # number automatically. Otherwise, Amazon Cognito users who must receive
6237
+ # SMS messages might not be able to sign up, activate their accounts, or
6238
+ # sign in.
6096
6239
  #
6097
6240
  # If you have never used SMS text messages with Amazon Cognito or any
6098
6241
  # other Amazon Web Service, Amazon Simple Notification Service might
6099
- # place your account in SMS sandbox. In <i> <a
6242
+ # place your account in the SMS sandbox. In <i> <a
6100
6243
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
6101
- # mode</a> </i>, you will have limitations, such as sending messages
6102
- # only to verified phone numbers. After testing in the sandbox
6103
- # environment, you can move out of the SMS sandbox and into production.
6104
- # For more information, see [ SMS message settings for Amazon Cognito
6105
- # User Pools][2] in the *Amazon Cognito Developer Guide*.
6244
+ # mode</a> </i>, you can send messages only to verified phone numbers.
6245
+ # After you test your app while in the sandbox environment, you can move
6246
+ # out of the sandbox and into production. For more information, see [
6247
+ # SMS message settings for Amazon Cognito user pools][2] in the *Amazon
6248
+ # Cognito Developer Guide*.
6106
6249
  #
6107
6250
  # </note>
6108
6251
  #
@@ -6122,9 +6265,9 @@ module Aws::CognitoIdentityProvider
6122
6265
  #
6123
6266
  # @option params [String] :mfa_configuration
6124
6267
  # The MFA configuration. If you set the MfaConfiguration value to ‘ON’,
6125
- # only users with an MFA factor set up can sign in. To learn more, see
6126
- # [Adding Multi-Factor Authentication (MFA) to a User
6127
- # Pool](cognito/latest/developerguide/user-pool-settings-mfa.html).
6268
+ # only users who have set up an MFA factor can sign in. To learn more,
6269
+ # see [Adding Multi-Factor Authentication (MFA) to a user
6270
+ # pool](cognito/latest/developerguide/user-pool-settings-mfa.html).
6128
6271
  # Valid values include:
6129
6272
  #
6130
6273
  # * `OFF` MFA won't be used for any users.
@@ -6149,6 +6292,7 @@ module Aws::CognitoIdentityProvider
6149
6292
  # sms_configuration: {
6150
6293
  # sns_caller_arn: "ArnType", # required
6151
6294
  # external_id: "StringType",
6295
+ # sns_region: "RegionCodeType",
6152
6296
  # },
6153
6297
  # },
6154
6298
  # software_token_mfa_configuration: {
@@ -6162,6 +6306,7 @@ module Aws::CognitoIdentityProvider
6162
6306
  # resp.sms_mfa_configuration.sms_authentication_message #=> String
6163
6307
  # resp.sms_mfa_configuration.sms_configuration.sns_caller_arn #=> String
6164
6308
  # resp.sms_mfa_configuration.sms_configuration.external_id #=> String
6309
+ # resp.sms_mfa_configuration.sms_configuration.sns_region #=> String
6165
6310
  # resp.software_token_mfa_configuration.enabled #=> Boolean
6166
6311
  # resp.mfa_configuration #=> String, one of "OFF", "ON", "OPTIONAL"
6167
6312
  #
@@ -6184,7 +6329,8 @@ module Aws::CognitoIdentityProvider
6184
6329
  # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserMFAPreference.html
6185
6330
  #
6186
6331
  # @option params [required, String] :access_token
6187
- # The access token for the set user settings request.
6332
+ # A valid access token that Amazon Cognito issued to the user whose user
6333
+ # settings you want to configure.
6188
6334
  #
6189
6335
  # @option params [required, Array<Types::MFAOptionType>] :mfa_options
6190
6336
  # You can use this parameter only to set an SMS configuration that uses
@@ -6218,22 +6364,22 @@ module Aws::CognitoIdentityProvider
6218
6364
  #
6219
6365
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
6220
6366
  # US telecom carriers require you to register an origination phone
6221
- # number before you can send SMS messages to U.S. phone numbers. If you
6367
+ # number before you can send SMS messages to US phone numbers. If you
6222
6368
  # use SMS text messages in Amazon Cognito, you must register a phone
6223
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
6224
- # registered number automatically. Otherwise, Amazon Cognito users that
6225
- # must receive SMS messages might be unable to sign up, activate their
6226
- # accounts, or sign in.
6369
+ # number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
6370
+ # number automatically. Otherwise, Amazon Cognito users who must receive
6371
+ # SMS messages might not be able to sign up, activate their accounts, or
6372
+ # sign in.
6227
6373
  #
6228
6374
  # If you have never used SMS text messages with Amazon Cognito or any
6229
6375
  # other Amazon Web Service, Amazon Simple Notification Service might
6230
- # place your account in SMS sandbox. In <i> <a
6376
+ # place your account in the SMS sandbox. In <i> <a
6231
6377
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
6232
- # mode</a> </i>, you will have limitations, such as sending messages
6233
- # only to verified phone numbers. After testing in the sandbox
6234
- # environment, you can move out of the SMS sandbox and into production.
6235
- # For more information, see [ SMS message settings for Amazon Cognito
6236
- # User Pools][2] in the *Amazon Cognito Developer Guide*.
6378
+ # mode</a> </i>, you can send messages only to verified phone numbers.
6379
+ # After you test your app while in the sandbox environment, you can move
6380
+ # out of the sandbox and into production. For more information, see [
6381
+ # SMS message settings for Amazon Cognito user pools][2] in the *Amazon
6382
+ # Cognito Developer Guide*.
6237
6383
  #
6238
6384
  # </note>
6239
6385
  #
@@ -6266,8 +6412,8 @@ module Aws::CognitoIdentityProvider
6266
6412
  # The validation data in the request to register a user.
6267
6413
  #
6268
6414
  # @option params [Types::AnalyticsMetadataType] :analytics_metadata
6269
- # The Amazon Pinpoint analytics metadata for collecting metrics for
6270
- # `SignUp` calls.
6415
+ # The Amazon Pinpoint analytics metadata that contributes to your
6416
+ # metrics for `SignUp` calls.
6271
6417
  #
6272
6418
  # @option params [Types::UserContextDataType] :user_context_data
6273
6419
  # Contextual data such as the user's device fingerprint, IP address, or
@@ -6289,8 +6435,8 @@ module Aws::CognitoIdentityProvider
6289
6435
  # function code in Lambda, you can process the `clientMetadata` value to
6290
6436
  # enhance your workflow for your specific needs.
6291
6437
  #
6292
- # For more information, see [Customizing User Pool Workflows with Lambda
6293
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
6438
+ # For more information, see [ Customizing user pool Workflows with
6439
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
6294
6440
  #
6295
6441
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
6296
6442
  # Cognito won't do the following:
@@ -6572,7 +6718,8 @@ module Aws::CognitoIdentityProvider
6572
6718
  # Updates the device status.
6573
6719
  #
6574
6720
  # @option params [required, String] :access_token
6575
- # The access token.
6721
+ # A valid access token that Amazon Cognito issued to the user whose
6722
+ # device status you want to update.
6576
6723
  #
6577
6724
  # @option params [required, String] :device_key
6578
6725
  # The device key.
@@ -6658,23 +6805,23 @@ module Aws::CognitoIdentityProvider
6658
6805
  req.send_request(options)
6659
6806
  end
6660
6807
 
6661
- # Updates identity provider information for a user pool.
6808
+ # Updates IdP information for a user pool.
6662
6809
  #
6663
6810
  # @option params [required, String] :user_pool_id
6664
6811
  # The user pool ID.
6665
6812
  #
6666
6813
  # @option params [required, String] :provider_name
6667
- # The identity provider name.
6814
+ # The IdP name.
6668
6815
  #
6669
6816
  # @option params [Hash<String,String>] :provider_details
6670
- # The identity provider details to be updated, such as `MetadataURL` and
6817
+ # The IdP details to be updated, such as `MetadataURL` and
6671
6818
  # `MetadataFile`.
6672
6819
  #
6673
6820
  # @option params [Hash<String,String>] :attribute_mapping
6674
- # The identity provider attribute mapping to be changed.
6821
+ # The IdP attribute mapping to be changed.
6675
6822
  #
6676
6823
  # @option params [Array<String>] :idp_identifiers
6677
- # A list of identity provider identifiers.
6824
+ # A list of IdP identifiers.
6678
6825
  #
6679
6826
  # @return [Types::UpdateIdentityProviderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6680
6827
  #
@@ -6775,22 +6922,22 @@ module Aws::CognitoIdentityProvider
6775
6922
  #
6776
6923
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
6777
6924
  # US telecom carriers require you to register an origination phone
6778
- # number before you can send SMS messages to U.S. phone numbers. If you
6925
+ # number before you can send SMS messages to US phone numbers. If you
6779
6926
  # use SMS text messages in Amazon Cognito, you must register a phone
6780
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
6781
- # registered number automatically. Otherwise, Amazon Cognito users that
6782
- # must receive SMS messages might be unable to sign up, activate their
6783
- # accounts, or sign in.
6927
+ # number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
6928
+ # number automatically. Otherwise, Amazon Cognito users who must receive
6929
+ # SMS messages might not be able to sign up, activate their accounts, or
6930
+ # sign in.
6784
6931
  #
6785
6932
  # If you have never used SMS text messages with Amazon Cognito or any
6786
6933
  # other Amazon Web Service, Amazon Simple Notification Service might
6787
- # place your account in SMS sandbox. In <i> <a
6934
+ # place your account in the SMS sandbox. In <i> <a
6788
6935
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
6789
- # mode</a> </i>, you will have limitations, such as sending messages
6790
- # only to verified phone numbers. After testing in the sandbox
6791
- # environment, you can move out of the SMS sandbox and into production.
6792
- # For more information, see [ SMS message settings for Amazon Cognito
6793
- # User Pools][2] in the *Amazon Cognito Developer Guide*.
6936
+ # mode</a> </i>, you can send messages only to verified phone numbers.
6937
+ # After you test your app while in the sandbox environment, you can move
6938
+ # out of the sandbox and into production. For more information, see [
6939
+ # SMS message settings for Amazon Cognito user pools][2] in the *Amazon
6940
+ # Cognito Developer Guide*.
6794
6941
  #
6795
6942
  # </note>
6796
6943
  #
@@ -6805,8 +6952,16 @@ module Aws::CognitoIdentityProvider
6805
6952
  # For custom attributes, you must prepend the `custom:` prefix to the
6806
6953
  # attribute name.
6807
6954
  #
6955
+ # If you have set an attribute to require verification before Amazon
6956
+ # Cognito updates its value, this request doesn’t immediately update the
6957
+ # value of that attribute. After your user receives and responds to a
6958
+ # verification message to verify the new value, Amazon Cognito updates
6959
+ # the attribute value. Your user can sign in and receive messages with
6960
+ # the original attribute value until they verify the new value.
6961
+ #
6808
6962
  # @option params [required, String] :access_token
6809
- # The access token for the request to update user attributes.
6963
+ # A valid access token that Amazon Cognito issued to the user whose user
6964
+ # attributes you want to update.
6810
6965
  #
6811
6966
  # @option params [Hash<String,String>] :client_metadata
6812
6967
  # A map of custom key-value pairs that you can provide as input for any
@@ -6822,8 +6977,8 @@ module Aws::CognitoIdentityProvider
6822
6977
  # In your function code in Lambda, you can process the `clientMetadata`
6823
6978
  # value to enhance your workflow for your specific needs.
6824
6979
  #
6825
- # For more information, see [Customizing User Pool Workflows with Lambda
6826
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
6980
+ # For more information, see [ Customizing user pool Workflows with
6981
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
6827
6982
  #
6828
6983
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
6829
6984
  # Cognito won't do the following:
@@ -6886,22 +7041,22 @@ module Aws::CognitoIdentityProvider
6886
7041
  #
6887
7042
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
6888
7043
  # US telecom carriers require you to register an origination phone
6889
- # number before you can send SMS messages to U.S. phone numbers. If you
7044
+ # number before you can send SMS messages to US phone numbers. If you
6890
7045
  # use SMS text messages in Amazon Cognito, you must register a phone
6891
- # number with [Amazon Pinpoint][2]. Amazon Cognito will use the
6892
- # registered number automatically. Otherwise, Amazon Cognito users that
6893
- # must receive SMS messages might be unable to sign up, activate their
6894
- # accounts, or sign in.
7046
+ # number with [Amazon Pinpoint][2]. Amazon Cognito uses the registered
7047
+ # number automatically. Otherwise, Amazon Cognito users who must receive
7048
+ # SMS messages might not be able to sign up, activate their accounts, or
7049
+ # sign in.
6895
7050
  #
6896
7051
  # If you have never used SMS text messages with Amazon Cognito or any
6897
7052
  # other Amazon Web Service, Amazon Simple Notification Service might
6898
- # place your account in SMS sandbox. In <i> <a
7053
+ # place your account in the SMS sandbox. In <i> <a
6899
7054
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
6900
- # mode</a> </i>, you will have limitations, such as sending messages
6901
- # only to verified phone numbers. After testing in the sandbox
6902
- # environment, you can move out of the SMS sandbox and into production.
6903
- # For more information, see [ SMS message settings for Amazon Cognito
6904
- # User Pools][3] in the *Amazon Cognito Developer Guide*.
7055
+ # mode</a> </i>, you can send messages only to verified phone numbers.
7056
+ # After you test your app while in the sandbox environment, you can move
7057
+ # out of the sandbox and into production. For more information, see [
7058
+ # SMS message settings for Amazon Cognito user pools][3] in the *Amazon
7059
+ # Cognito Developer Guide*.
6905
7060
  #
6906
7061
  # </note>
6907
7062
  #
@@ -6940,8 +7095,10 @@ module Aws::CognitoIdentityProvider
6940
7095
  # @option params [String] :sms_authentication_message
6941
7096
  # The contents of the SMS authentication message.
6942
7097
  #
7098
+ # @option params [Types::UserAttributeUpdateSettingsType] :user_attribute_update_settings
7099
+ #
6943
7100
  # @option params [String] :mfa_configuration
6944
- # Can be one of the following values:
7101
+ # Possible values include:
6945
7102
  #
6946
7103
  # * `OFF` - MFA tokens aren't required and can't be specified during
6947
7104
  # user registration.
@@ -6962,10 +7119,18 @@ module Aws::CognitoIdentityProvider
6962
7119
  # Device configuration.
6963
7120
  #
6964
7121
  # @option params [Types::EmailConfigurationType] :email_configuration
6965
- # Email configuration.
7122
+ # The email configuration of your user pool. The email configuration
7123
+ # type sets your preferred sending method, Amazon Web Services Region,
7124
+ # and sender for email invitation and verification messages from your
7125
+ # user pool.
6966
7126
  #
6967
7127
  # @option params [Types::SmsConfigurationType] :sms_configuration
6968
- # SMS configuration.
7128
+ # The SMS configuration with the settings that your Amazon Cognito user
7129
+ # pool must use to send an SMS message from your Amazon Web Services
7130
+ # account through Amazon Simple Notification Service. To send SMS
7131
+ # messages with Amazon SNS in the Amazon Web Services Region that you
7132
+ # want, the Amazon Cognito user pool uses an Identity and Access
7133
+ # Management (IAM) role in your Amazon Web Services account.
6969
7134
  #
6970
7135
  # @option params [Hash<String,String>] :user_pool_tags
6971
7136
  # The tag keys and values to assign to the user pool. A tag is a label
@@ -7039,6 +7204,9 @@ module Aws::CognitoIdentityProvider
7039
7204
  # default_email_option: "CONFIRM_WITH_LINK", # accepts CONFIRM_WITH_LINK, CONFIRM_WITH_CODE
7040
7205
  # },
7041
7206
  # sms_authentication_message: "SmsVerificationMessageType",
7207
+ # user_attribute_update_settings: {
7208
+ # attributes_require_verification_before_update: ["phone_number"], # accepts phone_number, email
7209
+ # },
7042
7210
  # mfa_configuration: "OFF", # accepts OFF, ON, OPTIONAL
7043
7211
  # device_configuration: {
7044
7212
  # challenge_required_on_new_device: false,
@@ -7054,6 +7222,7 @@ module Aws::CognitoIdentityProvider
7054
7222
  # sms_configuration: {
7055
7223
  # sns_caller_arn: "ArnType", # required
7056
7224
  # external_id: "StringType",
7225
+ # sns_region: "RegionCodeType",
7057
7226
  # },
7058
7227
  # user_pool_tags: {
7059
7228
  # "TagKeysType" => "TagValueType",
@@ -7116,20 +7285,50 @@ module Aws::CognitoIdentityProvider
7116
7285
  # The client name from the update user pool client request.
7117
7286
  #
7118
7287
  # @option params [Integer] :refresh_token_validity
7119
- # The time limit, in days, after which the refresh token is no longer
7120
- # valid and can't be used.
7288
+ # The refresh token time limit. After this limit expires, your user
7289
+ # can't use their refresh token. To specify the time unit for
7290
+ # `RefreshTokenValidity` as `seconds`, `minutes`, `hours`, or `days`,
7291
+ # set a `TokenValidityUnits` value in your API request.
7292
+ #
7293
+ # For example, when you set `RefreshTokenValidity` as `10` and
7294
+ # `TokenValidityUnits` as `days`, your user can refresh their session
7295
+ # and retrieve new access and ID tokens for 10 days.
7296
+ #
7297
+ # The default time unit for `RefreshTokenValidity` in an API request is
7298
+ # days. You can't set `RefreshTokenValidity` to 0. If you do, Amazon
7299
+ # Cognito overrides the value with the default value of 30 days. *Valid
7300
+ # range* is displayed below in seconds.
7121
7301
  #
7122
7302
  # @option params [Integer] :access_token_validity
7123
- # The time limit after which the access token is no longer valid and
7124
- # can't be used.
7303
+ # The access token time limit. After this limit expires, your user
7304
+ # can't use their access token. To specify the time unit for
7305
+ # `AccessTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set
7306
+ # a `TokenValidityUnits` value in your API request.
7307
+ #
7308
+ # For example, when you set `AccessTokenValidity` to `10` and
7309
+ # `TokenValidityUnits` to `hours`, your user can authorize access with
7310
+ # their access token for 10 hours.
7311
+ #
7312
+ # The default time unit for `AccessTokenValidity` in an API request is
7313
+ # hours. *Valid range* is displayed below in seconds.
7125
7314
  #
7126
7315
  # @option params [Integer] :id_token_validity
7127
- # The time limit after which the ID token is no longer valid and can't
7128
- # be used.
7316
+ # The ID token time limit. After this limit expires, your user can't
7317
+ # use their ID token. To specify the time unit for `IdTokenValidity` as
7318
+ # `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits`
7319
+ # value in your API request.
7320
+ #
7321
+ # For example, when you set `IdTokenValidity` as `10` and
7322
+ # `TokenValidityUnits` as `hours`, your user can authenticate their
7323
+ # session with their ID token for 10 hours.
7324
+ #
7325
+ # The default time unit for `AccessTokenValidity` in an API request is
7326
+ # hours. *Valid range* is displayed below in seconds.
7129
7327
  #
7130
7328
  # @option params [Types::TokenValidityUnitsType] :token_validity_units
7131
- # The units in which the validity times are represented. Default for
7132
- # RefreshToken is days, and default for ID and access tokens is hours.
7329
+ # The units in which the validity times are represented. The default
7330
+ # unit for RefreshToken is days, and the default for ID and access
7331
+ # tokens is hours.
7133
7332
  #
7134
7333
  # @option params [Array<String>] :read_attributes
7135
7334
  # The read-only attributes of the user pool.
@@ -7164,11 +7363,12 @@ module Aws::CognitoIdentityProvider
7164
7363
  # * `ALLOW_REFRESH_TOKEN_AUTH`\: Enable authflow to refresh tokens.
7165
7364
  #
7166
7365
  # @option params [Array<String>] :supported_identity_providers
7167
- # A list of provider names for the identity providers that are supported
7168
- # on this client.
7366
+ # A list of provider names for the IdPs that this client supports. The
7367
+ # following are supported: `COGNITO`, `Facebook`, `Google`
7368
+ # `LoginWithAmazon`, and the names of your own SAML and OIDC providers.
7169
7369
  #
7170
7370
  # @option params [Array<String>] :callback_urls
7171
- # A list of allowed redirect (callback) URLs for the identity providers.
7371
+ # A list of allowed redirect (callback) URLs for the IdPs.
7172
7372
  #
7173
7373
  # A redirect URI must:
7174
7374
  #
@@ -7190,7 +7390,7 @@ module Aws::CognitoIdentityProvider
7190
7390
  # [1]: https://tools.ietf.org/html/rfc6749#section-3.1.2
7191
7391
  #
7192
7392
  # @option params [Array<String>] :logout_urls
7193
- # A list of allowed logout URLs for the identity providers.
7393
+ # A list of allowed logout URLs for the IdPs.
7194
7394
  #
7195
7395
  # @option params [String] :default_redirect_uri
7196
7396
  # The default redirect URI. Must be in the `CallbackURLs` list.
@@ -7217,35 +7417,42 @@ module Aws::CognitoIdentityProvider
7217
7417
  # @option params [Array<String>] :allowed_o_auth_flows
7218
7418
  # The allowed OAuth flows.
7219
7419
  #
7220
- # Set to `code` to initiate a code grant flow, which provides an
7221
- # authorization code as the response. This code can be exchanged for
7222
- # access tokens with the token endpoint.
7420
+ # code
7421
+ #
7422
+ # : Use a code grant flow, which provides an authorization code as the
7423
+ # response. This code can be exchanged for access tokens with the
7424
+ # `/oauth2/token` endpoint.
7425
+ #
7426
+ # implicit
7427
+ #
7428
+ # : Issue the access token (and, optionally, ID token, based on scopes)
7429
+ # directly to your user.
7223
7430
  #
7224
- # Set to `implicit` to specify that the client should get the access
7225
- # token (and, optionally, ID token, based on scopes) directly.
7431
+ # client\_credentials
7226
7432
  #
7227
- # Set to `client_credentials` to specify that the client should get the
7228
- # access token (and, optionally, ID token, based on scopes) from the
7229
- # token endpoint using a combination of client and client\_secret.
7433
+ # : Issue the access token from the `/oauth2/token` endpoint directly to
7434
+ # a non-person user using a combination of the client ID and client
7435
+ # secret.
7230
7436
  #
7231
7437
  # @option params [Array<String>] :allowed_o_auth_scopes
7232
- # The allowed OAuth scopes. Possible values provided by OAuth are:
7438
+ # The allowed OAuth scopes. Possible values provided by OAuth are
7233
7439
  # `phone`, `email`, `openid`, and `profile`. Possible values provided by
7234
- # Amazon Web Services are: `aws.cognito.signin.user.admin`. Custom
7235
- # scopes created in Resource Servers are also supported.
7440
+ # Amazon Web Services are `aws.cognito.signin.user.admin`. Custom scopes
7441
+ # created in Resource Servers are also supported.
7236
7442
  #
7237
7443
  # @option params [Boolean] :allowed_o_auth_flows_user_pool_client
7238
7444
  # Set to true if the client is allowed to follow the OAuth protocol when
7239
7445
  # interacting with Amazon Cognito user pools.
7240
7446
  #
7241
7447
  # @option params [Types::AnalyticsConfigurationType] :analytics_configuration
7242
- # The Amazon Pinpoint analytics configuration for collecting metrics for
7243
- # this user pool.
7448
+ # The Amazon Pinpoint analytics configuration necessary to collect
7449
+ # metrics for this user pool.
7244
7450
  #
7245
- # <note markdown="1"> In Amazon Web Services Regions where isn't available, User Pools only
7246
- # supports sending events to Amazon Pinpoint projects in us-east-1. In
7247
- # Regions where Pinpoint is available, User Pools will support sending
7248
- # events to Amazon Pinpoint projects within that same Region.
7451
+ # <note markdown="1"> In Amazon Web Services Regions where Amazon Pinpoint isn't available,
7452
+ # user pools only support sending events to Amazon Pinpoint projects in
7453
+ # us-east-1. In Regions where Amazon Pinpoint is available, user pools
7454
+ # support sending events to Amazon Pinpoint projects within that same
7455
+ # Region.
7249
7456
  #
7250
7457
  # </note>
7251
7458
  #
@@ -7449,7 +7656,8 @@ module Aws::CognitoIdentityProvider
7449
7656
  # session string, but not both.
7450
7657
  #
7451
7658
  # @option params [String] :access_token
7452
- # The access token.
7659
+ # A valid access token that Amazon Cognito issued to the user whose
7660
+ # software token you want to verify.
7453
7661
  #
7454
7662
  # @option params [String] :session
7455
7663
  # The session that should be passed both ways in challenge-response
@@ -7496,8 +7704,18 @@ module Aws::CognitoIdentityProvider
7496
7704
 
7497
7705
  # Verifies the specified user attributes in the user pool.
7498
7706
  #
7707
+ # If your user pool requires verification before Amazon Cognito updates
7708
+ # the attribute value, VerifyUserAttribute updates the affected
7709
+ # attribute to its pending value. For more information, see [
7710
+ # UserAttributeUpdateSettingsType][1].
7711
+ #
7712
+ #
7713
+ #
7714
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserAttributeUpdateSettingsType.html
7715
+ #
7499
7716
  # @option params [required, String] :access_token
7500
- # The access token of the request to verify user attributes.
7717
+ # A valid access token that Amazon Cognito issued to the user whose user
7718
+ # attributes you want to verify.
7501
7719
  #
7502
7720
  # @option params [required, String] :attribute_name
7503
7721
  # The attribute name in the request to verify user attributes.
@@ -7537,7 +7755,7 @@ module Aws::CognitoIdentityProvider
7537
7755
  params: params,
7538
7756
  config: config)
7539
7757
  context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
7540
- context[:gem_version] = '1.63.0'
7758
+ context[:gem_version] = '1.66.0'
7541
7759
  Seahorse::Client::Request.new(handlers, context)
7542
7760
  end
7543
7761