aws-sdk-cognitoidentityprovider 1.64.0 → 1.67.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -461,8 +461,8 @@ module Aws::CognitoIdentityProvider
461
461
  # can process the ClientMetadata value to enhance your workflow for your
462
462
  # specific needs.
463
463
  #
464
- # For more information, see [Customizing User Pool Workflows with Lambda
465
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
464
+ # For more information, see [ Customizing user pool Workflows with
465
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
466
466
  #
467
467
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
468
468
  # Cognito won't do the following:
@@ -511,22 +511,22 @@ module Aws::CognitoIdentityProvider
511
511
  #
512
512
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
513
513
  # US telecom carriers require you to register an origination phone
514
- # number before you can send SMS messages to U.S. phone numbers. If you
514
+ # number before you can send SMS messages to US phone numbers. If you
515
515
  # use SMS text messages in Amazon Cognito, you must register a phone
516
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
517
- # registered number automatically. Otherwise, Amazon Cognito users that
518
- # must receive SMS messages might be unable to sign up, activate their
519
- # 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.
520
520
  #
521
521
  # If you have never used SMS text messages with Amazon Cognito or any
522
522
  # other Amazon Web Service, Amazon Simple Notification Service might
523
- # place your account in SMS sandbox. In <i> <a
523
+ # place your account in the SMS sandbox. In <i> <a
524
524
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
525
- # mode</a> </i>, you will have limitations, such as sending messages
526
- # only to verified phone numbers. After testing in the sandbox
527
- # environment, you can move out of the SMS sandbox and into production.
528
- # For more information, see [ SMS message settings for Amazon Cognito
529
- # 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*.
530
530
  #
531
531
  # </note>
532
532
  #
@@ -663,8 +663,8 @@ module Aws::CognitoIdentityProvider
663
663
  # your function code in Lambda, you can process the `clientMetadata`
664
664
  # value to enhance your workflow for your specific needs.
665
665
  #
666
- # For more information, see [Customizing User Pool Workflows with Lambda
667
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
666
+ # For more information, see [ Customizing user pool Workflows with
667
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
668
668
  #
669
669
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
670
670
  # Cognito won't do the following:
@@ -805,14 +805,14 @@ module Aws::CognitoIdentityProvider
805
805
  req.send_request(options)
806
806
  end
807
807
 
808
- # Disables the user from signing in with the specified external (SAML or
809
- # social) identity provider. If the user to disable is a Amazon Cognito
810
- # User Pools native username + password user, they aren't permitted to
811
- # use their password to sign in. If the user to deactivate is a linked
812
- # external identity provider (IdP) user, any link between that user and
813
- # an existing user is removed. The next time the external user (no
814
- # longer attached to the previously linked `DestinationUser`) signs in,
815
- # 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
816
816
  # [AdminLinkProviderForUser][1].
817
817
  #
818
818
  # This action is enabled only for admin access and requires developer
@@ -827,9 +827,9 @@ module Aws::CognitoIdentityProvider
827
827
  # is used in the user pool for the user.
828
828
  #
829
829
  # The `ProviderAttributeName` must always be `Cognito_Subject` for
830
- # social identity providers. The `ProviderAttributeValue` must always be
831
- # the exact subject that was used when the user was originally linked as
832
- # 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.
833
833
  #
834
834
  # For de-linking a SAML identity, there are two scenarios. If the linked
835
835
  # identity has not yet been used to sign in, the `ProviderAttributeName`
@@ -1066,22 +1066,22 @@ module Aws::CognitoIdentityProvider
1066
1066
  #
1067
1067
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
1068
1068
  # US telecom carriers require you to register an origination phone
1069
- # number before you can send SMS messages to U.S. phone numbers. If you
1069
+ # number before you can send SMS messages to US phone numbers. If you
1070
1070
  # use SMS text messages in Amazon Cognito, you must register a phone
1071
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
1072
- # registered number automatically. Otherwise, Amazon Cognito users that
1073
- # must receive SMS messages might be unable to sign up, activate their
1074
- # 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.
1075
1075
  #
1076
1076
  # If you have never used SMS text messages with Amazon Cognito or any
1077
1077
  # other Amazon Web Service, Amazon Simple Notification Service might
1078
- # place your account in SMS sandbox. In <i> <a
1078
+ # place your account in the SMS sandbox. In <i> <a
1079
1079
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
1080
- # mode</a> </i>, you will have limitations, such as sending messages
1081
- # only to verified phone numbers. After testing in the sandbox
1082
- # environment, you can move out of the SMS sandbox and into production.
1083
- # For more information, see [ SMS message settings for Amazon Cognito
1084
- # 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*.
1085
1085
  #
1086
1086
  # </note>
1087
1087
  #
@@ -1194,8 +1194,8 @@ module Aws::CognitoIdentityProvider
1194
1194
  #
1195
1195
  # * Verify auth challenge
1196
1196
  #
1197
- # For more information, see [Customizing User Pool Workflows with Lambda
1198
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
1197
+ # For more information, see [ Customizing user pool Workflows with
1198
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
1199
1199
  #
1200
1200
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
1201
1201
  # Cognito won't do the following:
@@ -1221,9 +1221,11 @@ module Aws::CognitoIdentityProvider
1221
1221
  # `AdminInitiateAuth` calls.
1222
1222
  #
1223
1223
  # @option params [Types::ContextDataType] :context_data
1224
- # Contextual data such as the user's device fingerprint, IP address, or
1225
- # location used for evaluating the risk of an unexpected event by Amazon
1226
- # Cognito advanced security.
1224
+ # Contextual data about your user session, such as the device
1225
+ # fingerprint, IP address, or location. Amazon Cognito advanced security
1226
+ # evaluates the risk of an authentication event based on the context
1227
+ # that your app generates and passes to Amazon Cognito when it makes API
1228
+ # requests.
1227
1229
  #
1228
1230
  # @return [Types::AdminInitiateAuthResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1229
1231
  #
@@ -1285,26 +1287,25 @@ module Aws::CognitoIdentityProvider
1285
1287
  end
1286
1288
 
1287
1289
  # Links an existing user account in a user pool (`DestinationUser`) to
1288
- # an identity from an external identity provider (`SourceUser`) based on
1289
- # a specified attribute name and value from the external identity
1290
- # provider. This allows you to create a link from the existing user
1291
- # account to an external federated user identity that has not yet been
1292
- # used to sign in. You can then use the federated user identity to sign
1293
- # in as the existing user account.
1290
+ # an identity from an external IdP (`SourceUser`) based on a specified
1291
+ # attribute name and value from the external IdP. This allows you to
1292
+ # create a link from the existing user account to an external federated
1293
+ # user identity that has not yet been used to sign in. You can then use
1294
+ # the federated user identity to sign in as the existing user account.
1294
1295
  #
1295
1296
  # For example, if there is an existing user with a username and
1296
1297
  # password, this API links that user to a federated user identity. When
1297
1298
  # the user signs in with a federated user identity, they sign in as the
1298
1299
  # existing user account.
1299
1300
  #
1300
- # <note markdown="1"> The maximum number of federated identities linked to a user is 5.
1301
+ # <note markdown="1"> The maximum number of federated identities linked to a user is five.
1301
1302
  #
1302
1303
  # </note>
1303
1304
  #
1304
1305
  # Because this API allows a user with an external federated identity to
1305
1306
  # sign in as an existing user in the user pool, it is critical that it
1306
- # only be used with external identity providers and provider attributes
1307
- # that have been trusted by the application owner.
1307
+ # only be used with external IdPs and provider attributes that have been
1308
+ # trusted by the application owner.
1308
1309
  #
1309
1310
  # This action is administrative and requires developer credentials.
1310
1311
  #
@@ -1312,12 +1313,12 @@ module Aws::CognitoIdentityProvider
1312
1313
  # The user pool ID for the user pool.
1313
1314
  #
1314
1315
  # @option params [required, Types::ProviderUserIdentifierType] :destination_user
1315
- # The existing user in the user pool to be linked to the external
1316
- # identity provider user account. Can be a native (Username + Password)
1317
- # Amazon Cognito User Pools user or a federated user (for example, a
1318
- # SAML or Facebook user). If the user doesn't exist, an exception is
1319
- # thrown. This is the user that is returned when the new user (with the
1320
- # linked identity provider attribute) signs in.
1316
+ # The existing user in the user pool that you want to assign to the
1317
+ # external IdP user account. This user can be a native (Username +
1318
+ # Password) Amazon Cognito user pools user or a federated user (for
1319
+ # example, a SAML or Facebook user). If the user doesn't exist, Amazon
1320
+ # Cognito generates an exception. Amazon Cognito returns this user when
1321
+ # the new user (with the linked IdP attribute) signs in.
1321
1322
  #
1322
1323
  # For a native username + password user, the `ProviderAttributeValue`
1323
1324
  # for the `DestinationUser` should be the username in the user pool. For
@@ -1333,27 +1334,26 @@ module Aws::CognitoIdentityProvider
1333
1334
  # won't succeed.
1334
1335
  #
1335
1336
  # @option params [required, Types::ProviderUserIdentifierType] :source_user
1336
- # An external identity provider account for a user who doesn't exist
1337
- # yet in the user pool. This user must be a federated user (for example,
1338
- # a SAML or Facebook user), not another native user.
1337
+ # An external IdP account for a user who doesn't exist yet in the user
1338
+ # pool. This user must be a federated user (for example, a SAML or
1339
+ # Facebook user), not another native user.
1339
1340
  #
1340
- # If the `SourceUser` is using a federated social identity provider,
1341
- # such as Facebook, Google, or Login with Amazon, you must set the
1342
- # `ProviderAttributeName` to `Cognito_Subject`. For social identity
1343
- # providers, the `ProviderName` will be `Facebook`, `Google`, or
1344
- # `LoginWithAmazon`, and Amazon Cognito will automatically parse the
1345
- # Facebook, Google, and Login with Amazon tokens for `id`, `sub`, and
1346
- # `user_id`, respectively. The `ProviderAttributeValue` for the user
1347
- # must be the same value as the `id`, `sub`, or `user_id` value found in
1348
- # the social identity provider token.
1341
+ # If the `SourceUser` is using a federated social IdP, such as Facebook,
1342
+ # Google, or Login with Amazon, you must set the `ProviderAttributeName`
1343
+ # to `Cognito_Subject`. For social IdPs, the `ProviderName` will be
1344
+ # `Facebook`, `Google`, or `LoginWithAmazon`, and Amazon Cognito will
1345
+ # automatically parse the Facebook, Google, and Login with Amazon tokens
1346
+ # for `id`, `sub`, and `user_id`, respectively. The
1347
+ # `ProviderAttributeValue` for the user must be the same value as the
1348
+ # `id`, `sub`, or `user_id` value found in the social IdP token.
1349
1349
  #
1350
1350
  #
1351
1351
  #
1352
1352
  # For SAML, the `ProviderAttributeName` can be any value that matches a
1353
1353
  # claim in the SAML assertion. If you want to link SAML users based on
1354
1354
  # the subject of the SAML assertion, you should map the subject to a
1355
- # claim through the SAML identity provider and submit that claim name as
1356
- # the `ProviderAttributeName`. If you set `ProviderAttributeName` to
1355
+ # claim through the SAML IdP and submit that claim name as the
1356
+ # `ProviderAttributeName`. If you set `ProviderAttributeName` to
1357
1357
  # `Cognito_Subject`, Amazon Cognito will automatically parse the default
1358
1358
  # unique identifier found in the subject from the SAML token.
1359
1359
  #
@@ -1601,22 +1601,22 @@ module Aws::CognitoIdentityProvider
1601
1601
  #
1602
1602
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
1603
1603
  # US telecom carriers require you to register an origination phone
1604
- # number before you can send SMS messages to U.S. phone numbers. If you
1604
+ # number before you can send SMS messages to US phone numbers. If you
1605
1605
  # use SMS text messages in Amazon Cognito, you must register a phone
1606
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
1607
- # registered number automatically. Otherwise, Amazon Cognito users that
1608
- # must receive SMS messages might be unable to sign up, activate their
1609
- # accounts, or sign in.
1606
+ # number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
1607
+ # number automatically. Otherwise, Amazon Cognito users who must receive
1608
+ # SMS messages might not be able to sign up, activate their accounts, or
1609
+ # sign in.
1610
1610
  #
1611
1611
  # If you have never used SMS text messages with Amazon Cognito or any
1612
1612
  # other Amazon Web Service, Amazon Simple Notification Service might
1613
- # place your account in SMS sandbox. In <i> <a
1613
+ # place your account in the SMS sandbox. In <i> <a
1614
1614
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
1615
- # mode</a> </i>, you will have limitations, such as sending messages
1616
- # only to verified phone numbers. After testing in the sandbox
1617
- # environment, you can move out of the SMS sandbox and into production.
1618
- # For more information, see [ SMS message settings for Amazon Cognito
1619
- # User Pools][2] in the *Amazon Cognito Developer Guide*.
1615
+ # mode</a> </i>, you can send messages only to verified phone numbers.
1616
+ # After you test your app while in the sandbox environment, you can move
1617
+ # out of the sandbox and into production. For more information, see [
1618
+ # SMS message settings for Amazon Cognito user pools][2] in the *Amazon
1619
+ # Cognito Developer Guide*.
1620
1620
  #
1621
1621
  # </note>
1622
1622
  #
@@ -1649,8 +1649,8 @@ module Aws::CognitoIdentityProvider
1649
1649
  # `clientMetadata` value to enhance your workflow for your specific
1650
1650
  # needs.
1651
1651
  #
1652
- # For more information, see [Customizing User Pool Workflows with Lambda
1653
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
1652
+ # For more information, see [ Customizing user pool Workflows with
1653
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
1654
1654
  #
1655
1655
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
1656
1656
  # Cognito won't do the following:
@@ -1696,22 +1696,22 @@ module Aws::CognitoIdentityProvider
1696
1696
  #
1697
1697
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
1698
1698
  # US telecom carriers require you to register an origination phone
1699
- # number before you can send SMS messages to U.S. phone numbers. If you
1699
+ # number before you can send SMS messages to US phone numbers. If you
1700
1700
  # use SMS text messages in Amazon Cognito, you must register a phone
1701
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
1702
- # registered number automatically. Otherwise, Amazon Cognito users that
1703
- # must receive SMS messages might be unable to sign up, activate their
1704
- # accounts, or sign in.
1701
+ # number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
1702
+ # number automatically. Otherwise, Amazon Cognito users who must receive
1703
+ # SMS messages might not be able to sign up, activate their accounts, or
1704
+ # sign in.
1705
1705
  #
1706
1706
  # If you have never used SMS text messages with Amazon Cognito or any
1707
1707
  # other Amazon Web Service, Amazon Simple Notification Service might
1708
- # place your account in SMS sandbox. In <i> <a
1708
+ # place your account in the SMS sandbox. In <i> <a
1709
1709
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
1710
- # mode</a> </i>, you will have limitations, such as sending messages
1711
- # only to verified phone numbers. After testing in the sandbox
1712
- # environment, you can move out of the SMS sandbox and into production.
1713
- # For more information, see [ SMS message settings for Amazon Cognito
1714
- # User Pools][2] in the *Amazon Cognito Developer Guide*.
1710
+ # mode</a> </i>, you can send messages only to verified phone numbers.
1711
+ # After you test your app while in the sandbox environment, you can move
1712
+ # out of the sandbox and into production. For more information, see [
1713
+ # SMS message settings for Amazon Cognito user pools][2] in the *Amazon
1714
+ # Cognito Developer Guide*.
1715
1715
  #
1716
1716
  # </note>
1717
1717
  #
@@ -1754,9 +1754,22 @@ module Aws::CognitoIdentityProvider
1754
1754
  # * `ADMIN_NO_SRP_AUTH`\: `PASSWORD`, `USERNAME`, `SECRET_HASH` (if app
1755
1755
  # client is configured with client secret).
1756
1756
  #
1757
- # * `NEW_PASSWORD_REQUIRED`\: `NEW_PASSWORD`, any other required
1758
- # attributes, `USERNAME`, `SECRET_HASH` (if app client is configured
1759
- # with client secret).
1757
+ # * `NEW_PASSWORD_REQUIRED`\: `NEW_PASSWORD`, `USERNAME`, `SECRET_HASH`
1758
+ # (if app client is configured with client secret). To set any
1759
+ # required attributes that Amazon Cognito returned as
1760
+ # `requiredAttributes` in the `AdminInitiateAuth` response, add a
1761
+ # `userAttributes.attributename ` parameter. This parameter can also
1762
+ # set values for writable attributes that aren't required by your
1763
+ # user pool.
1764
+ #
1765
+ # <note markdown="1"> In a `NEW_PASSWORD_REQUIRED` challenge response, you can't modify a
1766
+ # required attribute that already has a value. In
1767
+ # `AdminRespondToAuthChallenge`, set a value for any keys that Amazon
1768
+ # Cognito returned in the `requiredAttributes` parameter, then use the
1769
+ # `AdminUpdateUserAttributes` API operation to modify the value of any
1770
+ # additional attributes.
1771
+ #
1772
+ # </note>
1760
1773
  #
1761
1774
  # * `MFA_SETUP` requires `USERNAME`, plus you must use the session value
1762
1775
  # returned by `VerifySoftwareToken` in the `Session` parameter.
@@ -1780,9 +1793,11 @@ module Aws::CognitoIdentityProvider
1780
1793
  # `AdminRespondToAuthChallenge` calls.
1781
1794
  #
1782
1795
  # @option params [Types::ContextDataType] :context_data
1783
- # Contextual data such as the user's device fingerprint, IP address, or
1784
- # location used for evaluating the risk of an unexpected event by Amazon
1785
- # Cognito advanced security.
1796
+ # Contextual data about your user session, such as the device
1797
+ # fingerprint, IP address, or location. Amazon Cognito advanced security
1798
+ # evaluates the risk of an authentication event based on the context
1799
+ # that your app generates and passes to Amazon Cognito when it makes API
1800
+ # requests.
1786
1801
  #
1787
1802
  # @option params [Hash<String,String>] :client_metadata
1788
1803
  # A map of custom key-value pairs that you can provide as input for any
@@ -1790,20 +1805,35 @@ module Aws::CognitoIdentityProvider
1790
1805
  #
1791
1806
  # You create custom workflows by assigning Lambda functions to user pool
1792
1807
  # triggers. When you use the AdminRespondToAuthChallenge API action,
1793
- # Amazon Cognito invokes any functions that are assigned to the
1794
- # following triggers: *pre sign-up*, *custom message*, *post
1795
- # authentication*, *user migration*, *pre token generation*, *define
1796
- # auth challenge*, *create auth challenge*, and *verify auth challenge
1797
- # response*. When Amazon Cognito invokes any of these functions, it
1798
- # passes a JSON payload, which the function receives as input. This
1799
- # payload contains a `clientMetadata` attribute, which provides the data
1800
- # that you assigned to the ClientMetadata parameter in your
1801
- # AdminRespondToAuthChallenge request. In your function code in Lambda,
1802
- # you can process the `clientMetadata` value to enhance your workflow
1803
- # for your specific needs.
1808
+ # Amazon Cognito invokes any functions that you have assigned to the
1809
+ # following triggers:
1810
+ #
1811
+ # * pre sign-up
1812
+ #
1813
+ # * custom message
1814
+ #
1815
+ # * post authentication
1816
+ #
1817
+ # * user migration
1818
+ #
1819
+ # * pre token generation
1804
1820
  #
1805
- # For more information, see [Customizing User Pool Workflows with Lambda
1806
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
1821
+ # * define auth challenge
1822
+ #
1823
+ # * create auth challenge
1824
+ #
1825
+ # * verify auth challenge response
1826
+ #
1827
+ # When Amazon Cognito invokes any of these functions, it passes a JSON
1828
+ # payload, which the function receives as input. This payload contains a
1829
+ # `clientMetadata` attribute that provides the data that you assigned to
1830
+ # the ClientMetadata parameter in your AdminRespondToAuthChallenge
1831
+ # request. In your function code in Lambda, you can process the
1832
+ # `clientMetadata` value to enhance your workflow for your specific
1833
+ # needs.
1834
+ #
1835
+ # For more information, see [ Customizing user pool Workflows with
1836
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
1807
1837
  #
1808
1838
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
1809
1839
  # Cognito won't do the following:
@@ -2103,22 +2133,22 @@ module Aws::CognitoIdentityProvider
2103
2133
  #
2104
2134
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
2105
2135
  # US telecom carriers require you to register an origination phone
2106
- # number before you can send SMS messages to U.S. phone numbers. If you
2136
+ # number before you can send SMS messages to US phone numbers. If you
2107
2137
  # use SMS text messages in Amazon Cognito, you must register a phone
2108
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
2109
- # registered number automatically. Otherwise, Amazon Cognito users that
2110
- # must receive SMS messages might be unable to sign up, activate their
2111
- # accounts, or sign in.
2138
+ # number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
2139
+ # number automatically. Otherwise, Amazon Cognito users who must receive
2140
+ # SMS messages might not be able to sign up, activate their accounts, or
2141
+ # sign in.
2112
2142
  #
2113
2143
  # If you have never used SMS text messages with Amazon Cognito or any
2114
2144
  # other Amazon Web Service, Amazon Simple Notification Service might
2115
- # place your account in SMS sandbox. In <i> <a
2145
+ # place your account in the SMS sandbox. In <i> <a
2116
2146
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
2117
- # mode</a> </i>, you will have limitations, such as sending messages
2118
- # only to verified phone numbers. After testing in the sandbox
2119
- # environment, you can move out of the SMS sandbox and into production.
2120
- # For more information, see [ SMS message settings for Amazon Cognito
2121
- # User Pools][2] in the *Amazon Cognito Developer Guide*.
2147
+ # mode</a> </i>, you can send messages only to verified phone numbers.
2148
+ # After you test your app while in the sandbox environment, you can move
2149
+ # out of the sandbox and into production. For more information, see [
2150
+ # SMS message settings for Amazon Cognito user pools][2] in the *Amazon
2151
+ # Cognito Developer Guide*.
2122
2152
  #
2123
2153
  # </note>
2124
2154
  #
@@ -2142,6 +2172,21 @@ module Aws::CognitoIdentityProvider
2142
2172
  # For custom attributes, you must prepend the `custom:` prefix to the
2143
2173
  # attribute name.
2144
2174
  #
2175
+ # If your user pool requires verification before Amazon Cognito updates
2176
+ # an attribute value that you specify in this request, Amazon Cognito
2177
+ # doesn’t immediately update the value of that attribute. After your
2178
+ # user receives and responds to a verification message to verify the new
2179
+ # value, Amazon Cognito updates the attribute value. Your user can sign
2180
+ # in and receive messages with the original attribute value until they
2181
+ # verify the new value.
2182
+ #
2183
+ # To update the value of an attribute that requires verification in the
2184
+ # same API request, include the `email_verified` or
2185
+ # `phone_number_verified` attribute, with a value of `true`. If you set
2186
+ # the `email_verified` or `phone_number_verified` value for an `email`
2187
+ # or `phone_number` attribute that requires verification to `true`,
2188
+ # Amazon Cognito doesn’t send a verification message to your user.
2189
+ #
2145
2190
  # @option params [Hash<String,String>] :client_metadata
2146
2191
  # A map of custom key-value pairs that you can provide as input for any
2147
2192
  # custom workflows that this action triggers.
@@ -2157,8 +2202,8 @@ module Aws::CognitoIdentityProvider
2157
2202
  # you can process the `clientMetadata` value to enhance your workflow
2158
2203
  # for your specific needs.
2159
2204
  #
2160
- # For more information, see [Customizing User Pool Workflows with Lambda
2161
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
2205
+ # For more information, see [ Customizing user pool Workflows with
2206
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
2162
2207
  #
2163
2208
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
2164
2209
  # Cognito won't do the following:
@@ -2206,10 +2251,14 @@ module Aws::CognitoIdentityProvider
2206
2251
  req.send_request(options)
2207
2252
  end
2208
2253
 
2209
- # Signs out users from all devices, as an administrator. It also
2210
- # invalidates all refresh tokens issued to a user. The user's current
2211
- # access and Id tokens remain valid until their expiry. Access and Id
2212
- # tokens expire one hour after they're issued.
2254
+ # Signs out a user from all devices. You must sign
2255
+ # `AdminUserGlobalSignOut` requests with Amazon Web Services
2256
+ # credentials. It also invalidates all refresh tokens that Amazon
2257
+ # Cognito has issued to a user. The user's current access and ID tokens
2258
+ # remain valid until they expire. By default, access and ID tokens
2259
+ # expire one hour after they're issued. A user can still use a hosted
2260
+ # UI cookie to retrieve new tokens for the duration of the cookie
2261
+ # validity period of 1 hour.
2213
2262
  #
2214
2263
  # Calling this action requires developer credentials.
2215
2264
  #
@@ -2237,22 +2286,35 @@ module Aws::CognitoIdentityProvider
2237
2286
  req.send_request(options)
2238
2287
  end
2239
2288
 
2240
- # Returns a unique generated shared secret key code for the user
2241
- # account. The request takes an access token or a session string, but
2242
- # not both.
2243
- #
2244
- # <note markdown="1"> Calling AssociateSoftwareToken immediately disassociates the existing
2245
- # software token from the user account. If the user doesn't
2246
- # subsequently verify the software token, their account is set up to
2247
- # authenticate without MFA. If MFA config is set to Optional at the user
2248
- # pool level, the user can then log in without MFA. However, if MFA is
2249
- # set to Required for the user pool, the user is asked to set up a new
2250
- # software token MFA during sign-in.
2289
+ # Begins setup of time-based one-time password multi-factor
2290
+ # authentication (TOTP MFA) for a user, with a unique private key that
2291
+ # Amazon Cognito generates and returns in the API response. You can
2292
+ # authorize an `AssociateSoftwareToken` request with either the user's
2293
+ # access token, or a session string from a challenge response that you
2294
+ # received from Amazon Cognito.
2295
+ #
2296
+ # <note markdown="1"> Amazon Cognito disassociates an existing software token when you
2297
+ # verify the new token in a [ VerifySoftwareToken][1] API request. If
2298
+ # you don't verify the software token and your user pool doesn't
2299
+ # require MFA, the user can then authenticate with user name and
2300
+ # password credentials alone. If your user pool requires TOTP MFA,
2301
+ # Amazon Cognito generates an `MFA_SETUP` or `SOFTWARE_TOKEN_SETUP`
2302
+ # challenge each time your user signs. Complete setup with
2303
+ # `AssociateSoftwareToken` and `VerifySoftwareToken`.
2304
+ #
2305
+ # After you set up software token MFA for your user, Amazon Cognito
2306
+ # generates a `SOFTWARE_TOKEN_MFA` challenge when they authenticate.
2307
+ # Respond to this challenge with your user's TOTP.
2251
2308
  #
2252
2309
  # </note>
2253
2310
  #
2311
+ #
2312
+ #
2313
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifySoftwareToken.html
2314
+ #
2254
2315
  # @option params [String] :access_token
2255
- # The access token.
2316
+ # A valid access token that Amazon Cognito issued to the user whose
2317
+ # software token you want to generate.
2256
2318
  #
2257
2319
  # @option params [String] :session
2258
2320
  # The session that should be passed both ways in challenge-response
@@ -2294,7 +2356,8 @@ module Aws::CognitoIdentityProvider
2294
2356
  # The new password.
2295
2357
  #
2296
2358
  # @option params [required, String] :access_token
2297
- # The access token.
2359
+ # A valid access token that Amazon Cognito issued to the user whose
2360
+ # password you want to change.
2298
2361
  #
2299
2362
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2300
2363
  #
@@ -2319,7 +2382,8 @@ module Aws::CognitoIdentityProvider
2319
2382
  # device tracking.
2320
2383
  #
2321
2384
  # @option params [required, String] :access_token
2322
- # The access token.
2385
+ # A valid access token that Amazon Cognito issued to the user whose
2386
+ # device you want to confirm.
2323
2387
  #
2324
2388
  # @option params [required, String] :device_key
2325
2389
  # The device key.
@@ -2391,9 +2455,11 @@ module Aws::CognitoIdentityProvider
2391
2455
  # `ConfirmForgotPassword` calls.
2392
2456
  #
2393
2457
  # @option params [Types::UserContextDataType] :user_context_data
2394
- # Contextual data such as the user's device fingerprint, IP address, or
2395
- # location used for evaluating the risk of an unexpected event by Amazon
2396
- # Cognito advanced security.
2458
+ # Contextual data about your user session, such as the device
2459
+ # fingerprint, IP address, or location. Amazon Cognito advanced security
2460
+ # evaluates the risk of an authentication event based on the context
2461
+ # that your app generates and passes to Amazon Cognito when it makes API
2462
+ # requests.
2397
2463
  #
2398
2464
  # @option params [Hash<String,String>] :client_metadata
2399
2465
  # A map of custom key-value pairs that you can provide as input for any
@@ -2410,8 +2476,8 @@ module Aws::CognitoIdentityProvider
2410
2476
  # can process the `clientMetadata` value to enhance your workflow for
2411
2477
  # your specific needs.
2412
2478
  #
2413
- # For more information, see [Customizing User Pool Workflows with Lambda
2414
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
2479
+ # For more information, see [ Customizing user pool Workflows with
2480
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
2415
2481
  #
2416
2482
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
2417
2483
  # Cognito won't do the following:
@@ -2446,6 +2512,7 @@ module Aws::CognitoIdentityProvider
2446
2512
  # analytics_endpoint_id: "StringType",
2447
2513
  # },
2448
2514
  # user_context_data: {
2515
+ # ip_address: "StringType",
2449
2516
  # encoded_data: "StringType",
2450
2517
  # },
2451
2518
  # client_metadata: {
@@ -2462,8 +2529,7 @@ module Aws::CognitoIdentityProvider
2462
2529
  req.send_request(options)
2463
2530
  end
2464
2531
 
2465
- # Confirms registration of a user and handles the existing alias from a
2466
- # previous user.
2532
+ # Confirms registration of a new user.
2467
2533
  #
2468
2534
  # @option params [required, String] :client_id
2469
2535
  # The ID of the app client associated with the user pool.
@@ -2494,9 +2560,11 @@ module Aws::CognitoIdentityProvider
2494
2560
  # `ConfirmSignUp` calls.
2495
2561
  #
2496
2562
  # @option params [Types::UserContextDataType] :user_context_data
2497
- # Contextual data such as the user's device fingerprint, IP address, or
2498
- # location used for evaluating the risk of an unexpected event by Amazon
2499
- # Cognito advanced security.
2563
+ # Contextual data about your user session, such as the device
2564
+ # fingerprint, IP address, or location. Amazon Cognito advanced security
2565
+ # evaluates the risk of an authentication event based on the context
2566
+ # that your app generates and passes to Amazon Cognito when it makes API
2567
+ # requests.
2500
2568
  #
2501
2569
  # @option params [Hash<String,String>] :client_metadata
2502
2570
  # A map of custom key-value pairs that you can provide as input for any
@@ -2512,8 +2580,8 @@ module Aws::CognitoIdentityProvider
2512
2580
  # function code in Lambda, you can process the `clientMetadata` value to
2513
2581
  # enhance your workflow for your specific needs.
2514
2582
  #
2515
- # For more information, see [Customizing User Pool Workflows with Lambda
2516
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
2583
+ # For more information, see [ Customizing user pool Workflows with
2584
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
2517
2585
  #
2518
2586
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
2519
2587
  # Cognito won't do the following:
@@ -2548,6 +2616,7 @@ module Aws::CognitoIdentityProvider
2548
2616
  # analytics_endpoint_id: "StringType",
2549
2617
  # },
2550
2618
  # user_context_data: {
2619
+ # ip_address: "StringType",
2551
2620
  # encoded_data: "StringType",
2552
2621
  # },
2553
2622
  # client_metadata: {
@@ -2584,7 +2653,7 @@ module Aws::CognitoIdentityProvider
2584
2653
  # A non-negative integer value that specifies the precedence of this
2585
2654
  # group relative to the other groups that a user can belong to in the
2586
2655
  # user pool. Zero is the highest precedence value. Groups with lower
2587
- # `Precedence` values take precedence over groups with higher ornull
2656
+ # `Precedence` values take precedence over groups with higher or null
2588
2657
  # `Precedence` values. If a user belongs to two or more groups, it is
2589
2658
  # the group with the lowest precedence value whose role ARN is given in
2590
2659
  # the user's tokens for the `cognito:roles` and
@@ -2597,7 +2666,8 @@ module Aws::CognitoIdentityProvider
2597
2666
  # the two groups have different role ARNs, the `cognito:preferred_role`
2598
2667
  # claim isn't set in users' tokens.
2599
2668
  #
2600
- # The default `Precedence` value is null.
2669
+ # The default `Precedence` value is null. The maximum `Precedence` value
2670
+ # is `2^31-1`.
2601
2671
  #
2602
2672
  # @return [Types::CreateGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2603
2673
  #
@@ -2632,20 +2702,20 @@ module Aws::CognitoIdentityProvider
2632
2702
  req.send_request(options)
2633
2703
  end
2634
2704
 
2635
- # Creates an identity provider for a user pool.
2705
+ # Creates an IdP for a user pool.
2636
2706
  #
2637
2707
  # @option params [required, String] :user_pool_id
2638
2708
  # The user pool ID.
2639
2709
  #
2640
2710
  # @option params [required, String] :provider_name
2641
- # The identity provider name.
2711
+ # The IdP name.
2642
2712
  #
2643
2713
  # @option params [required, String] :provider_type
2644
- # The identity provider type.
2714
+ # The IdP type.
2645
2715
  #
2646
2716
  # @option params [required, Hash<String,String>] :provider_details
2647
- # The identity provider details. The following list describes the
2648
- # provider detail keys for each identity provider type.
2717
+ # The IdP details. The following list describes the provider detail keys
2718
+ # for each IdP type.
2649
2719
  #
2650
2720
  # * For Google and Login with Amazon:
2651
2721
  #
@@ -2689,33 +2759,36 @@ module Aws::CognitoIdentityProvider
2689
2759
  #
2690
2760
  # * authorize\_scopes
2691
2761
  #
2692
- # * authorize\_url *if not available from discovery URL specified by
2693
- # oidc\_issuer key*
2762
+ # * The following keys are only present if Amazon Cognito didn't
2763
+ # discover them at the `oidc_issuer` URL.
2764
+ #
2765
+ # * authorize\_url
2766
+ #
2767
+ # * token\_url
2694
2768
  #
2695
- # * token\_url *if not available from discovery URL specified by
2696
- # oidc\_issuer key*
2769
+ # * attributes\_url
2697
2770
  #
2698
- # * attributes\_url *if not available from discovery URL specified by
2699
- # oidc\_issuer key*
2771
+ # * jwks\_uri
2700
2772
  #
2701
- # * jwks\_uri *if not available from discovery URL specified by
2702
- # oidc\_issuer key*
2773
+ # * Amazon Cognito sets the value of the following keys automatically.
2774
+ # They are read-only.
2703
2775
  #
2704
- # * attributes\_url\_add\_attributes *a read-only property that is set
2705
- # automatically*
2776
+ # * attributes\_url\_add\_attributes
2777
+ #
2778
+ # ^
2706
2779
  #
2707
2780
  # * For SAML providers:
2708
2781
  #
2709
- # * MetadataFile OR MetadataURL
2782
+ # * MetadataFile or MetadataURL
2710
2783
  #
2711
- # * IDPSignout (optional)
2784
+ # * IDPSignout *optional*
2712
2785
  #
2713
2786
  # @option params [Hash<String,String>] :attribute_mapping
2714
- # A mapping of identity provider attributes to standard and custom user
2715
- # pool attributes.
2787
+ # A mapping of IdP attributes to standard and custom user pool
2788
+ # attributes.
2716
2789
  #
2717
2790
  # @option params [Array<String>] :idp_identifiers
2718
- # A list of identity provider identifiers.
2791
+ # A list of IdP identifiers.
2719
2792
  #
2720
2793
  # @return [Types::CreateIdentityProviderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2721
2794
  #
@@ -2868,22 +2941,22 @@ module Aws::CognitoIdentityProvider
2868
2941
  #
2869
2942
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
2870
2943
  # US telecom carriers require you to register an origination phone
2871
- # number before you can send SMS messages to U.S. phone numbers. If you
2944
+ # number before you can send SMS messages to US phone numbers. If you
2872
2945
  # use SMS text messages in Amazon Cognito, you must register a phone
2873
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
2874
- # registered number automatically. Otherwise, Amazon Cognito users that
2875
- # must receive SMS messages might be unable to sign up, activate their
2876
- # accounts, or sign in.
2946
+ # number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
2947
+ # number automatically. Otherwise, Amazon Cognito users who must receive
2948
+ # SMS messages might not be able to sign up, activate their accounts, or
2949
+ # sign in.
2877
2950
  #
2878
2951
  # If you have never used SMS text messages with Amazon Cognito or any
2879
2952
  # other Amazon Web Service, Amazon Simple Notification Service might
2880
- # place your account in SMS sandbox. In <i> <a
2953
+ # place your account in the SMS sandbox. In <i> <a
2881
2954
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
2882
- # mode</a> </i>, you will have limitations, such as sending messages
2883
- # only to verified phone numbers. After testing in the sandbox
2884
- # environment, you can move out of the SMS sandbox and into production.
2885
- # For more information, see [ SMS message settings for Amazon Cognito
2886
- # User Pools][2] in the *Amazon Cognito Developer Guide*.
2955
+ # mode</a> </i>, you can send messages only to verified phone numbers.
2956
+ # After you test your app while in the sandbox environment, you can move
2957
+ # out of the sandbox and into production. For more information, see [
2958
+ # SMS message settings for Amazon Cognito user pools][2] in the *Amazon
2959
+ # Cognito Developer Guide*.
2887
2960
  #
2888
2961
  # </note>
2889
2962
  #
@@ -2963,14 +3036,33 @@ module Aws::CognitoIdentityProvider
2963
3036
  # @option params [String] :mfa_configuration
2964
3037
  # Specifies MFA configuration details.
2965
3038
  #
3039
+ # @option params [Types::UserAttributeUpdateSettingsType] :user_attribute_update_settings
3040
+ # The settings for updates to user attributes. These settings include
3041
+ # the property `AttributesRequireVerificationBeforeUpdate`, a user-pool
3042
+ # setting that tells Amazon Cognito how to handle changes to the value
3043
+ # of your users' email address and phone number attributes. For more
3044
+ # information, see [ Verifying updates to to email addresses and phone
3045
+ # numbers][1].
3046
+ #
3047
+ #
3048
+ #
3049
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates
3050
+ #
2966
3051
  # @option params [Types::DeviceConfigurationType] :device_configuration
2967
3052
  # The device configuration.
2968
3053
  #
2969
3054
  # @option params [Types::EmailConfigurationType] :email_configuration
2970
- # The email configuration.
3055
+ # The email configuration of your user pool. The email configuration
3056
+ # type sets your preferred sending method, Amazon Web Services Region,
3057
+ # and sender for messages from your user pool.
2971
3058
  #
2972
3059
  # @option params [Types::SmsConfigurationType] :sms_configuration
2973
- # The SMS configuration.
3060
+ # The SMS configuration with the settings that your Amazon Cognito user
3061
+ # pool must use to send an SMS message from your Amazon Web Services
3062
+ # account through Amazon Simple Notification Service. To send SMS
3063
+ # messages with Amazon SNS in the Amazon Web Services Region that you
3064
+ # want, the Amazon Cognito user pool uses an Identity and Access
3065
+ # Management (IAM) role in your Amazon Web Services account.
2974
3066
  #
2975
3067
  # @option params [Hash<String,String>] :user_pool_tags
2976
3068
  # The tag keys and values to assign to the user pool. A tag is a label
@@ -3064,6 +3156,9 @@ module Aws::CognitoIdentityProvider
3064
3156
  # },
3065
3157
  # sms_authentication_message: "SmsVerificationMessageType",
3066
3158
  # mfa_configuration: "OFF", # accepts OFF, ON, OPTIONAL
3159
+ # user_attribute_update_settings: {
3160
+ # attributes_require_verification_before_update: ["phone_number"], # accepts phone_number, email
3161
+ # },
3067
3162
  # device_configuration: {
3068
3163
  # challenge_required_on_new_device: false,
3069
3164
  # device_only_remembered_on_user_prompt: false,
@@ -3078,6 +3173,7 @@ module Aws::CognitoIdentityProvider
3078
3173
  # sms_configuration: {
3079
3174
  # sns_caller_arn: "ArnType", # required
3080
3175
  # external_id: "StringType",
3176
+ # sns_region: "RegionCodeType",
3081
3177
  # },
3082
3178
  # user_pool_tags: {
3083
3179
  # "TagKeysType" => "TagValueType",
@@ -3178,6 +3274,8 @@ module Aws::CognitoIdentityProvider
3178
3274
  # resp.user_pool.verification_message_template.email_subject_by_link #=> String
3179
3275
  # resp.user_pool.verification_message_template.default_email_option #=> String, one of "CONFIRM_WITH_LINK", "CONFIRM_WITH_CODE"
3180
3276
  # resp.user_pool.sms_authentication_message #=> String
3277
+ # resp.user_pool.user_attribute_update_settings.attributes_require_verification_before_update #=> Array
3278
+ # resp.user_pool.user_attribute_update_settings.attributes_require_verification_before_update[0] #=> String, one of "phone_number", "email"
3181
3279
  # resp.user_pool.mfa_configuration #=> String, one of "OFF", "ON", "OPTIONAL"
3182
3280
  # resp.user_pool.device_configuration.challenge_required_on_new_device #=> Boolean
3183
3281
  # resp.user_pool.device_configuration.device_only_remembered_on_user_prompt #=> Boolean
@@ -3189,6 +3287,7 @@ module Aws::CognitoIdentityProvider
3189
3287
  # resp.user_pool.email_configuration.configuration_set #=> String
3190
3288
  # resp.user_pool.sms_configuration.sns_caller_arn #=> String
3191
3289
  # resp.user_pool.sms_configuration.external_id #=> String
3290
+ # resp.user_pool.sms_configuration.sns_region #=> String
3192
3291
  # resp.user_pool.user_pool_tags #=> Hash
3193
3292
  # resp.user_pool.user_pool_tags["TagKeysType"] #=> String
3194
3293
  # resp.user_pool.sms_configuration_failure #=> String
@@ -3238,22 +3337,50 @@ module Aws::CognitoIdentityProvider
3238
3337
  # pool client being created.
3239
3338
  #
3240
3339
  # @option params [Integer] :refresh_token_validity
3241
- # The time limit, in days, after which the refresh token is no longer
3242
- # valid and can't be used.
3340
+ # The refresh token time limit. After this limit expires, your user
3341
+ # can't use their refresh token. To specify the time unit for
3342
+ # `RefreshTokenValidity` as `seconds`, `minutes`, `hours`, or `days`,
3343
+ # set a `TokenValidityUnits` value in your API request.
3344
+ #
3345
+ # For example, when you set `RefreshTokenValidity` as `10` and
3346
+ # `TokenValidityUnits` as `days`, your user can refresh their session
3347
+ # and retrieve new access and ID tokens for 10 days.
3348
+ #
3349
+ # The default time unit for `RefreshTokenValidity` in an API request is
3350
+ # days. You can't set `RefreshTokenValidity` to 0. If you do, Amazon
3351
+ # Cognito overrides the value with the default value of 30 days. *Valid
3352
+ # range* is displayed below in seconds.
3243
3353
  #
3244
3354
  # @option params [Integer] :access_token_validity
3245
- # The time limit, between 5 minutes and 1 day, after which the access
3246
- # token is no longer valid and can't be used. If you supply a
3247
- # TokenValidityUnits value, you will override the default time unit.
3355
+ # The access token time limit. After this limit expires, your user
3356
+ # can't use their access token. To specify the time unit for
3357
+ # `AccessTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set
3358
+ # a `TokenValidityUnits` value in your API request.
3359
+ #
3360
+ # For example, when you set `AccessTokenValidity` to `10` and
3361
+ # `TokenValidityUnits` to `hours`, your user can authorize access with
3362
+ # their access token for 10 hours.
3363
+ #
3364
+ # The default time unit for `AccessTokenValidity` in an API request is
3365
+ # hours. *Valid range* is displayed below in seconds.
3248
3366
  #
3249
3367
  # @option params [Integer] :id_token_validity
3250
- # The time limit, between 5 minutes and 1 day, after which the access
3251
- # token is no longer valid and can't be used. If you supply a
3252
- # TokenValidityUnits value, you will override the default time unit.
3368
+ # The ID token time limit. After this limit expires, your user can't
3369
+ # use their ID token. To specify the time unit for `IdTokenValidity` as
3370
+ # `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits`
3371
+ # value in your API request.
3372
+ #
3373
+ # For example, when you set `IdTokenValidity` as `10` and
3374
+ # `TokenValidityUnits` as `hours`, your user can authenticate their
3375
+ # session with their ID token for 10 hours.
3376
+ #
3377
+ # The default time unit for `AccessTokenValidity` in an API request is
3378
+ # hours. *Valid range* is displayed below in seconds.
3253
3379
  #
3254
3380
  # @option params [Types::TokenValidityUnitsType] :token_validity_units
3255
- # The units in which the validity times are represented. Default for
3256
- # RefreshToken is days, and default for ID and access tokens are hours.
3381
+ # The units in which the validity times are represented. The default
3382
+ # unit for RefreshToken is days, and default for ID and access tokens
3383
+ # are hours.
3257
3384
  #
3258
3385
  # @option params [Array<String>] :read_attributes
3259
3386
  # The read attributes.
@@ -3261,14 +3388,13 @@ module Aws::CognitoIdentityProvider
3261
3388
  # @option params [Array<String>] :write_attributes
3262
3389
  # The user pool attributes that the app client can write to.
3263
3390
  #
3264
- # If your app client allows users to sign in through an identity
3265
- # provider, this array must include all attributes that are mapped to
3266
- # identity provider attributes. Amazon Cognito updates mapped attributes
3267
- # when users sign in to your application through an identity provider.
3268
- # If your app client lacks write access to a mapped attribute, Amazon
3269
- # Cognito throws an error when it tries to update the attribute. For
3270
- # more information, see [Specifying Identity Provider Attribute Mappings
3271
- # for Your User Pool][1].
3391
+ # If your app client allows users to sign in through an IdP, this array
3392
+ # must include all attributes that you have mapped to IdP attributes.
3393
+ # Amazon Cognito updates mapped attributes when users sign in to your
3394
+ # application through an IdP. If your app client does not have write
3395
+ # access to a mapped attribute, Amazon Cognito throws an error when it
3396
+ # tries to update the attribute. For more information, see [Specifying
3397
+ # IdP Attribute Mappings for Your user pool][1].
3272
3398
  #
3273
3399
  #
3274
3400
  #
@@ -3277,8 +3403,12 @@ module Aws::CognitoIdentityProvider
3277
3403
  # @option params [Array<String>] :explicit_auth_flows
3278
3404
  # The authentication flows that are supported by the user pool clients.
3279
3405
  # Flow names without the `ALLOW_` prefix are no longer supported, in
3280
- # favor of new names with the `ALLOW_` prefix. Note that values with
3281
- # `ALLOW_` prefix must be used only along with the `ALLOW_` prefix.
3406
+ # favor of new names with the `ALLOW_` prefix.
3407
+ #
3408
+ # <note markdown="1"> Values with `ALLOW_` prefix must be used only along with the `ALLOW_`
3409
+ # prefix.
3410
+ #
3411
+ # </note>
3282
3412
  #
3283
3413
  # Valid values include:
3284
3414
  #
@@ -3299,13 +3429,17 @@ module Aws::CognitoIdentityProvider
3299
3429
  #
3300
3430
  # * `ALLOW_REFRESH_TOKEN_AUTH`\: Enable authflow to refresh tokens.
3301
3431
  #
3432
+ # If you don't specify a value for `ExplicitAuthFlows`, your app client
3433
+ # activates the `ALLOW_USER_SRP_AUTH` and `ALLOW_CUSTOM_AUTH`
3434
+ # authentication flows.
3435
+ #
3302
3436
  # @option params [Array<String>] :supported_identity_providers
3303
- # A list of provider names for the identity providers that are supported
3304
- # on this client. The following are supported: `COGNITO`, `Facebook`,
3305
- # `Google` and `LoginWithAmazon`.
3437
+ # A list of provider names for the IdPs that this client supports. The
3438
+ # following are supported: `COGNITO`, `Facebook`, `Google`
3439
+ # `LoginWithAmazon`, and the names of your own SAML and OIDC providers.
3306
3440
  #
3307
3441
  # @option params [Array<String>] :callback_urls
3308
- # A list of allowed redirect (callback) URLs for the identity providers.
3442
+ # A list of allowed redirect (callback) URLs for the IdPs.
3309
3443
  #
3310
3444
  # A redirect URI must:
3311
3445
  #
@@ -3327,7 +3461,7 @@ module Aws::CognitoIdentityProvider
3327
3461
  # [1]: https://tools.ietf.org/html/rfc6749#section-3.1.2
3328
3462
  #
3329
3463
  # @option params [Array<String>] :logout_urls
3330
- # A list of allowed logout URLs for the identity providers.
3464
+ # A list of allowed logout URLs for the IdPs.
3331
3465
  #
3332
3466
  # @option params [String] :default_redirect_uri
3333
3467
  # The default redirect URI. Must be in the `CallbackURLs` list.
@@ -3354,36 +3488,42 @@ module Aws::CognitoIdentityProvider
3354
3488
  # @option params [Array<String>] :allowed_o_auth_flows
3355
3489
  # The allowed OAuth flows.
3356
3490
  #
3357
- # Set to `code` to initiate a code grant flow, which provides an
3358
- # authorization code as the response. This code can be exchanged for
3359
- # access tokens with the token endpoint.
3491
+ # code
3360
3492
  #
3361
- # Set to `implicit` to specify that the client should get the access
3362
- # token (and, optionally, ID token, based on scopes) directly.
3493
+ # : Use a code grant flow, which provides an authorization code as the
3494
+ # response. This code can be exchanged for access tokens with the
3495
+ # `/oauth2/token` endpoint.
3363
3496
  #
3364
- # Set to `client_credentials` to specify that the client should get the
3365
- # access token (and, optionally, ID token, based on scopes) from the
3366
- # token endpoint using a combination of client and client\_secret.
3497
+ # implicit
3498
+ #
3499
+ # : Issue the access token (and, optionally, ID token, based on scopes)
3500
+ # directly to your user.
3501
+ #
3502
+ # client\_credentials
3503
+ #
3504
+ # : Issue the access token from the `/oauth2/token` endpoint directly to
3505
+ # a non-person user using a combination of the client ID and client
3506
+ # secret.
3367
3507
  #
3368
3508
  # @option params [Array<String>] :allowed_o_auth_scopes
3369
- # The allowed OAuth scopes. Possible values provided by OAuth are:
3509
+ # The allowed OAuth scopes. Possible values provided by OAuth are
3370
3510
  # `phone`, `email`, `openid`, and `profile`. Possible values provided by
3371
- # Amazon Web Services are: `aws.cognito.signin.user.admin`. Custom
3372
- # scopes created in Resource Servers are also supported.
3511
+ # Amazon Web Services are `aws.cognito.signin.user.admin`. Custom scopes
3512
+ # created in Resource Servers are also supported.
3373
3513
  #
3374
3514
  # @option params [Boolean] :allowed_o_auth_flows_user_pool_client
3375
3515
  # Set to true if the client is allowed to follow the OAuth protocol when
3376
3516
  # interacting with Amazon Cognito user pools.
3377
3517
  #
3378
3518
  # @option params [Types::AnalyticsConfigurationType] :analytics_configuration
3379
- # The Amazon Pinpoint analytics configuration for collecting metrics for
3380
- # this user pool.
3519
+ # The user pool analytics configuration for collecting metrics and
3520
+ # sending them to your Amazon Pinpoint campaign.
3381
3521
  #
3382
- # <note markdown="1"> In Amazon Web Services Regions where isn't available, User Pools only
3383
- # supports sending events to Amazon Pinpoint projects in Amazon Web
3384
- # Services Region us-east-1. In Regions where is available, User Pools
3385
- # will support sending events to Amazon Pinpoint projects within that
3386
- # same Region.
3522
+ # <note markdown="1"> In Amazon Web Services Regions where Amazon Pinpoint isn't available,
3523
+ # user pools only support sending events to Amazon Pinpoint projects in
3524
+ # Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint
3525
+ # is available, user pools support sending events to Amazon Pinpoint
3526
+ # projects within that same Region.
3387
3527
  #
3388
3528
  # </note>
3389
3529
  #
@@ -3416,6 +3556,19 @@ module Aws::CognitoIdentityProvider
3416
3556
  #
3417
3557
  # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html
3418
3558
  #
3559
+ # @option params [Boolean] :enable_propagate_additional_user_context_data
3560
+ # Activates the propagation of additional user context data. For more
3561
+ # information about propagation of user context data, see [ Adding
3562
+ # advanced security to a user pool][1]. If you don’t include this
3563
+ # parameter, you can't send device fingerprint information, including
3564
+ # source IP address, to Amazon Cognito advanced security. You can only
3565
+ # activate `EnablePropagateAdditionalUserContextData` in an app client
3566
+ # that has a client secret.
3567
+ #
3568
+ #
3569
+ #
3570
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html
3571
+ #
3419
3572
  # @return [Types::CreateUserPoolClientResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3420
3573
  #
3421
3574
  # * {Types::CreateUserPoolClientResponse#user_pool_client #user_pool_client} => Types::UserPoolClientType
@@ -3453,6 +3606,7 @@ module Aws::CognitoIdentityProvider
3453
3606
  # },
3454
3607
  # prevent_user_existence_errors: "LEGACY", # accepts LEGACY, ENABLED
3455
3608
  # enable_token_revocation: false,
3609
+ # enable_propagate_additional_user_context_data: false,
3456
3610
  # })
3457
3611
  #
3458
3612
  # @example Response structure
@@ -3494,6 +3648,7 @@ module Aws::CognitoIdentityProvider
3494
3648
  # resp.user_pool_client.analytics_configuration.user_data_shared #=> Boolean
3495
3649
  # resp.user_pool_client.prevent_user_existence_errors #=> String, one of "LEGACY", "ENABLED"
3496
3650
  # resp.user_pool_client.enable_token_revocation #=> Boolean
3651
+ # resp.user_pool_client.enable_propagate_additional_user_context_data #=> Boolean
3497
3652
  #
3498
3653
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolClient AWS API Documentation
3499
3654
  #
@@ -3584,13 +3739,13 @@ module Aws::CognitoIdentityProvider
3584
3739
  req.send_request(options)
3585
3740
  end
3586
3741
 
3587
- # Deletes an identity provider for a user pool.
3742
+ # Deletes an IdP for a user pool.
3588
3743
  #
3589
3744
  # @option params [required, String] :user_pool_id
3590
3745
  # The user pool ID.
3591
3746
  #
3592
3747
  # @option params [required, String] :provider_name
3593
- # The identity provider name.
3748
+ # The IdP name.
3594
3749
  #
3595
3750
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3596
3751
  #
@@ -3639,7 +3794,8 @@ module Aws::CognitoIdentityProvider
3639
3794
  # Allows a user to delete himself or herself.
3640
3795
  #
3641
3796
  # @option params [required, String] :access_token
3642
- # The access token from a request to delete a user.
3797
+ # A valid access token that Amazon Cognito issued to the user whose user
3798
+ # profile you want to delete.
3643
3799
  #
3644
3800
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3645
3801
  #
@@ -3668,7 +3824,8 @@ module Aws::CognitoIdentityProvider
3668
3824
  # the front of the attribute name.
3669
3825
  #
3670
3826
  # @option params [required, String] :access_token
3671
- # The access token used in the request to delete user attributes.
3827
+ # A valid access token that Amazon Cognito issued to the user whose
3828
+ # attributes you want to delete.
3672
3829
  #
3673
3830
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3674
3831
  #
@@ -3765,13 +3922,13 @@ module Aws::CognitoIdentityProvider
3765
3922
  req.send_request(options)
3766
3923
  end
3767
3924
 
3768
- # Gets information about a specific identity provider.
3925
+ # Gets information about a specific IdP.
3769
3926
  #
3770
3927
  # @option params [required, String] :user_pool_id
3771
3928
  # The user pool ID.
3772
3929
  #
3773
3930
  # @option params [required, String] :provider_name
3774
- # The identity provider name.
3931
+ # The IdP name.
3775
3932
  #
3776
3933
  # @return [Types::DescribeIdentityProviderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3777
3934
  #
@@ -4018,6 +4175,8 @@ module Aws::CognitoIdentityProvider
4018
4175
  # resp.user_pool.verification_message_template.email_subject_by_link #=> String
4019
4176
  # resp.user_pool.verification_message_template.default_email_option #=> String, one of "CONFIRM_WITH_LINK", "CONFIRM_WITH_CODE"
4020
4177
  # resp.user_pool.sms_authentication_message #=> String
4178
+ # resp.user_pool.user_attribute_update_settings.attributes_require_verification_before_update #=> Array
4179
+ # resp.user_pool.user_attribute_update_settings.attributes_require_verification_before_update[0] #=> String, one of "phone_number", "email"
4021
4180
  # resp.user_pool.mfa_configuration #=> String, one of "OFF", "ON", "OPTIONAL"
4022
4181
  # resp.user_pool.device_configuration.challenge_required_on_new_device #=> Boolean
4023
4182
  # resp.user_pool.device_configuration.device_only_remembered_on_user_prompt #=> Boolean
@@ -4029,6 +4188,7 @@ module Aws::CognitoIdentityProvider
4029
4188
  # resp.user_pool.email_configuration.configuration_set #=> String
4030
4189
  # resp.user_pool.sms_configuration.sns_caller_arn #=> String
4031
4190
  # resp.user_pool.sms_configuration.external_id #=> String
4191
+ # resp.user_pool.sms_configuration.sns_region #=> String
4032
4192
  # resp.user_pool.user_pool_tags #=> Hash
4033
4193
  # resp.user_pool.user_pool_tags["TagKeysType"] #=> String
4034
4194
  # resp.user_pool.sms_configuration_failure #=> String
@@ -4115,6 +4275,7 @@ module Aws::CognitoIdentityProvider
4115
4275
  # resp.user_pool_client.analytics_configuration.user_data_shared #=> Boolean
4116
4276
  # resp.user_pool_client.prevent_user_existence_errors #=> String, one of "LEGACY", "ENABLED"
4117
4277
  # resp.user_pool_client.enable_token_revocation #=> Boolean
4278
+ # resp.user_pool_client.enable_propagate_additional_user_context_data #=> Boolean
4118
4279
  #
4119
4280
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPoolClient AWS API Documentation
4120
4281
  #
@@ -4165,7 +4326,8 @@ module Aws::CognitoIdentityProvider
4165
4326
  # Forgets the specified device.
4166
4327
  #
4167
4328
  # @option params [String] :access_token
4168
- # The access token for the forgotten device request.
4329
+ # A valid access token that Amazon Cognito issued to the user whose
4330
+ # registered device you want to forget.
4169
4331
  #
4170
4332
  # @option params [required, String] :device_key
4171
4333
  # The device key.
@@ -4200,22 +4362,22 @@ module Aws::CognitoIdentityProvider
4200
4362
  #
4201
4363
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
4202
4364
  # US telecom carriers require you to register an origination phone
4203
- # number before you can send SMS messages to U.S. phone numbers. If you
4365
+ # number before you can send SMS messages to US phone numbers. If you
4204
4366
  # use SMS text messages in Amazon Cognito, you must register a phone
4205
- # number with [Amazon Pinpoint][3]. Amazon Cognito will use the
4206
- # registered number automatically. Otherwise, Amazon Cognito users that
4207
- # must receive SMS messages might be unable to sign up, activate their
4208
- # accounts, or sign in.
4367
+ # number with [Amazon Pinpoint][3]. Amazon Cognito uses the registered
4368
+ # number automatically. Otherwise, Amazon Cognito users who must receive
4369
+ # SMS messages might not be able to sign up, activate their accounts, or
4370
+ # sign in.
4209
4371
  #
4210
4372
  # If you have never used SMS text messages with Amazon Cognito or any
4211
4373
  # other Amazon Web Service, Amazon Simple Notification Service might
4212
- # place your account in SMS sandbox. In <i> <a
4374
+ # place your account in the SMS sandbox. In <i> <a
4213
4375
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
4214
- # mode</a> </i>, you will have limitations, such as sending messages
4215
- # only to verified phone numbers. After testing in the sandbox
4216
- # environment, you can move out of the SMS sandbox and into production.
4217
- # For more information, see [ SMS message settings for Amazon Cognito
4218
- # User Pools][4] in the *Amazon Cognito Developer Guide*.
4376
+ # mode</a> </i>, you can send messages only to verified phone numbers.
4377
+ # After you test your app while in the sandbox environment, you can move
4378
+ # out of the sandbox and into production. For more information, see [
4379
+ # SMS message settings for Amazon Cognito user pools][4] in the *Amazon
4380
+ # Cognito Developer Guide*.
4219
4381
  #
4220
4382
  # </note>
4221
4383
  #
@@ -4235,17 +4397,19 @@ module Aws::CognitoIdentityProvider
4235
4397
  # the message.
4236
4398
  #
4237
4399
  # @option params [Types::UserContextDataType] :user_context_data
4238
- # Contextual data such as the user's device fingerprint, IP address, or
4239
- # location used for evaluating the risk of an unexpected event by Amazon
4240
- # Cognito advanced security.
4400
+ # Contextual data about your user session, such as the device
4401
+ # fingerprint, IP address, or location. Amazon Cognito advanced security
4402
+ # evaluates the risk of an authentication event based on the context
4403
+ # that your app generates and passes to Amazon Cognito when it makes API
4404
+ # requests.
4241
4405
  #
4242
4406
  # @option params [required, String] :username
4243
4407
  # The user name of the user for whom you want to enter a code to reset a
4244
4408
  # forgotten password.
4245
4409
  #
4246
4410
  # @option params [Types::AnalyticsMetadataType] :analytics_metadata
4247
- # The Amazon Pinpoint analytics metadata for collecting metrics for
4248
- # `ForgotPassword` calls.
4411
+ # The Amazon Pinpoint analytics metadata that contributes to your
4412
+ # metrics for `ForgotPassword` calls.
4249
4413
  #
4250
4414
  # @option params [Hash<String,String>] :client_metadata
4251
4415
  # A map of custom key-value pairs that you can provide as input for any
@@ -4262,8 +4426,8 @@ module Aws::CognitoIdentityProvider
4262
4426
  # your function code in Lambda, you can process the `clientMetadata`
4263
4427
  # value to enhance your workflow for your specific needs.
4264
4428
  #
4265
- # For more information, see [Customizing User Pool Workflows with Lambda
4266
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
4429
+ # For more information, see [ Customizing user pool Workflows with
4430
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
4267
4431
  #
4268
4432
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
4269
4433
  # Cognito won't do the following:
@@ -4294,6 +4458,7 @@ module Aws::CognitoIdentityProvider
4294
4458
  # client_id: "ClientIdType", # required
4295
4459
  # secret_hash: "SecretHashType",
4296
4460
  # user_context_data: {
4461
+ # ip_address: "StringType",
4297
4462
  # encoded_data: "StringType",
4298
4463
  # },
4299
4464
  # username: "UsernameType", # required
@@ -4359,7 +4524,8 @@ module Aws::CognitoIdentityProvider
4359
4524
  # The device key.
4360
4525
  #
4361
4526
  # @option params [String] :access_token
4362
- # The access token.
4527
+ # A valid access token that Amazon Cognito issued to the user whose
4528
+ # device information you want to request.
4363
4529
  #
4364
4530
  # @return [Types::GetDeviceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4365
4531
  #
@@ -4431,13 +4597,13 @@ module Aws::CognitoIdentityProvider
4431
4597
  req.send_request(options)
4432
4598
  end
4433
4599
 
4434
- # Gets the specified identity provider.
4600
+ # Gets the specified IdP.
4435
4601
  #
4436
4602
  # @option params [required, String] :user_pool_id
4437
4603
  # The user pool ID.
4438
4604
  #
4439
4605
  # @option params [required, String] :idp_identifier
4440
- # The identity provider ID.
4606
+ # The IdP identifier.
4441
4607
  #
4442
4608
  # @return [Types::GetIdentityProviderByIdentifierResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4443
4609
  #
@@ -4547,8 +4713,8 @@ module Aws::CognitoIdentityProvider
4547
4713
  # Gets the user attributes and metadata for a user.
4548
4714
  #
4549
4715
  # @option params [required, String] :access_token
4550
- # The access token returned by the server response to get information
4551
- # about the user.
4716
+ # A non-expired access token for the user whose information you want to
4717
+ # query.
4552
4718
  #
4553
4719
  # @return [Types::GetUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4554
4720
  #
@@ -4586,27 +4752,28 @@ module Aws::CognitoIdentityProvider
4586
4752
  req.send_request(options)
4587
4753
  end
4588
4754
 
4589
- # Gets the user attribute verification code for the specified attribute
4590
- # name.
4755
+ # Generates a user attribute verification code for the specified
4756
+ # attribute name. Sends a message to a user with a code that they must
4757
+ # return in a VerifyUserAttribute request.
4591
4758
  #
4592
4759
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
4593
4760
  # US telecom carriers require you to register an origination phone
4594
- # number before you can send SMS messages to U.S. phone numbers. If you
4761
+ # number before you can send SMS messages to US phone numbers. If you
4595
4762
  # use SMS text messages in Amazon Cognito, you must register a phone
4596
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
4597
- # registered number automatically. Otherwise, Amazon Cognito users that
4598
- # must receive SMS messages might be unable to sign up, activate their
4599
- # accounts, or sign in.
4763
+ # number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
4764
+ # number automatically. Otherwise, Amazon Cognito users who must receive
4765
+ # SMS messages might not be able to sign up, activate their accounts, or
4766
+ # sign in.
4600
4767
  #
4601
4768
  # If you have never used SMS text messages with Amazon Cognito or any
4602
4769
  # other Amazon Web Service, Amazon Simple Notification Service might
4603
- # place your account in SMS sandbox. In <i> <a
4770
+ # place your account in the SMS sandbox. In <i> <a
4604
4771
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
4605
- # mode</a> </i>, you will have limitations, such as sending messages
4606
- # only to verified phone numbers. After testing in the sandbox
4607
- # environment, you can move out of the SMS sandbox and into production.
4608
- # For more information, see [ SMS message settings for Amazon Cognito
4609
- # User Pools][2] in the *Amazon Cognito Developer Guide*.
4772
+ # mode</a> </i>, you can send messages only to verified phone numbers.
4773
+ # After you test your app while in the sandbox environment, you can move
4774
+ # out of the sandbox and into production. For more information, see [
4775
+ # SMS message settings for Amazon Cognito user pools][2] in the *Amazon
4776
+ # Cognito Developer Guide*.
4610
4777
  #
4611
4778
  # </note>
4612
4779
  #
@@ -4616,8 +4783,8 @@ module Aws::CognitoIdentityProvider
4616
4783
  # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html
4617
4784
  #
4618
4785
  # @option params [required, String] :access_token
4619
- # The access token returned by the server response to get the user
4620
- # attribute verification code.
4786
+ # A non-expired access token for the user whose attribute verification
4787
+ # code you want to generate.
4621
4788
  #
4622
4789
  # @option params [required, String] :attribute_name
4623
4790
  # The attribute name returned by the server response to get the user
@@ -4638,8 +4805,8 @@ module Aws::CognitoIdentityProvider
4638
4805
  # Lambda, you can process the `clientMetadata` value to enhance your
4639
4806
  # workflow for your specific needs.
4640
4807
  #
4641
- # For more information, see [Customizing User Pool Workflows with Lambda
4642
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
4808
+ # For more information, see [ Customizing user pool Workflows with
4809
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
4643
4810
  #
4644
4811
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
4645
4812
  # Cognito won't do the following:
@@ -4711,6 +4878,7 @@ module Aws::CognitoIdentityProvider
4711
4878
  # resp.sms_mfa_configuration.sms_authentication_message #=> String
4712
4879
  # resp.sms_mfa_configuration.sms_configuration.sns_caller_arn #=> String
4713
4880
  # resp.sms_mfa_configuration.sms_configuration.external_id #=> String
4881
+ # resp.sms_mfa_configuration.sms_configuration.sns_region #=> String
4714
4882
  # resp.software_token_mfa_configuration.enabled #=> Boolean
4715
4883
  # resp.mfa_configuration #=> String, one of "OFF", "ON", "OPTIONAL"
4716
4884
  #
@@ -4724,12 +4892,15 @@ module Aws::CognitoIdentityProvider
4724
4892
  end
4725
4893
 
4726
4894
  # Signs out users from all devices. It also invalidates all refresh
4727
- # tokens issued to a user. The user's current access and ID tokens
4728
- # remain valid until their expiry. Access and Id tokens expire one hour
4729
- # after they're issued.
4895
+ # tokens that Amazon Cognito has issued to a user. The user's current
4896
+ # access and ID tokens remain valid until their expiry. By default,
4897
+ # access and ID tokens expire one hour after Amazon Cognito issues them.
4898
+ # A user can still use a hosted UI cookie to retrieve new tokens for the
4899
+ # duration of the cookie validity period of 1 hour.
4730
4900
  #
4731
4901
  # @option params [required, String] :access_token
4732
- # The access token.
4902
+ # A valid access token that Amazon Cognito issued to the user who you
4903
+ # want to sign out.
4733
4904
  #
4734
4905
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
4735
4906
  #
@@ -4748,33 +4919,37 @@ module Aws::CognitoIdentityProvider
4748
4919
  req.send_request(options)
4749
4920
  end
4750
4921
 
4751
- # Initiates the authentication flow.
4922
+ # Initiates sign-in for a user in the Amazon Cognito user directory. You
4923
+ # can't sign in a user with a federated IdP with `InitiateAuth`. For
4924
+ # more information, see [ Adding user pool sign-in through a third
4925
+ # party][1].
4752
4926
  #
4753
4927
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
4754
4928
  # US telecom carriers require you to register an origination phone
4755
- # number before you can send SMS messages to U.S. phone numbers. If you
4929
+ # number before you can send SMS messages to US phone numbers. If you
4756
4930
  # use SMS text messages in Amazon Cognito, you must register a phone
4757
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
4758
- # registered number automatically. Otherwise, Amazon Cognito users that
4759
- # must receive SMS messages might be unable to sign up, activate their
4760
- # accounts, or sign in.
4931
+ # number with [Amazon Pinpoint][2]. Amazon Cognito uses the registered
4932
+ # number automatically. Otherwise, Amazon Cognito users who must receive
4933
+ # SMS messages might not be able to sign up, activate their accounts, or
4934
+ # sign in.
4761
4935
  #
4762
4936
  # If you have never used SMS text messages with Amazon Cognito or any
4763
4937
  # other Amazon Web Service, Amazon Simple Notification Service might
4764
- # place your account in SMS sandbox. In <i> <a
4938
+ # place your account in the SMS sandbox. In <i> <a
4765
4939
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
4766
- # mode</a> </i>, you will have limitations, such as sending messages
4767
- # only to verified phone numbers. After testing in the sandbox
4768
- # environment, you can move out of the SMS sandbox and into production.
4769
- # For more information, see [ SMS message settings for Amazon Cognito
4770
- # User Pools][2] in the *Amazon Cognito Developer Guide*.
4940
+ # mode</a> </i>, you can send messages only to verified phone numbers.
4941
+ # After you test your app while in the sandbox environment, you can move
4942
+ # out of the sandbox and into production. For more information, see [
4943
+ # SMS message settings for Amazon Cognito user pools][3] in the *Amazon
4944
+ # Cognito Developer Guide*.
4771
4945
  #
4772
4946
  # </note>
4773
4947
  #
4774
4948
  #
4775
4949
  #
4776
- # [1]: https://console.aws.amazon.com/pinpoint/home/
4777
- # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html
4950
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html
4951
+ # [2]: https://console.aws.amazon.com/pinpoint/home/
4952
+ # [3]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html
4778
4953
  #
4779
4954
  # @option params [required, String] :auth_flow
4780
4955
  # The authentication flow for this call to run. The API action will
@@ -4800,10 +4975,10 @@ module Aws::CognitoIdentityProvider
4800
4975
  #
4801
4976
  # * `CUSTOM_AUTH`\: Custom authentication flow.
4802
4977
  #
4803
- # * `USER_PASSWORD_AUTH`\: Non-SRP authentication flow; USERNAME and
4804
- # PASSWORD are passed directly. If a user migration Lambda trigger is
4978
+ # * `USER_PASSWORD_AUTH`\: Non-SRP authentication flow; user name and
4979
+ # password are passed directly. If a user migration Lambda trigger is
4805
4980
  # set, this flow will invoke the user migration Lambda if it doesn't
4806
- # find the USERNAME in the user pool.
4981
+ # find the user name in the user pool.
4807
4982
  #
4808
4983
  # `ADMIN_NO_SRP_AUTH` isn't a valid value.
4809
4984
  #
@@ -4865,8 +5040,8 @@ module Aws::CognitoIdentityProvider
4865
5040
  #
4866
5041
  # * Verify auth challenge
4867
5042
  #
4868
- # For more information, see [Customizing User Pool Workflows with Lambda
4869
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
5043
+ # For more information, see [ Customizing user pool Workflows with
5044
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
4870
5045
  #
4871
5046
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
4872
5047
  # Cognito won't do the following:
@@ -4891,13 +5066,15 @@ module Aws::CognitoIdentityProvider
4891
5066
  # The app client ID.
4892
5067
  #
4893
5068
  # @option params [Types::AnalyticsMetadataType] :analytics_metadata
4894
- # The Amazon Pinpoint analytics metadata for collecting metrics for
4895
- # `InitiateAuth` calls.
5069
+ # The Amazon Pinpoint analytics metadata that contributes to your
5070
+ # metrics for `InitiateAuth` calls.
4896
5071
  #
4897
5072
  # @option params [Types::UserContextDataType] :user_context_data
4898
- # Contextual data such as the user's device fingerprint, IP address, or
4899
- # location used for evaluating the risk of an unexpected event by Amazon
4900
- # Cognito advanced security.
5073
+ # Contextual data about your user session, such as the device
5074
+ # fingerprint, IP address, or location. Amazon Cognito advanced security
5075
+ # evaluates the risk of an authentication event based on the context
5076
+ # that your app generates and passes to Amazon Cognito when it makes API
5077
+ # requests.
4901
5078
  #
4902
5079
  # @return [Types::InitiateAuthResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4903
5080
  #
@@ -4921,6 +5098,7 @@ module Aws::CognitoIdentityProvider
4921
5098
  # analytics_endpoint_id: "StringType",
4922
5099
  # },
4923
5100
  # user_context_data: {
5101
+ # ip_address: "StringType",
4924
5102
  # encoded_data: "StringType",
4925
5103
  # },
4926
5104
  # })
@@ -4948,10 +5126,12 @@ module Aws::CognitoIdentityProvider
4948
5126
  req.send_request(options)
4949
5127
  end
4950
5128
 
4951
- # Lists the devices.
5129
+ # Lists the sign-in devices that Amazon Cognito has registered to the
5130
+ # current user.
4952
5131
  #
4953
5132
  # @option params [required, String] :access_token
4954
- # The access tokens for the request to list devices.
5133
+ # A valid access token that Amazon Cognito issued to the user whose list
5134
+ # of devices you want to view.
4955
5135
  #
4956
5136
  # @option params [Integer] :limit
4957
5137
  # The limit of the device request.
@@ -5044,13 +5224,13 @@ module Aws::CognitoIdentityProvider
5044
5224
  req.send_request(options)
5045
5225
  end
5046
5226
 
5047
- # Lists information about all identity providers for a user pool.
5227
+ # Lists information about all IdPs for a user pool.
5048
5228
  #
5049
5229
  # @option params [required, String] :user_pool_id
5050
5230
  # The user pool ID.
5051
5231
  #
5052
5232
  # @option params [Integer] :max_results
5053
- # The maximum number of identity providers to return.
5233
+ # The maximum number of IdPs to return.
5054
5234
  #
5055
5235
  # @option params [String] :next_token
5056
5236
  # A pagination token.
@@ -5394,8 +5574,8 @@ module Aws::CognitoIdentityProvider
5394
5574
  # Custom attributes aren't searchable.
5395
5575
  #
5396
5576
  # <note markdown="1"> You can also list users with a client-side filter. The server-side
5397
- # filter matches no more than 1 attribute. For an advanced search, use a
5398
- # client-side filter with the `--query` parameter of the `list-users`
5577
+ # filter matches no more than one attribute. For an advanced search, use
5578
+ # a client-side filter with the `--query` parameter of the `list-users`
5399
5579
  # action in the CLI. When you use a client-side filter, ListUsers
5400
5580
  # returns a paginated list of zero or more users. You can receive
5401
5581
  # multiple pages in a row with zero results. Repeat the query with each
@@ -5524,22 +5704,22 @@ module Aws::CognitoIdentityProvider
5524
5704
  #
5525
5705
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
5526
5706
  # US telecom carriers require you to register an origination phone
5527
- # number before you can send SMS messages to U.S. phone numbers. If you
5707
+ # number before you can send SMS messages to US phone numbers. If you
5528
5708
  # use SMS text messages in Amazon Cognito, you must register a phone
5529
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
5530
- # registered number automatically. Otherwise, Amazon Cognito users that
5531
- # must receive SMS messages might be unable to sign up, activate their
5532
- # accounts, or sign in.
5709
+ # number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
5710
+ # number automatically. Otherwise, Amazon Cognito users who must receive
5711
+ # SMS messages might not be able to sign up, activate their accounts, or
5712
+ # sign in.
5533
5713
  #
5534
5714
  # If you have never used SMS text messages with Amazon Cognito or any
5535
5715
  # other Amazon Web Service, Amazon Simple Notification Service might
5536
- # place your account in SMS sandbox. In <i> <a
5716
+ # place your account in the SMS sandbox. In <i> <a
5537
5717
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
5538
- # mode</a> </i>, you will have limitations, such as sending messages
5539
- # only to verified phone numbers. After testing in the sandbox
5540
- # environment, you can move out of the SMS sandbox and into production.
5541
- # For more information, see [ SMS message settings for Amazon Cognito
5542
- # User Pools][2] in the *Amazon Cognito Developer Guide*.
5718
+ # mode</a> </i>, you can send messages only to verified phone numbers.
5719
+ # After you test your app while in the sandbox environment, you can move
5720
+ # out of the sandbox and into production. For more information, see [
5721
+ # SMS message settings for Amazon Cognito user pools][2] in the *Amazon
5722
+ # Cognito Developer Guide*.
5543
5723
  #
5544
5724
  # </note>
5545
5725
  #
@@ -5557,17 +5737,19 @@ module Aws::CognitoIdentityProvider
5557
5737
  # the message.
5558
5738
  #
5559
5739
  # @option params [Types::UserContextDataType] :user_context_data
5560
- # Contextual data such as the user's device fingerprint, IP address, or
5561
- # location used for evaluating the risk of an unexpected event by Amazon
5562
- # Cognito advanced security.
5740
+ # Contextual data about your user session, such as the device
5741
+ # fingerprint, IP address, or location. Amazon Cognito advanced security
5742
+ # evaluates the risk of an authentication event based on the context
5743
+ # that your app generates and passes to Amazon Cognito when it makes API
5744
+ # requests.
5563
5745
  #
5564
5746
  # @option params [required, String] :username
5565
5747
  # The `username` attribute of the user to whom you want to resend a
5566
5748
  # confirmation code.
5567
5749
  #
5568
5750
  # @option params [Types::AnalyticsMetadataType] :analytics_metadata
5569
- # The Amazon Pinpoint analytics metadata for collecting metrics for
5570
- # `ResendConfirmationCode` calls.
5751
+ # The Amazon Pinpoint analytics metadata that contributes to your
5752
+ # metrics for `ResendConfirmationCode` calls.
5571
5753
  #
5572
5754
  # @option params [Hash<String,String>] :client_metadata
5573
5755
  # A map of custom key-value pairs that you can provide as input for any
@@ -5584,8 +5766,8 @@ module Aws::CognitoIdentityProvider
5584
5766
  # `clientMetadata` value to enhance your workflow for your specific
5585
5767
  # needs.
5586
5768
  #
5587
- # For more information, see [Customizing User Pool Workflows with Lambda
5588
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
5769
+ # For more information, see [ Customizing user pool Workflows with
5770
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
5589
5771
  #
5590
5772
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
5591
5773
  # Cognito won't do the following:
@@ -5616,6 +5798,7 @@ module Aws::CognitoIdentityProvider
5616
5798
  # client_id: "ClientIdType", # required
5617
5799
  # secret_hash: "SecretHashType",
5618
5800
  # user_context_data: {
5801
+ # ip_address: "StringType",
5619
5802
  # encoded_data: "StringType",
5620
5803
  # },
5621
5804
  # username: "UsernameType", # required
@@ -5646,22 +5829,22 @@ module Aws::CognitoIdentityProvider
5646
5829
  #
5647
5830
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
5648
5831
  # US telecom carriers require you to register an origination phone
5649
- # number before you can send SMS messages to U.S. phone numbers. If you
5832
+ # number before you can send SMS messages to US phone numbers. If you
5650
5833
  # use SMS text messages in Amazon Cognito, you must register a phone
5651
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
5652
- # registered number automatically. Otherwise, Amazon Cognito users that
5653
- # must receive SMS messages might be unable to sign up, activate their
5654
- # accounts, or sign in.
5834
+ # number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
5835
+ # number automatically. Otherwise, Amazon Cognito users who must receive
5836
+ # SMS messages might not be able to sign up, activate their accounts, or
5837
+ # sign in.
5655
5838
  #
5656
5839
  # If you have never used SMS text messages with Amazon Cognito or any
5657
5840
  # other Amazon Web Service, Amazon Simple Notification Service might
5658
- # place your account in SMS sandbox. In <i> <a
5841
+ # place your account in the SMS sandbox. In <i> <a
5659
5842
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
5660
- # mode</a> </i>, you will have limitations, such as sending messages
5661
- # only to verified phone numbers. After testing in the sandbox
5662
- # environment, you can move out of the SMS sandbox and into production.
5663
- # For more information, see [ SMS message settings for Amazon Cognito
5664
- # User Pools][2] in the *Amazon Cognito Developer Guide*.
5843
+ # mode</a> </i>, you can send messages only to verified phone numbers.
5844
+ # After you test your app while in the sandbox environment, you can move
5845
+ # out of the sandbox and into production. For more information, see [
5846
+ # SMS message settings for Amazon Cognito user pools][2] in the *Amazon
5847
+ # Cognito Developer Guide*.
5665
5848
  #
5666
5849
  # </note>
5667
5850
  #
@@ -5703,13 +5886,27 @@ module Aws::CognitoIdentityProvider
5703
5886
  # * `PASSWORD_VERIFIER`\: `PASSWORD_CLAIM_SIGNATURE`,
5704
5887
  # `PASSWORD_CLAIM_SECRET_BLOCK`, `TIMESTAMP`, `USERNAME`.
5705
5888
  #
5706
- # <note markdown="1"> `PASSWORD_VERIFIER` requires `DEVICE_KEY` when signing in with a
5889
+ # <note markdown="1"> `PASSWORD_VERIFIER` requires `DEVICE_KEY` when you sign in with a
5707
5890
  # remembered device.
5708
5891
  #
5709
5892
  # </note>
5710
5893
  #
5711
- # * `NEW_PASSWORD_REQUIRED`\: `NEW_PASSWORD`, any other required
5712
- # attributes, `USERNAME`.
5894
+ # * `NEW_PASSWORD_REQUIRED`\: `NEW_PASSWORD`, `USERNAME`, `SECRET_HASH`
5895
+ # (if app client is configured with client secret). To set any
5896
+ # required attributes that Amazon Cognito returned as
5897
+ # `requiredAttributes` in the `InitiateAuth` response, add a
5898
+ # `userAttributes.attributename ` parameter. This parameter can also
5899
+ # set values for writable attributes that aren't required by your
5900
+ # user pool.
5901
+ #
5902
+ # <note markdown="1"> In a `NEW_PASSWORD_REQUIRED` challenge response, you can't modify a
5903
+ # required attribute that already has a value. In
5904
+ # `RespondToAuthChallenge`, set a value for any keys that Amazon
5905
+ # Cognito returned in the `requiredAttributes` parameter, then use the
5906
+ # `UpdateUserAttributes` API operation to modify the value of any
5907
+ # additional attributes.
5908
+ #
5909
+ # </note>
5713
5910
  #
5714
5911
  # * `SOFTWARE_TOKEN_MFA`\: `USERNAME` and `SOFTWARE_TOKEN_MFA_CODE` are
5715
5912
  # required attributes.
@@ -5724,13 +5921,15 @@ module Aws::CognitoIdentityProvider
5724
5921
  # returned by `VerifySoftwareToken` in the `Session` parameter.
5725
5922
  #
5726
5923
  # @option params [Types::AnalyticsMetadataType] :analytics_metadata
5727
- # The Amazon Pinpoint analytics metadata for collecting metrics for
5728
- # `RespondToAuthChallenge` calls.
5924
+ # The Amazon Pinpoint analytics metadata that contributes to your
5925
+ # metrics for `RespondToAuthChallenge` calls.
5729
5926
  #
5730
5927
  # @option params [Types::UserContextDataType] :user_context_data
5731
- # Contextual data such as the user's device fingerprint, IP address, or
5732
- # location used for evaluating the risk of an unexpected event by Amazon
5733
- # Cognito advanced security.
5928
+ # Contextual data about your user session, such as the device
5929
+ # fingerprint, IP address, or location. Amazon Cognito advanced security
5930
+ # evaluates the risk of an authentication event based on the context
5931
+ # that your app generates and passes to Amazon Cognito when it makes API
5932
+ # requests.
5734
5933
  #
5735
5934
  # @option params [Hash<String,String>] :client_metadata
5736
5935
  # A map of custom key-value pairs that you can provide as input for any
@@ -5749,8 +5948,8 @@ module Aws::CognitoIdentityProvider
5749
5948
  # `clientMetadata` value to enhance your workflow for your specific
5750
5949
  # needs.
5751
5950
  #
5752
- # For more information, see [Customizing User Pool Workflows with Lambda
5753
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
5951
+ # For more information, see [ Customizing user pool Workflows with
5952
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
5754
5953
  #
5755
5954
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
5756
5955
  # Cognito won't do the following:
@@ -5791,6 +5990,7 @@ module Aws::CognitoIdentityProvider
5791
5990
  # analytics_endpoint_id: "StringType",
5792
5991
  # },
5793
5992
  # user_context_data: {
5993
+ # ip_address: "StringType",
5794
5994
  # encoded_data: "StringType",
5795
5995
  # },
5796
5996
  # client_metadata: {
@@ -6058,7 +6258,8 @@ module Aws::CognitoIdentityProvider
6058
6258
  # The time-based one-time password software token MFA settings.
6059
6259
  #
6060
6260
  # @option params [required, String] :access_token
6061
- # The access token for the user.
6261
+ # A valid access token that Amazon Cognito issued to the user whose MFA
6262
+ # preference you want to set.
6062
6263
  #
6063
6264
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
6064
6265
  #
@@ -6089,22 +6290,22 @@ module Aws::CognitoIdentityProvider
6089
6290
  #
6090
6291
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
6091
6292
  # US telecom carriers require you to register an origination phone
6092
- # number before you can send SMS messages to U.S. phone numbers. If you
6293
+ # number before you can send SMS messages to US phone numbers. If you
6093
6294
  # use SMS text messages in Amazon Cognito, you must register a phone
6094
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
6095
- # registered number automatically. Otherwise, Amazon Cognito users that
6096
- # must receive SMS messages might be unable to sign up, activate their
6097
- # accounts, or sign in.
6295
+ # number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
6296
+ # number automatically. Otherwise, Amazon Cognito users who must receive
6297
+ # SMS messages might not be able to sign up, activate their accounts, or
6298
+ # sign in.
6098
6299
  #
6099
6300
  # If you have never used SMS text messages with Amazon Cognito or any
6100
6301
  # other Amazon Web Service, Amazon Simple Notification Service might
6101
- # place your account in SMS sandbox. In <i> <a
6302
+ # place your account in the SMS sandbox. In <i> <a
6102
6303
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
6103
- # mode</a> </i>, you will have limitations, such as sending messages
6104
- # only to verified phone numbers. After testing in the sandbox
6105
- # environment, you can move out of the SMS sandbox and into production.
6106
- # For more information, see [ SMS message settings for Amazon Cognito
6107
- # User Pools][2] in the *Amazon Cognito Developer Guide*.
6304
+ # mode</a> </i>, you can send messages only to verified phone numbers.
6305
+ # After you test your app while in the sandbox environment, you can move
6306
+ # out of the sandbox and into production. For more information, see [
6307
+ # SMS message settings for Amazon Cognito user pools][2] in the *Amazon
6308
+ # Cognito Developer Guide*.
6108
6309
  #
6109
6310
  # </note>
6110
6311
  #
@@ -6124,9 +6325,9 @@ module Aws::CognitoIdentityProvider
6124
6325
  #
6125
6326
  # @option params [String] :mfa_configuration
6126
6327
  # The MFA configuration. If you set the MfaConfiguration value to ‘ON’,
6127
- # only users with an MFA factor set up can sign in. To learn more, see
6128
- # [Adding Multi-Factor Authentication (MFA) to a User
6129
- # Pool](cognito/latest/developerguide/user-pool-settings-mfa.html).
6328
+ # only users who have set up an MFA factor can sign in. To learn more,
6329
+ # see [Adding Multi-Factor Authentication (MFA) to a user
6330
+ # pool](cognito/latest/developerguide/user-pool-settings-mfa.html).
6130
6331
  # Valid values include:
6131
6332
  #
6132
6333
  # * `OFF` MFA won't be used for any users.
@@ -6151,6 +6352,7 @@ module Aws::CognitoIdentityProvider
6151
6352
  # sms_configuration: {
6152
6353
  # sns_caller_arn: "ArnType", # required
6153
6354
  # external_id: "StringType",
6355
+ # sns_region: "RegionCodeType",
6154
6356
  # },
6155
6357
  # },
6156
6358
  # software_token_mfa_configuration: {
@@ -6164,6 +6366,7 @@ module Aws::CognitoIdentityProvider
6164
6366
  # resp.sms_mfa_configuration.sms_authentication_message #=> String
6165
6367
  # resp.sms_mfa_configuration.sms_configuration.sns_caller_arn #=> String
6166
6368
  # resp.sms_mfa_configuration.sms_configuration.external_id #=> String
6369
+ # resp.sms_mfa_configuration.sms_configuration.sns_region #=> String
6167
6370
  # resp.software_token_mfa_configuration.enabled #=> Boolean
6168
6371
  # resp.mfa_configuration #=> String, one of "OFF", "ON", "OPTIONAL"
6169
6372
  #
@@ -6186,7 +6389,8 @@ module Aws::CognitoIdentityProvider
6186
6389
  # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserMFAPreference.html
6187
6390
  #
6188
6391
  # @option params [required, String] :access_token
6189
- # The access token for the set user settings request.
6392
+ # A valid access token that Amazon Cognito issued to the user whose user
6393
+ # settings you want to configure.
6190
6394
  #
6191
6395
  # @option params [required, Array<Types::MFAOptionType>] :mfa_options
6192
6396
  # You can use this parameter only to set an SMS configuration that uses
@@ -6220,22 +6424,22 @@ module Aws::CognitoIdentityProvider
6220
6424
  #
6221
6425
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
6222
6426
  # US telecom carriers require you to register an origination phone
6223
- # number before you can send SMS messages to U.S. phone numbers. If you
6427
+ # number before you can send SMS messages to US phone numbers. If you
6224
6428
  # use SMS text messages in Amazon Cognito, you must register a phone
6225
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
6226
- # registered number automatically. Otherwise, Amazon Cognito users that
6227
- # must receive SMS messages might be unable to sign up, activate their
6228
- # accounts, or sign in.
6429
+ # number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
6430
+ # number automatically. Otherwise, Amazon Cognito users who must receive
6431
+ # SMS messages might not be able to sign up, activate their accounts, or
6432
+ # sign in.
6229
6433
  #
6230
6434
  # If you have never used SMS text messages with Amazon Cognito or any
6231
6435
  # other Amazon Web Service, Amazon Simple Notification Service might
6232
- # place your account in SMS sandbox. In <i> <a
6436
+ # place your account in the SMS sandbox. In <i> <a
6233
6437
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
6234
- # mode</a> </i>, you will have limitations, such as sending messages
6235
- # only to verified phone numbers. After testing in the sandbox
6236
- # environment, you can move out of the SMS sandbox and into production.
6237
- # For more information, see [ SMS message settings for Amazon Cognito
6238
- # User Pools][2] in the *Amazon Cognito Developer Guide*.
6438
+ # mode</a> </i>, you can send messages only to verified phone numbers.
6439
+ # After you test your app while in the sandbox environment, you can move
6440
+ # out of the sandbox and into production. For more information, see [
6441
+ # SMS message settings for Amazon Cognito user pools][2] in the *Amazon
6442
+ # Cognito Developer Guide*.
6239
6443
  #
6240
6444
  # </note>
6241
6445
  #
@@ -6268,13 +6472,15 @@ module Aws::CognitoIdentityProvider
6268
6472
  # The validation data in the request to register a user.
6269
6473
  #
6270
6474
  # @option params [Types::AnalyticsMetadataType] :analytics_metadata
6271
- # The Amazon Pinpoint analytics metadata for collecting metrics for
6272
- # `SignUp` calls.
6475
+ # The Amazon Pinpoint analytics metadata that contributes to your
6476
+ # metrics for `SignUp` calls.
6273
6477
  #
6274
6478
  # @option params [Types::UserContextDataType] :user_context_data
6275
- # Contextual data such as the user's device fingerprint, IP address, or
6276
- # location used for evaluating the risk of an unexpected event by Amazon
6277
- # Cognito advanced security.
6479
+ # Contextual data about your user session, such as the device
6480
+ # fingerprint, IP address, or location. Amazon Cognito advanced security
6481
+ # evaluates the risk of an authentication event based on the context
6482
+ # that your app generates and passes to Amazon Cognito when it makes API
6483
+ # requests.
6278
6484
  #
6279
6485
  # @option params [Hash<String,String>] :client_metadata
6280
6486
  # A map of custom key-value pairs that you can provide as input for any
@@ -6291,8 +6497,8 @@ module Aws::CognitoIdentityProvider
6291
6497
  # function code in Lambda, you can process the `clientMetadata` value to
6292
6498
  # enhance your workflow for your specific needs.
6293
6499
  #
6294
- # For more information, see [Customizing User Pool Workflows with Lambda
6295
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
6500
+ # For more information, see [ Customizing user pool Workflows with
6501
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
6296
6502
  #
6297
6503
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
6298
6504
  # Cognito won't do the following:
@@ -6342,6 +6548,7 @@ module Aws::CognitoIdentityProvider
6342
6548
  # analytics_endpoint_id: "StringType",
6343
6549
  # },
6344
6550
  # user_context_data: {
6551
+ # ip_address: "StringType",
6345
6552
  # encoded_data: "StringType",
6346
6553
  # },
6347
6554
  # client_metadata: {
@@ -6574,7 +6781,8 @@ module Aws::CognitoIdentityProvider
6574
6781
  # Updates the device status.
6575
6782
  #
6576
6783
  # @option params [required, String] :access_token
6577
- # The access token.
6784
+ # A valid access token that Amazon Cognito issued to the user whose
6785
+ # device status you want to update.
6578
6786
  #
6579
6787
  # @option params [required, String] :device_key
6580
6788
  # The device key.
@@ -6660,23 +6868,23 @@ module Aws::CognitoIdentityProvider
6660
6868
  req.send_request(options)
6661
6869
  end
6662
6870
 
6663
- # Updates identity provider information for a user pool.
6871
+ # Updates IdP information for a user pool.
6664
6872
  #
6665
6873
  # @option params [required, String] :user_pool_id
6666
6874
  # The user pool ID.
6667
6875
  #
6668
6876
  # @option params [required, String] :provider_name
6669
- # The identity provider name.
6877
+ # The IdP name.
6670
6878
  #
6671
6879
  # @option params [Hash<String,String>] :provider_details
6672
- # The identity provider details to be updated, such as `MetadataURL` and
6880
+ # The IdP details to be updated, such as `MetadataURL` and
6673
6881
  # `MetadataFile`.
6674
6882
  #
6675
6883
  # @option params [Hash<String,String>] :attribute_mapping
6676
- # The identity provider attribute mapping to be changed.
6884
+ # The IdP attribute mapping to be changed.
6677
6885
  #
6678
6886
  # @option params [Array<String>] :idp_identifiers
6679
- # A list of identity provider identifiers.
6887
+ # A list of IdP identifiers.
6680
6888
  #
6681
6889
  # @return [Types::UpdateIdentityProviderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6682
6890
  #
@@ -6777,22 +6985,22 @@ module Aws::CognitoIdentityProvider
6777
6985
  #
6778
6986
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
6779
6987
  # US telecom carriers require you to register an origination phone
6780
- # number before you can send SMS messages to U.S. phone numbers. If you
6988
+ # number before you can send SMS messages to US phone numbers. If you
6781
6989
  # use SMS text messages in Amazon Cognito, you must register a phone
6782
- # number with [Amazon Pinpoint][1]. Amazon Cognito will use the
6783
- # registered number automatically. Otherwise, Amazon Cognito users that
6784
- # must receive SMS messages might be unable to sign up, activate their
6785
- # accounts, or sign in.
6990
+ # number with [Amazon Pinpoint][1]. Amazon Cognito uses the registered
6991
+ # number automatically. Otherwise, Amazon Cognito users who must receive
6992
+ # SMS messages might not be able to sign up, activate their accounts, or
6993
+ # sign in.
6786
6994
  #
6787
6995
  # If you have never used SMS text messages with Amazon Cognito or any
6788
6996
  # other Amazon Web Service, Amazon Simple Notification Service might
6789
- # place your account in SMS sandbox. In <i> <a
6997
+ # place your account in the SMS sandbox. In <i> <a
6790
6998
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
6791
- # mode</a> </i>, you will have limitations, such as sending messages
6792
- # only to verified phone numbers. After testing in the sandbox
6793
- # environment, you can move out of the SMS sandbox and into production.
6794
- # For more information, see [ SMS message settings for Amazon Cognito
6795
- # User Pools][2] in the *Amazon Cognito Developer Guide*.
6999
+ # mode</a> </i>, you can send messages only to verified phone numbers.
7000
+ # After you test your app while in the sandbox environment, you can move
7001
+ # out of the sandbox and into production. For more information, see [
7002
+ # SMS message settings for Amazon Cognito user pools][2] in the *Amazon
7003
+ # Cognito Developer Guide*.
6796
7004
  #
6797
7005
  # </note>
6798
7006
  #
@@ -6807,8 +7015,16 @@ module Aws::CognitoIdentityProvider
6807
7015
  # For custom attributes, you must prepend the `custom:` prefix to the
6808
7016
  # attribute name.
6809
7017
  #
7018
+ # If you have set an attribute to require verification before Amazon
7019
+ # Cognito updates its value, this request doesn’t immediately update the
7020
+ # value of that attribute. After your user receives and responds to a
7021
+ # verification message to verify the new value, Amazon Cognito updates
7022
+ # the attribute value. Your user can sign in and receive messages with
7023
+ # the original attribute value until they verify the new value.
7024
+ #
6810
7025
  # @option params [required, String] :access_token
6811
- # The access token for the request to update user attributes.
7026
+ # A valid access token that Amazon Cognito issued to the user whose user
7027
+ # attributes you want to update.
6812
7028
  #
6813
7029
  # @option params [Hash<String,String>] :client_metadata
6814
7030
  # A map of custom key-value pairs that you can provide as input for any
@@ -6824,8 +7040,8 @@ module Aws::CognitoIdentityProvider
6824
7040
  # In your function code in Lambda, you can process the `clientMetadata`
6825
7041
  # value to enhance your workflow for your specific needs.
6826
7042
  #
6827
- # For more information, see [Customizing User Pool Workflows with Lambda
6828
- # Triggers][1] in the *Amazon Cognito Developer Guide*.
7043
+ # For more information, see [ Customizing user pool Workflows with
7044
+ # Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
6829
7045
  #
6830
7046
  # <note markdown="1"> When you use the ClientMetadata parameter, remember that Amazon
6831
7047
  # Cognito won't do the following:
@@ -6888,22 +7104,22 @@ module Aws::CognitoIdentityProvider
6888
7104
  #
6889
7105
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
6890
7106
  # US telecom carriers require you to register an origination phone
6891
- # number before you can send SMS messages to U.S. phone numbers. If you
7107
+ # number before you can send SMS messages to US phone numbers. If you
6892
7108
  # use SMS text messages in Amazon Cognito, you must register a phone
6893
- # number with [Amazon Pinpoint][2]. Amazon Cognito will use the
6894
- # registered number automatically. Otherwise, Amazon Cognito users that
6895
- # must receive SMS messages might be unable to sign up, activate their
6896
- # accounts, or sign in.
7109
+ # number with [Amazon Pinpoint][2]. Amazon Cognito uses the registered
7110
+ # number automatically. Otherwise, Amazon Cognito users who must receive
7111
+ # SMS messages might not be able to sign up, activate their accounts, or
7112
+ # sign in.
6897
7113
  #
6898
7114
  # If you have never used SMS text messages with Amazon Cognito or any
6899
7115
  # other Amazon Web Service, Amazon Simple Notification Service might
6900
- # place your account in SMS sandbox. In <i> <a
7116
+ # place your account in the SMS sandbox. In <i> <a
6901
7117
  # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
6902
- # mode</a> </i>, you will have limitations, such as sending messages
6903
- # only to verified phone numbers. After testing in the sandbox
6904
- # environment, you can move out of the SMS sandbox and into production.
6905
- # For more information, see [ SMS message settings for Amazon Cognito
6906
- # User Pools][3] in the *Amazon Cognito Developer Guide*.
7118
+ # mode</a> </i>, you can send messages only to verified phone numbers.
7119
+ # After you test your app while in the sandbox environment, you can move
7120
+ # out of the sandbox and into production. For more information, see [
7121
+ # SMS message settings for Amazon Cognito user pools][3] in the *Amazon
7122
+ # Cognito Developer Guide*.
6907
7123
  #
6908
7124
  # </note>
6909
7125
  #
@@ -6942,8 +7158,20 @@ module Aws::CognitoIdentityProvider
6942
7158
  # @option params [String] :sms_authentication_message
6943
7159
  # The contents of the SMS authentication message.
6944
7160
  #
7161
+ # @option params [Types::UserAttributeUpdateSettingsType] :user_attribute_update_settings
7162
+ # The settings for updates to user attributes. These settings include
7163
+ # the property `AttributesRequireVerificationBeforeUpdate`, a user-pool
7164
+ # setting that tells Amazon Cognito how to handle changes to the value
7165
+ # of your users' email address and phone number attributes. For more
7166
+ # information, see [ Verifying updates to to email addresses and phone
7167
+ # numbers][1].
7168
+ #
7169
+ #
7170
+ #
7171
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates
7172
+ #
6945
7173
  # @option params [String] :mfa_configuration
6946
- # Can be one of the following values:
7174
+ # Possible values include:
6947
7175
  #
6948
7176
  # * `OFF` - MFA tokens aren't required and can't be specified during
6949
7177
  # user registration.
@@ -6964,10 +7192,18 @@ module Aws::CognitoIdentityProvider
6964
7192
  # Device configuration.
6965
7193
  #
6966
7194
  # @option params [Types::EmailConfigurationType] :email_configuration
6967
- # Email configuration.
7195
+ # The email configuration of your user pool. The email configuration
7196
+ # type sets your preferred sending method, Amazon Web Services Region,
7197
+ # and sender for email invitation and verification messages from your
7198
+ # user pool.
6968
7199
  #
6969
7200
  # @option params [Types::SmsConfigurationType] :sms_configuration
6970
- # SMS configuration.
7201
+ # The SMS configuration with the settings that your Amazon Cognito user
7202
+ # pool must use to send an SMS message from your Amazon Web Services
7203
+ # account through Amazon Simple Notification Service. To send SMS
7204
+ # messages with Amazon SNS in the Amazon Web Services Region that you
7205
+ # want, the Amazon Cognito user pool uses an Identity and Access
7206
+ # Management (IAM) role in your Amazon Web Services account.
6971
7207
  #
6972
7208
  # @option params [Hash<String,String>] :user_pool_tags
6973
7209
  # The tag keys and values to assign to the user pool. A tag is a label
@@ -7041,6 +7277,9 @@ module Aws::CognitoIdentityProvider
7041
7277
  # default_email_option: "CONFIRM_WITH_LINK", # accepts CONFIRM_WITH_LINK, CONFIRM_WITH_CODE
7042
7278
  # },
7043
7279
  # sms_authentication_message: "SmsVerificationMessageType",
7280
+ # user_attribute_update_settings: {
7281
+ # attributes_require_verification_before_update: ["phone_number"], # accepts phone_number, email
7282
+ # },
7044
7283
  # mfa_configuration: "OFF", # accepts OFF, ON, OPTIONAL
7045
7284
  # device_configuration: {
7046
7285
  # challenge_required_on_new_device: false,
@@ -7056,6 +7295,7 @@ module Aws::CognitoIdentityProvider
7056
7295
  # sms_configuration: {
7057
7296
  # sns_caller_arn: "ArnType", # required
7058
7297
  # external_id: "StringType",
7298
+ # sns_region: "RegionCodeType",
7059
7299
  # },
7060
7300
  # user_pool_tags: {
7061
7301
  # "TagKeysType" => "TagValueType",
@@ -7118,20 +7358,50 @@ module Aws::CognitoIdentityProvider
7118
7358
  # The client name from the update user pool client request.
7119
7359
  #
7120
7360
  # @option params [Integer] :refresh_token_validity
7121
- # The time limit, in days, after which the refresh token is no longer
7122
- # valid and can't be used.
7361
+ # The refresh token time limit. After this limit expires, your user
7362
+ # can't use their refresh token. To specify the time unit for
7363
+ # `RefreshTokenValidity` as `seconds`, `minutes`, `hours`, or `days`,
7364
+ # set a `TokenValidityUnits` value in your API request.
7365
+ #
7366
+ # For example, when you set `RefreshTokenValidity` as `10` and
7367
+ # `TokenValidityUnits` as `days`, your user can refresh their session
7368
+ # and retrieve new access and ID tokens for 10 days.
7369
+ #
7370
+ # The default time unit for `RefreshTokenValidity` in an API request is
7371
+ # days. You can't set `RefreshTokenValidity` to 0. If you do, Amazon
7372
+ # Cognito overrides the value with the default value of 30 days. *Valid
7373
+ # range* is displayed below in seconds.
7123
7374
  #
7124
7375
  # @option params [Integer] :access_token_validity
7125
- # The time limit after which the access token is no longer valid and
7126
- # can't be used.
7376
+ # The access token time limit. After this limit expires, your user
7377
+ # can't use their access token. To specify the time unit for
7378
+ # `AccessTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set
7379
+ # a `TokenValidityUnits` value in your API request.
7380
+ #
7381
+ # For example, when you set `AccessTokenValidity` to `10` and
7382
+ # `TokenValidityUnits` to `hours`, your user can authorize access with
7383
+ # their access token for 10 hours.
7384
+ #
7385
+ # The default time unit for `AccessTokenValidity` in an API request is
7386
+ # hours. *Valid range* is displayed below in seconds.
7127
7387
  #
7128
7388
  # @option params [Integer] :id_token_validity
7129
- # The time limit after which the ID token is no longer valid and can't
7130
- # be used.
7389
+ # The ID token time limit. After this limit expires, your user can't
7390
+ # use their ID token. To specify the time unit for `IdTokenValidity` as
7391
+ # `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits`
7392
+ # value in your API request.
7393
+ #
7394
+ # For example, when you set `IdTokenValidity` as `10` and
7395
+ # `TokenValidityUnits` as `hours`, your user can authenticate their
7396
+ # session with their ID token for 10 hours.
7397
+ #
7398
+ # The default time unit for `AccessTokenValidity` in an API request is
7399
+ # hours. *Valid range* is displayed below in seconds.
7131
7400
  #
7132
7401
  # @option params [Types::TokenValidityUnitsType] :token_validity_units
7133
- # The units in which the validity times are represented. Default for
7134
- # RefreshToken is days, and default for ID and access tokens is hours.
7402
+ # The units in which the validity times are represented. The default
7403
+ # unit for RefreshToken is days, and the default for ID and access
7404
+ # tokens is hours.
7135
7405
  #
7136
7406
  # @option params [Array<String>] :read_attributes
7137
7407
  # The read-only attributes of the user pool.
@@ -7166,11 +7436,12 @@ module Aws::CognitoIdentityProvider
7166
7436
  # * `ALLOW_REFRESH_TOKEN_AUTH`\: Enable authflow to refresh tokens.
7167
7437
  #
7168
7438
  # @option params [Array<String>] :supported_identity_providers
7169
- # A list of provider names for the identity providers that are supported
7170
- # on this client.
7439
+ # A list of provider names for the IdPs that this client supports. The
7440
+ # following are supported: `COGNITO`, `Facebook`, `Google`
7441
+ # `LoginWithAmazon`, and the names of your own SAML and OIDC providers.
7171
7442
  #
7172
7443
  # @option params [Array<String>] :callback_urls
7173
- # A list of allowed redirect (callback) URLs for the identity providers.
7444
+ # A list of allowed redirect (callback) URLs for the IdPs.
7174
7445
  #
7175
7446
  # A redirect URI must:
7176
7447
  #
@@ -7192,7 +7463,7 @@ module Aws::CognitoIdentityProvider
7192
7463
  # [1]: https://tools.ietf.org/html/rfc6749#section-3.1.2
7193
7464
  #
7194
7465
  # @option params [Array<String>] :logout_urls
7195
- # A list of allowed logout URLs for the identity providers.
7466
+ # A list of allowed logout URLs for the IdPs.
7196
7467
  #
7197
7468
  # @option params [String] :default_redirect_uri
7198
7469
  # The default redirect URI. Must be in the `CallbackURLs` list.
@@ -7219,35 +7490,42 @@ module Aws::CognitoIdentityProvider
7219
7490
  # @option params [Array<String>] :allowed_o_auth_flows
7220
7491
  # The allowed OAuth flows.
7221
7492
  #
7222
- # Set to `code` to initiate a code grant flow, which provides an
7223
- # authorization code as the response. This code can be exchanged for
7224
- # access tokens with the token endpoint.
7493
+ # code
7225
7494
  #
7226
- # Set to `implicit` to specify that the client should get the access
7227
- # token (and, optionally, ID token, based on scopes) directly.
7495
+ # : Use a code grant flow, which provides an authorization code as the
7496
+ # response. This code can be exchanged for access tokens with the
7497
+ # `/oauth2/token` endpoint.
7228
7498
  #
7229
- # Set to `client_credentials` to specify that the client should get the
7230
- # access token (and, optionally, ID token, based on scopes) from the
7231
- # token endpoint using a combination of client and client\_secret.
7499
+ # implicit
7500
+ #
7501
+ # : Issue the access token (and, optionally, ID token, based on scopes)
7502
+ # directly to your user.
7503
+ #
7504
+ # client\_credentials
7505
+ #
7506
+ # : Issue the access token from the `/oauth2/token` endpoint directly to
7507
+ # a non-person user using a combination of the client ID and client
7508
+ # secret.
7232
7509
  #
7233
7510
  # @option params [Array<String>] :allowed_o_auth_scopes
7234
- # The allowed OAuth scopes. Possible values provided by OAuth are:
7511
+ # The allowed OAuth scopes. Possible values provided by OAuth are
7235
7512
  # `phone`, `email`, `openid`, and `profile`. Possible values provided by
7236
- # Amazon Web Services are: `aws.cognito.signin.user.admin`. Custom
7237
- # scopes created in Resource Servers are also supported.
7513
+ # Amazon Web Services are `aws.cognito.signin.user.admin`. Custom scopes
7514
+ # created in Resource Servers are also supported.
7238
7515
  #
7239
7516
  # @option params [Boolean] :allowed_o_auth_flows_user_pool_client
7240
7517
  # Set to true if the client is allowed to follow the OAuth protocol when
7241
7518
  # interacting with Amazon Cognito user pools.
7242
7519
  #
7243
7520
  # @option params [Types::AnalyticsConfigurationType] :analytics_configuration
7244
- # The Amazon Pinpoint analytics configuration for collecting metrics for
7245
- # this user pool.
7521
+ # The Amazon Pinpoint analytics configuration necessary to collect
7522
+ # metrics for this user pool.
7246
7523
  #
7247
- # <note markdown="1"> In Amazon Web Services Regions where isn't available, User Pools only
7248
- # supports sending events to Amazon Pinpoint projects in us-east-1. In
7249
- # Regions where Pinpoint is available, User Pools will support sending
7250
- # events to Amazon Pinpoint projects within that same Region.
7524
+ # <note markdown="1"> In Amazon Web Services Regions where Amazon Pinpoint isn't available,
7525
+ # user pools only support sending events to Amazon Pinpoint projects in
7526
+ # us-east-1. In Regions where Amazon Pinpoint is available, user pools
7527
+ # support sending events to Amazon Pinpoint projects within that same
7528
+ # Region.
7251
7529
  #
7252
7530
  # </note>
7253
7531
  #
@@ -7277,6 +7555,19 @@ module Aws::CognitoIdentityProvider
7277
7555
  #
7278
7556
  # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html
7279
7557
  #
7558
+ # @option params [Boolean] :enable_propagate_additional_user_context_data
7559
+ # Activates the propagation of additional user context data. For more
7560
+ # information about propagation of user context data, see [ Adding
7561
+ # advanced security to a user pool][1]. If you don’t include this
7562
+ # parameter, you can't send device fingerprint information, including
7563
+ # source IP address, to Amazon Cognito advanced security. You can only
7564
+ # activate `EnablePropagateAdditionalUserContextData` in an app client
7565
+ # that has a client secret.
7566
+ #
7567
+ #
7568
+ #
7569
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html
7570
+ #
7280
7571
  # @return [Types::UpdateUserPoolClientResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7281
7572
  #
7282
7573
  # * {Types::UpdateUserPoolClientResponse#user_pool_client #user_pool_client} => Types::UserPoolClientType
@@ -7314,6 +7605,7 @@ module Aws::CognitoIdentityProvider
7314
7605
  # },
7315
7606
  # prevent_user_existence_errors: "LEGACY", # accepts LEGACY, ENABLED
7316
7607
  # enable_token_revocation: false,
7608
+ # enable_propagate_additional_user_context_data: false,
7317
7609
  # })
7318
7610
  #
7319
7611
  # @example Response structure
@@ -7355,6 +7647,7 @@ module Aws::CognitoIdentityProvider
7355
7647
  # resp.user_pool_client.analytics_configuration.user_data_shared #=> Boolean
7356
7648
  # resp.user_pool_client.prevent_user_existence_errors #=> String, one of "LEGACY", "ENABLED"
7357
7649
  # resp.user_pool_client.enable_token_revocation #=> Boolean
7650
+ # resp.user_pool_client.enable_propagate_additional_user_context_data #=> Boolean
7358
7651
  #
7359
7652
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPoolClient AWS API Documentation
7360
7653
  #
@@ -7451,7 +7744,8 @@ module Aws::CognitoIdentityProvider
7451
7744
  # session string, but not both.
7452
7745
  #
7453
7746
  # @option params [String] :access_token
7454
- # The access token.
7747
+ # A valid access token that Amazon Cognito issued to the user whose
7748
+ # software token you want to verify.
7455
7749
  #
7456
7750
  # @option params [String] :session
7457
7751
  # The session that should be passed both ways in challenge-response
@@ -7498,8 +7792,18 @@ module Aws::CognitoIdentityProvider
7498
7792
 
7499
7793
  # Verifies the specified user attributes in the user pool.
7500
7794
  #
7795
+ # If your user pool requires verification before Amazon Cognito updates
7796
+ # the attribute value, VerifyUserAttribute updates the affected
7797
+ # attribute to its pending value. For more information, see [
7798
+ # UserAttributeUpdateSettingsType][1].
7799
+ #
7800
+ #
7801
+ #
7802
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserAttributeUpdateSettingsType.html
7803
+ #
7501
7804
  # @option params [required, String] :access_token
7502
- # The access token of the request to verify user attributes.
7805
+ # A valid access token that Amazon Cognito issued to the user whose user
7806
+ # attributes you want to verify.
7503
7807
  #
7504
7808
  # @option params [required, String] :attribute_name
7505
7809
  # The attribute name in the request to verify user attributes.
@@ -7539,7 +7843,7 @@ module Aws::CognitoIdentityProvider
7539
7843
  params: params,
7540
7844
  config: config)
7541
7845
  context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
7542
- context[:gem_version] = '1.64.0'
7846
+ context[:gem_version] = '1.67.0'
7543
7847
  Seahorse::Client::Request.new(handlers, context)
7544
7848
  end
7545
7849