aws-sdk-cognitoidentityprovider 1.66.0 → 1.69.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 222aac64f4eed68afada8159643dcfcc46ecb036a71fd6babde3aa7fe6fd2265
4
- data.tar.gz: fce9b8e9f33f66c1d04d8f42dbf5d3bd7d577ec4ecbb684ec986659f457bf1b6
3
+ metadata.gz: 3b0c1b613846b2cdb2ea2fee658581c78c8789b0df7ced9d753fabeccb7c4af3
4
+ data.tar.gz: abf38571520a1bcc81ee854f42e974ec1674295c211dcc3a52becf2063caa085
5
5
  SHA512:
6
- metadata.gz: f2eb8646cdc7dff95a6b45c692ca225fbddfa1a2d75e89406444e9a61c329784bc922b6c8ebb053a92c72b82c1d43b43cc1d246b9b7b5fd75b609d4b08407a3c
7
- data.tar.gz: 189cda1a984127d8261e32ceaae7b9e5a07bd368c2ffbc2593d9c271d77407c0e7bf9eee5cbb0494a8936995e543a53f89d9098a787ace324c59bd0648722f67
6
+ metadata.gz: 9b14e79d8a9a0de573aa119daef864172f8f7b107e380b8efb4d43a9a97a7e05cbc57e776bfe88cf59dd9e705bce00c26437fe8191d3aaf18c662d73d2053918
7
+ data.tar.gz: 0ea7ea807c66af61286903e2df84da3d59a95fbaf0be9c5cd6db53b020f7a89a1e81f7f942048b9d476d2882572769ccf123807123f9c570b3d8edd8f0cac712
data/CHANGELOG.md CHANGED
@@ -1,6 +1,21 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.69.0 (2022-08-18)
5
+ ------------------
6
+
7
+ * Feature - This change is being made simply to fix the public documentation based on the models. We have included the PasswordChange and ResendCode events, along with the Pass, Fail and InProgress status. We have removed the Success and Failure status which are never returned by our APIs.
8
+
9
+ 1.68.0 (2022-08-03)
10
+ ------------------
11
+
12
+ * Feature - Add a new exception type, ForbiddenException, that is returned when request is not allowed
13
+
14
+ 1.67.0 (2022-05-31)
15
+ ------------------
16
+
17
+ * Feature - Amazon Cognito now supports IP Address propagation for all unauthenticated APIs (e.g. SignUp, ForgotPassword).
18
+
4
19
  1.66.0 (2022-05-24)
5
20
  ------------------
6
21
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.66.0
1
+ 1.69.0
@@ -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
  #
@@ -1523,9 +1525,9 @@ module Aws::CognitoIdentityProvider
1523
1525
  #
1524
1526
  # resp.auth_events #=> Array
1525
1527
  # resp.auth_events[0].event_id #=> String
1526
- # resp.auth_events[0].event_type #=> String, one of "SignIn", "SignUp", "ForgotPassword"
1528
+ # resp.auth_events[0].event_type #=> String, one of "SignIn", "SignUp", "ForgotPassword", "PasswordChange", "ResendCode"
1527
1529
  # resp.auth_events[0].creation_date #=> Time
1528
- # resp.auth_events[0].event_response #=> String, one of "Success", "Failure"
1530
+ # resp.auth_events[0].event_response #=> String, one of "Pass", "Fail", "InProgress"
1529
1531
  # resp.auth_events[0].event_risk.risk_decision #=> String, one of "NoRisk", "AccountTakeover", "Block"
1530
1532
  # resp.auth_events[0].event_risk.risk_level #=> String, one of "Low", "Medium", "High"
1531
1533
  # resp.auth_events[0].event_risk.compromised_credentials_detected #=> Boolean
@@ -1791,9 +1793,11 @@ module Aws::CognitoIdentityProvider
1791
1793
  # `AdminRespondToAuthChallenge` calls.
1792
1794
  #
1793
1795
  # @option params [Types::ContextDataType] :context_data
1794
- # Contextual data such as the user's device fingerprint, IP address, or
1795
- # location used for evaluating the risk of an unexpected event by Amazon
1796
- # 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.
1797
1801
  #
1798
1802
  # @option params [Hash<String,String>] :client_metadata
1799
1803
  # A map of custom key-value pairs that you can provide as input for any
@@ -2282,20 +2286,32 @@ module Aws::CognitoIdentityProvider
2282
2286
  req.send_request(options)
2283
2287
  end
2284
2288
 
2285
- # Returns a unique generated shared secret key code for the user
2286
- # account. The request takes an access token or a session string, but
2287
- # not both.
2288
- #
2289
- # <note markdown="1"> Calling AssociateSoftwareToken immediately disassociates the existing
2290
- # software token from the user account. If the user doesn't
2291
- # subsequently verify the software token, their account is set up to
2292
- # authenticate without MFA. If MFA config is set to Optional at the user
2293
- # pool level, the user can then log in without MFA. However, if MFA is
2294
- # set to Required for the user pool, the user is asked to set up a new
2295
- # software token MFA during sign-in.
2289
+ # Begins setup of time-based one-time password (TOTP) multi-factor
2290
+ # authentication (MFA) for a user, with a unique private key that Amazon
2291
+ # Cognito generates and returns in the API response. You can authorize
2292
+ # an `AssociateSoftwareToken` request with either the user's access
2293
+ # token, or a session string from a challenge response that you received
2294
+ # 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.
2296
2308
  #
2297
2309
  # </note>
2298
2310
  #
2311
+ #
2312
+ #
2313
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifySoftwareToken.html
2314
+ #
2299
2315
  # @option params [String] :access_token
2300
2316
  # A valid access token that Amazon Cognito issued to the user whose
2301
2317
  # software token you want to generate.
@@ -2423,25 +2439,26 @@ module Aws::CognitoIdentityProvider
2423
2439
  # retrieve a forgotten password.
2424
2440
  #
2425
2441
  # @option params [required, String] :confirmation_code
2426
- # The confirmation code sent by a user's request to retrieve a
2427
- # forgotten password. For more information, see [ForgotPassword][1].
2442
+ # The confirmation code from your user's request to reset their
2443
+ # password. For more information, see [ForgotPassword][1].
2428
2444
  #
2429
2445
  #
2430
2446
  #
2431
2447
  # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ForgotPassword.html
2432
2448
  #
2433
2449
  # @option params [required, String] :password
2434
- # The password sent by a user's request to retrieve a forgotten
2435
- # password.
2450
+ # The new password that your user wants to set.
2436
2451
  #
2437
2452
  # @option params [Types::AnalyticsMetadataType] :analytics_metadata
2438
2453
  # The Amazon Pinpoint analytics metadata for collecting metrics for
2439
2454
  # `ConfirmForgotPassword` calls.
2440
2455
  #
2441
2456
  # @option params [Types::UserContextDataType] :user_context_data
2442
- # Contextual data such as the user's device fingerprint, IP address, or
2443
- # location used for evaluating the risk of an unexpected event by Amazon
2444
- # Cognito advanced security.
2457
+ # Contextual data about your user session, such as the device
2458
+ # fingerprint, IP address, or location. Amazon Cognito advanced security
2459
+ # evaluates the risk of an authentication event based on the context
2460
+ # that your app generates and passes to Amazon Cognito when it makes API
2461
+ # requests.
2445
2462
  #
2446
2463
  # @option params [Hash<String,String>] :client_metadata
2447
2464
  # A map of custom key-value pairs that you can provide as input for any
@@ -2494,6 +2511,7 @@ module Aws::CognitoIdentityProvider
2494
2511
  # analytics_endpoint_id: "StringType",
2495
2512
  # },
2496
2513
  # user_context_data: {
2514
+ # ip_address: "StringType",
2497
2515
  # encoded_data: "StringType",
2498
2516
  # },
2499
2517
  # client_metadata: {
@@ -2541,9 +2559,11 @@ module Aws::CognitoIdentityProvider
2541
2559
  # `ConfirmSignUp` calls.
2542
2560
  #
2543
2561
  # @option params [Types::UserContextDataType] :user_context_data
2544
- # Contextual data such as the user's device fingerprint, IP address, or
2545
- # location used for evaluating the risk of an unexpected event by Amazon
2546
- # Cognito advanced security.
2562
+ # Contextual data about your user session, such as the device
2563
+ # fingerprint, IP address, or location. Amazon Cognito advanced security
2564
+ # evaluates the risk of an authentication event based on the context
2565
+ # that your app generates and passes to Amazon Cognito when it makes API
2566
+ # requests.
2547
2567
  #
2548
2568
  # @option params [Hash<String,String>] :client_metadata
2549
2569
  # A map of custom key-value pairs that you can provide as input for any
@@ -2595,6 +2615,7 @@ module Aws::CognitoIdentityProvider
2595
2615
  # analytics_endpoint_id: "StringType",
2596
2616
  # },
2597
2617
  # user_context_data: {
2618
+ # ip_address: "StringType",
2598
2619
  # encoded_data: "StringType",
2599
2620
  # },
2600
2621
  # client_metadata: {
@@ -2988,7 +3009,7 @@ module Aws::CognitoIdentityProvider
2988
3009
  #
2989
3010
  # @option params [String] :email_verification_message
2990
3011
  # A string representing the email verification message.
2991
- # EmailVerificationMessage is allowed only if [EmailSendingAccount][1]
3012
+ # `EmailVerificationMessage` is allowed only if [EmailSendingAccount][1]
2992
3013
  # is DEVELOPER.
2993
3014
  #
2994
3015
  #
@@ -2997,7 +3018,7 @@ module Aws::CognitoIdentityProvider
2997
3018
  #
2998
3019
  # @option params [String] :email_verification_subject
2999
3020
  # A string representing the email verification subject.
3000
- # EmailVerificationSubject is allowed only if [EmailSendingAccount][1]
3021
+ # `EmailVerificationSubject` is allowed only if [EmailSendingAccount][1]
3001
3022
  # is DEVELOPER.
3002
3023
  #
3003
3024
  #
@@ -3015,9 +3036,26 @@ module Aws::CognitoIdentityProvider
3015
3036
  # Specifies MFA configuration details.
3016
3037
  #
3017
3038
  # @option params [Types::UserAttributeUpdateSettingsType] :user_attribute_update_settings
3039
+ # The settings for updates to user attributes. These settings include
3040
+ # the property `AttributesRequireVerificationBeforeUpdate`, a user-pool
3041
+ # setting that tells Amazon Cognito how to handle changes to the value
3042
+ # of your users' email address and phone number attributes. For more
3043
+ # information, see [ Verifying updates to email addresses and phone
3044
+ # numbers][1].
3045
+ #
3046
+ #
3047
+ #
3048
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates
3018
3049
  #
3019
3050
  # @option params [Types::DeviceConfigurationType] :device_configuration
3020
- # The device configuration.
3051
+ # The device-remembering configuration for a user pool. A null value
3052
+ # indicates that you have deactivated device remembering in your user
3053
+ # pool.
3054
+ #
3055
+ # <note markdown="1"> When you provide a value for any `DeviceConfiguration` field, you
3056
+ # activate the Amazon Cognito device-remembering feature.
3057
+ #
3058
+ # </note>
3021
3059
  #
3022
3060
  # @option params [Types::EmailConfigurationType] :email_configuration
3023
3061
  # The email configuration of your user pool. The email configuration
@@ -3380,31 +3418,41 @@ module Aws::CognitoIdentityProvider
3380
3418
  #
3381
3419
  # Valid values include:
3382
3420
  #
3383
- # * `ALLOW_ADMIN_USER_PASSWORD_AUTH`\: Enable admin based user password
3384
- # authentication flow `ADMIN_USER_PASSWORD_AUTH`. This setting
3385
- # replaces the `ADMIN_NO_SRP_AUTH` setting. With this authentication
3386
- # flow, Amazon Cognito receives the password in the request instead of
3387
- # using the Secure Remote Password (SRP) protocol to verify passwords.
3421
+ # ALLOW\_ADMIN\_USER\_PASSWORD\_AUTH
3388
3422
  #
3389
- # * `ALLOW_CUSTOM_AUTH`\: Enable Lambda trigger based authentication.
3423
+ # : Enable admin based user password authentication flow
3424
+ # `ADMIN_USER_PASSWORD_AUTH`. This setting replaces the
3425
+ # `ADMIN_NO_SRP_AUTH` setting. With this authentication flow, Amazon
3426
+ # Cognito receives the password in the request instead of using the
3427
+ # Secure Remote Password (SRP) protocol to verify passwords.
3390
3428
  #
3391
- # * `ALLOW_USER_PASSWORD_AUTH`\: Enable user password-based
3392
- # authentication. In this flow, Amazon Cognito receives the password
3393
- # in the request instead of using the SRP protocol to verify
3394
- # passwords.
3429
+ # ALLOW\_CUSTOM\_AUTH
3395
3430
  #
3396
- # * `ALLOW_USER_SRP_AUTH`\: Enable SRP-based authentication.
3431
+ # : Enable Lambda trigger based authentication.
3397
3432
  #
3398
- # * `ALLOW_REFRESH_TOKEN_AUTH`\: Enable authflow to refresh tokens.
3433
+ # ALLOW\_USER\_PASSWORD\_AUTH
3399
3434
  #
3400
- # If you don't specify a value for `ExplicitAuthFlows`, your app client
3401
- # activates the `ALLOW_USER_SRP_AUTH` and `ALLOW_CUSTOM_AUTH`
3402
- # authentication flows.
3435
+ # : Enable user password-based authentication. In this flow, Amazon
3436
+ # Cognito receives the password in the request instead of using the
3437
+ # SRP protocol to verify passwords.
3438
+ #
3439
+ # ALLOW\_USER\_SRP\_AUTH
3440
+ #
3441
+ # : Enable SRP-based authentication.
3442
+ #
3443
+ # ALLOW\_REFRESH\_TOKEN\_AUTH
3444
+ #
3445
+ # : Enable the authflow that refreshes tokens.
3446
+ #
3447
+ # If you don't specify a value for `ExplicitAuthFlows`, your user
3448
+ # client supports `ALLOW_USER_SRP_AUTH` and `ALLOW_CUSTOM_AUTH`.
3403
3449
  #
3404
3450
  # @option params [Array<String>] :supported_identity_providers
3405
- # A list of provider names for the IdPs that this client supports. The
3406
- # following are supported: `COGNITO`, `Facebook`, `Google`
3407
- # `LoginWithAmazon`, and the names of your own SAML and OIDC providers.
3451
+ # A list of provider names for the identity providers (IdPs) that are
3452
+ # supported on this client. The following are supported: `COGNITO`,
3453
+ # `Facebook`, `Google`, `SignInWithApple`, and `LoginWithAmazon`. You
3454
+ # can also specify the names that you configured for the SAML and OIDC
3455
+ # IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP`.
3408
3456
  #
3409
3457
  # @option params [Array<String>] :callback_urls
3410
3458
  # A list of allowed redirect (callback) URLs for the IdPs.
@@ -3524,6 +3572,19 @@ module Aws::CognitoIdentityProvider
3524
3572
  #
3525
3573
  # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html
3526
3574
  #
3575
+ # @option params [Boolean] :enable_propagate_additional_user_context_data
3576
+ # Activates the propagation of additional user context data. For more
3577
+ # information about propagation of user context data, see [ Adding
3578
+ # advanced security to a user pool][1]. If you don’t include this
3579
+ # parameter, you can't send device fingerprint information, including
3580
+ # source IP address, to Amazon Cognito advanced security. You can only
3581
+ # activate `EnablePropagateAdditionalUserContextData` in an app client
3582
+ # that has a client secret.
3583
+ #
3584
+ #
3585
+ #
3586
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html
3587
+ #
3527
3588
  # @return [Types::CreateUserPoolClientResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3528
3589
  #
3529
3590
  # * {Types::CreateUserPoolClientResponse#user_pool_client #user_pool_client} => Types::UserPoolClientType
@@ -3561,6 +3622,7 @@ module Aws::CognitoIdentityProvider
3561
3622
  # },
3562
3623
  # prevent_user_existence_errors: "LEGACY", # accepts LEGACY, ENABLED
3563
3624
  # enable_token_revocation: false,
3625
+ # enable_propagate_additional_user_context_data: false,
3564
3626
  # })
3565
3627
  #
3566
3628
  # @example Response structure
@@ -3602,6 +3664,7 @@ module Aws::CognitoIdentityProvider
3602
3664
  # resp.user_pool_client.analytics_configuration.user_data_shared #=> Boolean
3603
3665
  # resp.user_pool_client.prevent_user_existence_errors #=> String, one of "LEGACY", "ENABLED"
3604
3666
  # resp.user_pool_client.enable_token_revocation #=> Boolean
3667
+ # resp.user_pool_client.enable_propagate_additional_user_context_data #=> Boolean
3605
3668
  #
3606
3669
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolClient AWS API Documentation
3607
3670
  #
@@ -4228,6 +4291,7 @@ module Aws::CognitoIdentityProvider
4228
4291
  # resp.user_pool_client.analytics_configuration.user_data_shared #=> Boolean
4229
4292
  # resp.user_pool_client.prevent_user_existence_errors #=> String, one of "LEGACY", "ENABLED"
4230
4293
  # resp.user_pool_client.enable_token_revocation #=> Boolean
4294
+ # resp.user_pool_client.enable_propagate_additional_user_context_data #=> Boolean
4231
4295
  #
4232
4296
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPoolClient AWS API Documentation
4233
4297
  #
@@ -4349,9 +4413,11 @@ module Aws::CognitoIdentityProvider
4349
4413
  # the message.
4350
4414
  #
4351
4415
  # @option params [Types::UserContextDataType] :user_context_data
4352
- # Contextual data such as the user's device fingerprint, IP address, or
4353
- # location used for evaluating the risk of an unexpected event by Amazon
4354
- # Cognito advanced security.
4416
+ # Contextual data about your user session, such as the device
4417
+ # fingerprint, IP address, or location. Amazon Cognito advanced security
4418
+ # evaluates the risk of an authentication event based on the context
4419
+ # that your app generates and passes to Amazon Cognito when it makes API
4420
+ # requests.
4355
4421
  #
4356
4422
  # @option params [required, String] :username
4357
4423
  # The user name of the user for whom you want to enter a code to reset a
@@ -4408,6 +4474,7 @@ module Aws::CognitoIdentityProvider
4408
4474
  # client_id: "ClientIdType", # required
4409
4475
  # secret_hash: "SecretHashType",
4410
4476
  # user_context_data: {
4477
+ # ip_address: "StringType",
4411
4478
  # encoded_data: "StringType",
4412
4479
  # },
4413
4480
  # username: "UsernameType", # required
@@ -5019,9 +5086,11 @@ module Aws::CognitoIdentityProvider
5019
5086
  # metrics for `InitiateAuth` calls.
5020
5087
  #
5021
5088
  # @option params [Types::UserContextDataType] :user_context_data
5022
- # Contextual data such as the user's device fingerprint, IP address, or
5023
- # location used for evaluating the risk of an unexpected event by Amazon
5024
- # Cognito advanced security.
5089
+ # Contextual data about your user session, such as the device
5090
+ # fingerprint, IP address, or location. Amazon Cognito advanced security
5091
+ # evaluates the risk of an authentication event based on the context
5092
+ # that your app generates and passes to Amazon Cognito when it makes API
5093
+ # requests.
5025
5094
  #
5026
5095
  # @return [Types::InitiateAuthResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5027
5096
  #
@@ -5045,6 +5114,7 @@ module Aws::CognitoIdentityProvider
5045
5114
  # analytics_endpoint_id: "StringType",
5046
5115
  # },
5047
5116
  # user_context_data: {
5117
+ # ip_address: "StringType",
5048
5118
  # encoded_data: "StringType",
5049
5119
  # },
5050
5120
  # })
@@ -5683,9 +5753,11 @@ module Aws::CognitoIdentityProvider
5683
5753
  # the message.
5684
5754
  #
5685
5755
  # @option params [Types::UserContextDataType] :user_context_data
5686
- # Contextual data such as the user's device fingerprint, IP address, or
5687
- # location used for evaluating the risk of an unexpected event by Amazon
5688
- # Cognito advanced security.
5756
+ # Contextual data about your user session, such as the device
5757
+ # fingerprint, IP address, or location. Amazon Cognito advanced security
5758
+ # evaluates the risk of an authentication event based on the context
5759
+ # that your app generates and passes to Amazon Cognito when it makes API
5760
+ # requests.
5689
5761
  #
5690
5762
  # @option params [required, String] :username
5691
5763
  # The `username` attribute of the user to whom you want to resend a
@@ -5742,6 +5814,7 @@ module Aws::CognitoIdentityProvider
5742
5814
  # client_id: "ClientIdType", # required
5743
5815
  # secret_hash: "SecretHashType",
5744
5816
  # user_context_data: {
5817
+ # ip_address: "StringType",
5745
5818
  # encoded_data: "StringType",
5746
5819
  # },
5747
5820
  # username: "UsernameType", # required
@@ -5868,9 +5941,11 @@ module Aws::CognitoIdentityProvider
5868
5941
  # metrics for `RespondToAuthChallenge` calls.
5869
5942
  #
5870
5943
  # @option params [Types::UserContextDataType] :user_context_data
5871
- # Contextual data such as the user's device fingerprint, IP address, or
5872
- # location used for evaluating the risk of an unexpected event by Amazon
5873
- # Cognito advanced security.
5944
+ # Contextual data about your user session, such as the device
5945
+ # fingerprint, IP address, or location. Amazon Cognito advanced security
5946
+ # evaluates the risk of an authentication event based on the context
5947
+ # that your app generates and passes to Amazon Cognito when it makes API
5948
+ # requests.
5874
5949
  #
5875
5950
  # @option params [Hash<String,String>] :client_metadata
5876
5951
  # A map of custom key-value pairs that you can provide as input for any
@@ -5931,6 +6006,7 @@ module Aws::CognitoIdentityProvider
5931
6006
  # analytics_endpoint_id: "StringType",
5932
6007
  # },
5933
6008
  # user_context_data: {
6009
+ # ip_address: "StringType",
5934
6010
  # encoded_data: "StringType",
5935
6011
  # },
5936
6012
  # client_metadata: {
@@ -6195,7 +6271,7 @@ module Aws::CognitoIdentityProvider
6195
6271
  # The SMS text message multi-factor authentication (MFA) settings.
6196
6272
  #
6197
6273
  # @option params [Types::SoftwareTokenMfaSettingsType] :software_token_mfa_settings
6198
- # The time-based one-time password software token MFA settings.
6274
+ # The time-based one-time password (TOTP) software token MFA settings.
6199
6275
  #
6200
6276
  # @option params [required, String] :access_token
6201
6277
  # A valid access token that Amazon Cognito issued to the user whose MFA
@@ -6416,9 +6492,11 @@ module Aws::CognitoIdentityProvider
6416
6492
  # metrics for `SignUp` calls.
6417
6493
  #
6418
6494
  # @option params [Types::UserContextDataType] :user_context_data
6419
- # Contextual data such as the user's device fingerprint, IP address, or
6420
- # location used for evaluating the risk of an unexpected event by Amazon
6421
- # Cognito advanced security.
6495
+ # Contextual data about your user session, such as the device
6496
+ # fingerprint, IP address, or location. Amazon Cognito advanced security
6497
+ # evaluates the risk of an authentication event based on the context
6498
+ # that your app generates and passes to Amazon Cognito when it makes API
6499
+ # requests.
6422
6500
  #
6423
6501
  # @option params [Hash<String,String>] :client_metadata
6424
6502
  # A map of custom key-value pairs that you can provide as input for any
@@ -6486,6 +6564,7 @@ module Aws::CognitoIdentityProvider
6486
6564
  # analytics_endpoint_id: "StringType",
6487
6565
  # },
6488
6566
  # user_context_data: {
6567
+ # ip_address: "StringType",
6489
6568
  # encoded_data: "StringType",
6490
6569
  # },
6491
6570
  # client_metadata: {
@@ -7096,6 +7175,16 @@ module Aws::CognitoIdentityProvider
7096
7175
  # The contents of the SMS authentication message.
7097
7176
  #
7098
7177
  # @option params [Types::UserAttributeUpdateSettingsType] :user_attribute_update_settings
7178
+ # The settings for updates to user attributes. These settings include
7179
+ # the property `AttributesRequireVerificationBeforeUpdate`, a user-pool
7180
+ # setting that tells Amazon Cognito how to handle changes to the value
7181
+ # of your users' email address and phone number attributes. For more
7182
+ # information, see [ Verifying updates to email addresses and phone
7183
+ # numbers][1].
7184
+ #
7185
+ #
7186
+ #
7187
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates
7099
7188
  #
7100
7189
  # @option params [String] :mfa_configuration
7101
7190
  # Possible values include:
@@ -7116,7 +7205,14 @@ module Aws::CognitoIdentityProvider
7116
7205
  # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html
7117
7206
  #
7118
7207
  # @option params [Types::DeviceConfigurationType] :device_configuration
7119
- # Device configuration.
7208
+ # The device-remembering configuration for a user pool. A null value
7209
+ # indicates that you have deactivated device remembering in your user
7210
+ # pool.
7211
+ #
7212
+ # <note markdown="1"> When you provide a value for any `DeviceConfiguration` field, you
7213
+ # activate the Amazon Cognito device-remembering feature.
7214
+ #
7215
+ # </note>
7120
7216
  #
7121
7217
  # @option params [Types::EmailConfigurationType] :email_configuration
7122
7218
  # The email configuration of your user pool. The email configuration
@@ -7364,8 +7460,9 @@ module Aws::CognitoIdentityProvider
7364
7460
  #
7365
7461
  # @option params [Array<String>] :supported_identity_providers
7366
7462
  # A list of provider names for the IdPs that this client supports. The
7367
- # following are supported: `COGNITO`, `Facebook`, `Google`
7368
- # `LoginWithAmazon`, and the names of your own SAML and OIDC providers.
7463
+ # following are supported: `COGNITO`, `Facebook`, `Google`,
7464
+ # `SignInWithApple`, `LoginWithAmazon`, and the names of your own SAML
7465
+ # and OIDC providers.
7369
7466
  #
7370
7467
  # @option params [Array<String>] :callback_urls
7371
7468
  # A list of allowed redirect (callback) URLs for the IdPs.
@@ -7482,6 +7579,19 @@ module Aws::CognitoIdentityProvider
7482
7579
  #
7483
7580
  # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html
7484
7581
  #
7582
+ # @option params [Boolean] :enable_propagate_additional_user_context_data
7583
+ # Activates the propagation of additional user context data. For more
7584
+ # information about propagation of user context data, see [ Adding
7585
+ # advanced security to a user pool][1]. If you don’t include this
7586
+ # parameter, you can't send device fingerprint information, including
7587
+ # source IP address, to Amazon Cognito advanced security. You can only
7588
+ # activate `EnablePropagateAdditionalUserContextData` in an app client
7589
+ # that has a client secret.
7590
+ #
7591
+ #
7592
+ #
7593
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html
7594
+ #
7485
7595
  # @return [Types::UpdateUserPoolClientResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7486
7596
  #
7487
7597
  # * {Types::UpdateUserPoolClientResponse#user_pool_client #user_pool_client} => Types::UserPoolClientType
@@ -7519,6 +7629,7 @@ module Aws::CognitoIdentityProvider
7519
7629
  # },
7520
7630
  # prevent_user_existence_errors: "LEGACY", # accepts LEGACY, ENABLED
7521
7631
  # enable_token_revocation: false,
7632
+ # enable_propagate_additional_user_context_data: false,
7522
7633
  # })
7523
7634
  #
7524
7635
  # @example Response structure
@@ -7560,6 +7671,7 @@ module Aws::CognitoIdentityProvider
7560
7671
  # resp.user_pool_client.analytics_configuration.user_data_shared #=> Boolean
7561
7672
  # resp.user_pool_client.prevent_user_existence_errors #=> String, one of "LEGACY", "ENABLED"
7562
7673
  # resp.user_pool_client.enable_token_revocation #=> Boolean
7674
+ # resp.user_pool_client.enable_propagate_additional_user_context_data #=> Boolean
7563
7675
  #
7564
7676
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPoolClient AWS API Documentation
7565
7677
  #
@@ -7755,7 +7867,7 @@ module Aws::CognitoIdentityProvider
7755
7867
  params: params,
7756
7868
  config: config)
7757
7869
  context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
7758
- context[:gem_version] = '1.66.0'
7870
+ context[:gem_version] = '1.69.0'
7759
7871
  Seahorse::Client::Request.new(handlers, context)
7760
7872
  end
7761
7873