aws-sdk-cognitoidentityprovider 1.66.0 → 1.69.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.
@@ -1127,9 +1127,11 @@ module Aws::CognitoIdentityProvider
1127
1127
  # @return [Types::AnalyticsMetadataType]
1128
1128
  #
1129
1129
  # @!attribute [rw] context_data
1130
- # Contextual data such as the user's device fingerprint, IP address,
1131
- # or location used for evaluating the risk of an unexpected event by
1132
- # Amazon Cognito advanced security.
1130
+ # Contextual data about your user session, such as the device
1131
+ # fingerprint, IP address, or location. Amazon Cognito advanced
1132
+ # security evaluates the risk of an authentication event based on the
1133
+ # context that your app generates and passes to Amazon Cognito when it
1134
+ # makes API requests.
1133
1135
  # @return [Types::ContextDataType]
1134
1136
  #
1135
1137
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminInitiateAuthRequest AWS API Documentation
@@ -1737,9 +1739,11 @@ module Aws::CognitoIdentityProvider
1737
1739
  # @return [Types::AnalyticsMetadataType]
1738
1740
  #
1739
1741
  # @!attribute [rw] context_data
1740
- # Contextual data such as the user's device fingerprint, IP address,
1741
- # or location used for evaluating the risk of an unexpected event by
1742
- # Amazon Cognito advanced security.
1742
+ # Contextual data about your user session, such as the device
1743
+ # fingerprint, IP address, or location. Amazon Cognito advanced
1744
+ # security evaluates the risk of an authentication event based on the
1745
+ # context that your app generates and passes to Amazon Cognito when it
1746
+ # makes API requests.
1743
1747
  # @return [Types::ContextDataType]
1744
1748
  #
1745
1749
  # @!attribute [rw] client_metadata
@@ -2225,13 +2229,14 @@ module Aws::CognitoIdentityProvider
2225
2229
 
2226
2230
  # This exception is thrown when a user tries to confirm the account with
2227
2231
  # an email address or phone number that has already been supplied as an
2228
- # alias from a different account. This exception indicates that an
2232
+ # alias for a different user profile. This exception indicates that an
2229
2233
  # account with this email address or phone already exists in a user pool
2230
2234
  # that you've configured to use email address or phone number as a
2231
2235
  # sign-in alias.
2232
2236
  #
2233
2237
  # @!attribute [rw] message
2234
- # The message sent to the user when an alias exists.
2238
+ # The message that Amazon Cognito sends to the user when the value of
2239
+ # an alias attribute is already linked to another user profile.
2235
2240
  # @return [String]
2236
2241
  #
2237
2242
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AliasExistsException AWS API Documentation
@@ -2361,8 +2366,8 @@ module Aws::CognitoIdentityProvider
2361
2366
  end
2362
2367
 
2363
2368
  # @!attribute [rw] secret_code
2364
- # A unique generated shared secret code that is used in the time-based
2365
- # one-time password (TOTP) algorithm to generate a one-time code.
2369
+ # A unique generated shared secret code that is used in the TOTP
2370
+ # algorithm to generate a one-time code.
2366
2371
  # @return [String]
2367
2372
  #
2368
2373
  # @!attribute [rw] session
@@ -2755,6 +2760,7 @@ module Aws::CognitoIdentityProvider
2755
2760
  # analytics_endpoint_id: "StringType",
2756
2761
  # },
2757
2762
  # user_context_data: {
2763
+ # ip_address: "StringType",
2758
2764
  # encoded_data: "StringType",
2759
2765
  # },
2760
2766
  # client_metadata: {
@@ -2778,8 +2784,8 @@ module Aws::CognitoIdentityProvider
2778
2784
  # @return [String]
2779
2785
  #
2780
2786
  # @!attribute [rw] confirmation_code
2781
- # The confirmation code sent by a user's request to retrieve a
2782
- # forgotten password. For more information, see [ForgotPassword][1].
2787
+ # The confirmation code from your user's request to reset their
2788
+ # password. For more information, see [ForgotPassword][1].
2783
2789
  #
2784
2790
  #
2785
2791
  #
@@ -2787,8 +2793,7 @@ module Aws::CognitoIdentityProvider
2787
2793
  # @return [String]
2788
2794
  #
2789
2795
  # @!attribute [rw] password
2790
- # The password sent by a user's request to retrieve a forgotten
2791
- # password.
2796
+ # The new password that your user wants to set.
2792
2797
  # @return [String]
2793
2798
  #
2794
2799
  # @!attribute [rw] analytics_metadata
@@ -2797,9 +2802,11 @@ module Aws::CognitoIdentityProvider
2797
2802
  # @return [Types::AnalyticsMetadataType]
2798
2803
  #
2799
2804
  # @!attribute [rw] user_context_data
2800
- # Contextual data such as the user's device fingerprint, IP address,
2801
- # or location used for evaluating the risk of an unexpected event by
2802
- # Amazon Cognito advanced security.
2805
+ # Contextual data about your user session, such as the device
2806
+ # fingerprint, IP address, or location. Amazon Cognito advanced
2807
+ # security evaluates the risk of an authentication event based on the
2808
+ # context that your app generates and passes to Amazon Cognito when it
2809
+ # makes API requests.
2803
2810
  # @return [Types::UserContextDataType]
2804
2811
  #
2805
2812
  # @!attribute [rw] client_metadata
@@ -2877,6 +2884,7 @@ module Aws::CognitoIdentityProvider
2877
2884
  # analytics_endpoint_id: "StringType",
2878
2885
  # },
2879
2886
  # user_context_data: {
2887
+ # ip_address: "StringType",
2880
2888
  # encoded_data: "StringType",
2881
2889
  # },
2882
2890
  # client_metadata: {
@@ -2919,9 +2927,11 @@ module Aws::CognitoIdentityProvider
2919
2927
  # @return [Types::AnalyticsMetadataType]
2920
2928
  #
2921
2929
  # @!attribute [rw] user_context_data
2922
- # Contextual data such as the user's device fingerprint, IP address,
2923
- # or location used for evaluating the risk of an unexpected event by
2924
- # Amazon Cognito advanced security.
2930
+ # Contextual data about your user session, such as the device
2931
+ # fingerprint, IP address, or location. Amazon Cognito advanced
2932
+ # security evaluates the risk of an authentication event based on the
2933
+ # context that your app generates and passes to Amazon Cognito when it
2934
+ # makes API requests.
2925
2935
  # @return [Types::UserContextDataType]
2926
2936
  #
2927
2937
  # @!attribute [rw] client_metadata
@@ -3004,7 +3014,7 @@ module Aws::CognitoIdentityProvider
3004
3014
  # }
3005
3015
  #
3006
3016
  # @!attribute [rw] ip_address
3007
- # Source IP address of your user.
3017
+ # The source IP address of your user's device.
3008
3018
  # @return [String]
3009
3019
  #
3010
3020
  # @!attribute [rw] server_name
@@ -3020,8 +3030,14 @@ module Aws::CognitoIdentityProvider
3020
3030
  # @return [Array<Types::HttpHeader>]
3021
3031
  #
3022
3032
  # @!attribute [rw] encoded_data
3023
- # Encoded data containing device fingerprinting details collected
3024
- # using the Amazon Cognito context data collection library.
3033
+ # Encoded device-fingerprint details that your app collected with the
3034
+ # Amazon Cognito context data collection library. For more
3035
+ # information, see [Adding user device and session data to API
3036
+ # requests][1].
3037
+ #
3038
+ #
3039
+ #
3040
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint
3025
3041
  # @return [String]
3026
3042
  #
3027
3043
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ContextDataType AWS API Documentation
@@ -3384,6 +3400,7 @@ module Aws::CognitoIdentityProvider
3384
3400
  # },
3385
3401
  # prevent_user_existence_errors: "LEGACY", # accepts LEGACY, ENABLED
3386
3402
  # enable_token_revocation: false,
3403
+ # enable_propagate_additional_user_context_data: false,
3387
3404
  # }
3388
3405
  #
3389
3406
  # @!attribute [rw] user_pool_id
@@ -3482,34 +3499,42 @@ module Aws::CognitoIdentityProvider
3482
3499
  #
3483
3500
  # Valid values include:
3484
3501
  #
3485
- # * `ALLOW_ADMIN_USER_PASSWORD_AUTH`\: Enable admin based user
3486
- # password authentication flow `ADMIN_USER_PASSWORD_AUTH`. This
3487
- # setting replaces the `ADMIN_NO_SRP_AUTH` setting. With this
3488
- # authentication flow, Amazon Cognito receives the password in the
3489
- # request instead of using the Secure Remote Password (SRP) protocol
3490
- # to verify passwords.
3502
+ # ALLOW\_ADMIN\_USER\_PASSWORD\_AUTH
3491
3503
  #
3492
- # * `ALLOW_CUSTOM_AUTH`\: Enable Lambda trigger based authentication.
3504
+ # : Enable admin based user password authentication flow
3505
+ # `ADMIN_USER_PASSWORD_AUTH`. This setting replaces the
3506
+ # `ADMIN_NO_SRP_AUTH` setting. With this authentication flow, Amazon
3507
+ # Cognito receives the password in the request instead of using the
3508
+ # Secure Remote Password (SRP) protocol to verify passwords.
3493
3509
  #
3494
- # * `ALLOW_USER_PASSWORD_AUTH`\: Enable user password-based
3495
- # authentication. In this flow, Amazon Cognito receives the password
3496
- # in the request instead of using the SRP protocol to verify
3497
- # passwords.
3510
+ # ALLOW\_CUSTOM\_AUTH
3498
3511
  #
3499
- # * `ALLOW_USER_SRP_AUTH`\: Enable SRP-based authentication.
3512
+ # : Enable Lambda trigger based authentication.
3500
3513
  #
3501
- # * `ALLOW_REFRESH_TOKEN_AUTH`\: Enable authflow to refresh tokens.
3514
+ # ALLOW\_USER\_PASSWORD\_AUTH
3515
+ #
3516
+ # : Enable user password-based authentication. In this flow, Amazon
3517
+ # Cognito receives the password in the request instead of using the
3518
+ # SRP protocol to verify passwords.
3519
+ #
3520
+ # ALLOW\_USER\_SRP\_AUTH
3521
+ #
3522
+ # : Enable SRP-based authentication.
3523
+ #
3524
+ # ALLOW\_REFRESH\_TOKEN\_AUTH
3525
+ #
3526
+ # : Enable the authflow that refreshes tokens.
3502
3527
  #
3503
- # If you don't specify a value for `ExplicitAuthFlows`, your app
3504
- # client activates the `ALLOW_USER_SRP_AUTH` and `ALLOW_CUSTOM_AUTH`
3505
- # authentication flows.
3528
+ # If you don't specify a value for `ExplicitAuthFlows`, your user
3529
+ # client supports `ALLOW_USER_SRP_AUTH` and `ALLOW_CUSTOM_AUTH`.
3506
3530
  # @return [Array<String>]
3507
3531
  #
3508
3532
  # @!attribute [rw] supported_identity_providers
3509
- # A list of provider names for the IdPs that this client supports. The
3510
- # following are supported: `COGNITO`, `Facebook`, `Google`
3511
- # `LoginWithAmazon`, and the names of your own SAML and OIDC
3512
- # providers.
3533
+ # A list of provider names for the identity providers (IdPs) that are
3534
+ # supported on this client. The following are supported: `COGNITO`,
3535
+ # `Facebook`, `Google`, `SignInWithApple`, and `LoginWithAmazon`. You
3536
+ # can also specify the names that you configured for the SAML and OIDC
3537
+ # IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP`.
3513
3538
  # @return [Array<String>]
3514
3539
  #
3515
3540
  # @!attribute [rw] callback_urls
@@ -3639,6 +3664,20 @@ module Aws::CognitoIdentityProvider
3639
3664
  # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html
3640
3665
  # @return [Boolean]
3641
3666
  #
3667
+ # @!attribute [rw] enable_propagate_additional_user_context_data
3668
+ # Activates the propagation of additional user context data. For more
3669
+ # information about propagation of user context data, see [ Adding
3670
+ # advanced security to a user pool][1]. If you don’t include this
3671
+ # parameter, you can't send device fingerprint information, including
3672
+ # source IP address, to Amazon Cognito advanced security. You can only
3673
+ # activate `EnablePropagateAdditionalUserContextData` in an app client
3674
+ # that has a client secret.
3675
+ #
3676
+ #
3677
+ #
3678
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html
3679
+ # @return [Boolean]
3680
+ #
3642
3681
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolClientRequest AWS API Documentation
3643
3682
  #
3644
3683
  class CreateUserPoolClientRequest < Struct.new(
@@ -3661,7 +3700,8 @@ module Aws::CognitoIdentityProvider
3661
3700
  :allowed_o_auth_flows_user_pool_client,
3662
3701
  :analytics_configuration,
3663
3702
  :prevent_user_existence_errors,
3664
- :enable_token_revocation)
3703
+ :enable_token_revocation,
3704
+ :enable_propagate_additional_user_context_data)
3665
3705
  SENSITIVE = []
3666
3706
  include Aws::Structure
3667
3707
  end
@@ -3910,8 +3950,8 @@ module Aws::CognitoIdentityProvider
3910
3950
  #
3911
3951
  # @!attribute [rw] email_verification_message
3912
3952
  # A string representing the email verification message.
3913
- # EmailVerificationMessage is allowed only if [EmailSendingAccount][1]
3914
- # is DEVELOPER.
3953
+ # `EmailVerificationMessage` is allowed only if
3954
+ # [EmailSendingAccount][1] is DEVELOPER.
3915
3955
  #
3916
3956
  #
3917
3957
  #
@@ -3920,8 +3960,8 @@ module Aws::CognitoIdentityProvider
3920
3960
  #
3921
3961
  # @!attribute [rw] email_verification_subject
3922
3962
  # A string representing the email verification subject.
3923
- # EmailVerificationSubject is allowed only if [EmailSendingAccount][1]
3924
- # is DEVELOPER.
3963
+ # `EmailVerificationSubject` is allowed only if
3964
+ # [EmailSendingAccount][1] is DEVELOPER.
3925
3965
  #
3926
3966
  #
3927
3967
  #
@@ -3942,10 +3982,27 @@ module Aws::CognitoIdentityProvider
3942
3982
  # @return [String]
3943
3983
  #
3944
3984
  # @!attribute [rw] user_attribute_update_settings
3985
+ # The settings for updates to user attributes. These settings include
3986
+ # the property `AttributesRequireVerificationBeforeUpdate`, a
3987
+ # user-pool setting that tells Amazon Cognito how to handle changes to
3988
+ # the value of your users' email address and phone number attributes.
3989
+ # For more information, see [ Verifying updates to email addresses and
3990
+ # phone numbers][1].
3991
+ #
3992
+ #
3993
+ #
3994
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates
3945
3995
  # @return [Types::UserAttributeUpdateSettingsType]
3946
3996
  #
3947
3997
  # @!attribute [rw] device_configuration
3948
- # The device configuration.
3998
+ # The device-remembering configuration for a user pool. A null value
3999
+ # indicates that you have deactivated device remembering in your user
4000
+ # pool.
4001
+ #
4002
+ # <note markdown="1"> When you provide a value for any `DeviceConfiguration` field, you
4003
+ # activate the Amazon Cognito device-remembering feature.
4004
+ #
4005
+ # </note>
3949
4006
  # @return [Types::DeviceConfigurationType]
3950
4007
  #
3951
4008
  # @!attribute [rw] email_configuration
@@ -4615,11 +4672,12 @@ module Aws::CognitoIdentityProvider
4615
4672
  include Aws::Structure
4616
4673
  end
4617
4674
 
4618
- # The device tracking configuration for a user pool. A user pool with
4619
- # device tracking deactivated returns a null value.
4675
+ # The device-remembering configuration for a user pool. A null value
4676
+ # indicates that you have deactivated device remembering in your user
4677
+ # pool.
4620
4678
  #
4621
- # <note markdown="1"> When you provide values for any DeviceConfiguration field, you
4622
- # activate device tracking.
4679
+ # <note markdown="1"> When you provide a value for any `DeviceConfiguration` field, you
4680
+ # activate the Amazon Cognito device-remembering feature.
4623
4681
  #
4624
4682
  # </note>
4625
4683
  #
@@ -4636,17 +4694,23 @@ module Aws::CognitoIdentityProvider
4636
4694
  # one-time password (TOTP) factors for multi-factor authentication
4637
4695
  # (MFA).
4638
4696
  #
4639
- # <note markdown="1"> Users that sign in with devices that have not been confirmed or
4640
- # remembered will still have to provide a second factor, whether or
4641
- # not ChallengeRequiredOnNewDevice is true, when your user pool
4642
- # requires MFA.
4697
+ # <note markdown="1"> Regardless of the value of this field, users that sign in with new
4698
+ # devices that have not been confirmed or remembered must provide a
4699
+ # second factor if your user pool requires MFA.
4643
4700
  #
4644
4701
  # </note>
4645
4702
  # @return [Boolean]
4646
4703
  #
4647
4704
  # @!attribute [rw] device_only_remembered_on_user_prompt
4648
- # When true, users can opt in to remembering their device. Your app
4649
- # code must use callback functions to return the user's choice.
4705
+ # When true, Amazon Cognito doesn't remember newly-confirmed devices.
4706
+ # Users who want to authenticate with their device can instead opt in
4707
+ # to remembering their device. To collect a choice from your user,
4708
+ # create an input prompt in your app and return the value that the
4709
+ # user chooses in an [UpdateDeviceStatus][1] API request.
4710
+ #
4711
+ #
4712
+ #
4713
+ # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html
4650
4714
  # @return [Boolean]
4651
4715
  #
4652
4716
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeviceConfigurationType AWS API Documentation
@@ -4959,7 +5023,7 @@ module Aws::CognitoIdentityProvider
4959
5023
  # request.
4960
5024
  #
4961
5025
  # @!attribute [rw] ip_address
4962
- # The user's IP address.
5026
+ # The source IP address of your user's device.
4963
5027
  # @return [String]
4964
5028
  #
4965
5029
  # @!attribute [rw] device_name
@@ -5053,6 +5117,22 @@ module Aws::CognitoIdentityProvider
5053
5117
  include Aws::Structure
5054
5118
  end
5055
5119
 
5120
+ # This exception is thrown when WAF doesn't allow your request based on
5121
+ # a web ACL that's associated with your user pool.
5122
+ #
5123
+ # @!attribute [rw] message
5124
+ # The message returned when WAF doesn't allow your request based on a
5125
+ # web ACL that's associated with your user pool.
5126
+ # @return [String]
5127
+ #
5128
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ForbiddenException AWS API Documentation
5129
+ #
5130
+ class ForbiddenException < Struct.new(
5131
+ :message)
5132
+ SENSITIVE = []
5133
+ include Aws::Structure
5134
+ end
5135
+
5056
5136
  # Represents the request to forget the device.
5057
5137
  #
5058
5138
  # @note When making an API call, you may pass ForgetDeviceRequest
@@ -5090,6 +5170,7 @@ module Aws::CognitoIdentityProvider
5090
5170
  # client_id: "ClientIdType", # required
5091
5171
  # secret_hash: "SecretHashType",
5092
5172
  # user_context_data: {
5173
+ # ip_address: "StringType",
5093
5174
  # encoded_data: "StringType",
5094
5175
  # },
5095
5176
  # username: "UsernameType", # required
@@ -5112,9 +5193,11 @@ module Aws::CognitoIdentityProvider
5112
5193
  # @return [String]
5113
5194
  #
5114
5195
  # @!attribute [rw] user_context_data
5115
- # Contextual data such as the user's device fingerprint, IP address,
5116
- # or location used for evaluating the risk of an unexpected event by
5117
- # Amazon Cognito advanced security.
5196
+ # Contextual data about your user session, such as the device
5197
+ # fingerprint, IP address, or location. Amazon Cognito advanced
5198
+ # security evaluates the risk of an authentication event based on the
5199
+ # context that your app generates and passes to Amazon Cognito when it
5200
+ # makes API requests.
5118
5201
  # @return [Types::UserContextDataType]
5119
5202
  #
5120
5203
  # @!attribute [rw] username
@@ -5179,8 +5262,7 @@ module Aws::CognitoIdentityProvider
5179
5262
  include Aws::Structure
5180
5263
  end
5181
5264
 
5182
- # Represents the response from the server regarding the request to reset
5183
- # a password.
5265
+ # The response from Amazon Cognito to a request to reset a password.
5184
5266
  #
5185
5267
  # @!attribute [rw] code_delivery_details
5186
5268
  # The code delivery details returned by the server in response to the
@@ -5534,15 +5616,17 @@ module Aws::CognitoIdentityProvider
5534
5616
  end
5535
5617
 
5536
5618
  # @!attribute [rw] sms_mfa_configuration
5537
- # The SMS text message multi-factor (MFA) configuration.
5619
+ # The SMS text message multi-factor authentication (MFA)
5620
+ # configuration.
5538
5621
  # @return [Types::SmsMfaConfigType]
5539
5622
  #
5540
5623
  # @!attribute [rw] software_token_mfa_configuration
5541
- # The software token multi-factor (MFA) configuration.
5624
+ # The software token multi-factor authentication (MFA) configuration.
5542
5625
  # @return [Types::SoftwareTokenMfaConfigType]
5543
5626
  #
5544
5627
  # @!attribute [rw] mfa_configuration
5545
- # The multi-factor (MFA) configuration. Valid values include:
5628
+ # The multi-factor authentication (MFA) configuration. Valid values
5629
+ # include:
5546
5630
  #
5547
5631
  # * `OFF` MFA won't be used for any users.
5548
5632
  #
@@ -5895,6 +5979,7 @@ module Aws::CognitoIdentityProvider
5895
5979
  # analytics_endpoint_id: "StringType",
5896
5980
  # },
5897
5981
  # user_context_data: {
5982
+ # ip_address: "StringType",
5898
5983
  # encoded_data: "StringType",
5899
5984
  # },
5900
5985
  # }
@@ -6023,9 +6108,11 @@ module Aws::CognitoIdentityProvider
6023
6108
  # @return [Types::AnalyticsMetadataType]
6024
6109
  #
6025
6110
  # @!attribute [rw] user_context_data
6026
- # Contextual data such as the user's device fingerprint, IP address,
6027
- # or location used for evaluating the risk of an unexpected event by
6028
- # Amazon Cognito advanced security.
6111
+ # Contextual data about your user session, such as the device
6112
+ # fingerprint, IP address, or location. Amazon Cognito advanced
6113
+ # security evaluates the risk of an authentication event based on the
6114
+ # context that your app generates and passes to Amazon Cognito when it
6115
+ # makes API requests.
6029
6116
  # @return [Types::UserContextDataType]
6030
6117
  #
6031
6118
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/InitiateAuthRequest AWS API Documentation
@@ -7450,6 +7537,7 @@ module Aws::CognitoIdentityProvider
7450
7537
  # client_id: "ClientIdType", # required
7451
7538
  # secret_hash: "SecretHashType",
7452
7539
  # user_context_data: {
7540
+ # ip_address: "StringType",
7453
7541
  # encoded_data: "StringType",
7454
7542
  # },
7455
7543
  # username: "UsernameType", # required
@@ -7472,9 +7560,11 @@ module Aws::CognitoIdentityProvider
7472
7560
  # @return [String]
7473
7561
  #
7474
7562
  # @!attribute [rw] user_context_data
7475
- # Contextual data such as the user's device fingerprint, IP address,
7476
- # or location used for evaluating the risk of an unexpected event by
7477
- # Amazon Cognito advanced security.
7563
+ # Contextual data about your user session, such as the device
7564
+ # fingerprint, IP address, or location. Amazon Cognito advanced
7565
+ # security evaluates the risk of an authentication event based on the
7566
+ # context that your app generates and passes to Amazon Cognito when it
7567
+ # makes API requests.
7478
7568
  # @return [Types::UserContextDataType]
7479
7569
  #
7480
7570
  # @!attribute [rw] username
@@ -7642,6 +7732,7 @@ module Aws::CognitoIdentityProvider
7642
7732
  # analytics_endpoint_id: "StringType",
7643
7733
  # },
7644
7734
  # user_context_data: {
7735
+ # ip_address: "StringType",
7645
7736
  # encoded_data: "StringType",
7646
7737
  # },
7647
7738
  # client_metadata: {
@@ -7729,9 +7820,11 @@ module Aws::CognitoIdentityProvider
7729
7820
  # @return [Types::AnalyticsMetadataType]
7730
7821
  #
7731
7822
  # @!attribute [rw] user_context_data
7732
- # Contextual data such as the user's device fingerprint, IP address,
7733
- # or location used for evaluating the risk of an unexpected event by
7734
- # Amazon Cognito advanced security.
7823
+ # Contextual data about your user session, such as the device
7824
+ # fingerprint, IP address, or location. Amazon Cognito advanced
7825
+ # security evaluates the risk of an authentication event based on the
7826
+ # context that your app generates and passes to Amazon Cognito when it
7827
+ # makes API requests.
7735
7828
  # @return [Types::UserContextDataType]
7736
7829
  #
7737
7830
  # @!attribute [rw] client_metadata
@@ -8255,7 +8348,7 @@ module Aws::CognitoIdentityProvider
8255
8348
  # @return [Types::SMSMfaSettingsType]
8256
8349
  #
8257
8350
  # @!attribute [rw] software_token_mfa_settings
8258
- # The time-based one-time password software token MFA settings.
8351
+ # The time-based one-time password (TOTP) software token MFA settings.
8259
8352
  # @return [Types::SoftwareTokenMfaSettingsType]
8260
8353
  #
8261
8354
  # @!attribute [rw] access_token
@@ -8429,6 +8522,7 @@ module Aws::CognitoIdentityProvider
8429
8522
  # analytics_endpoint_id: "StringType",
8430
8523
  # },
8431
8524
  # user_context_data: {
8525
+ # ip_address: "StringType",
8432
8526
  # encoded_data: "StringType",
8433
8527
  # },
8434
8528
  # client_metadata: {
@@ -8471,9 +8565,11 @@ module Aws::CognitoIdentityProvider
8471
8565
  # @return [Types::AnalyticsMetadataType]
8472
8566
  #
8473
8567
  # @!attribute [rw] user_context_data
8474
- # Contextual data such as the user's device fingerprint, IP address,
8475
- # or location used for evaluating the risk of an unexpected event by
8476
- # Amazon Cognito advanced security.
8568
+ # Contextual data about your user session, such as the device
8569
+ # fingerprint, IP address, or location. Amazon Cognito advanced
8570
+ # security evaluates the risk of an authentication event based on the
8571
+ # context that your app generates and passes to Amazon Cognito when it
8572
+ # makes API requests.
8477
8573
  # @return [Types::UserContextDataType]
8478
8574
  #
8479
8575
  # @!attribute [rw] client_metadata
@@ -8899,18 +8995,21 @@ module Aws::CognitoIdentityProvider
8899
8995
  # }
8900
8996
  #
8901
8997
  # @!attribute [rw] access_token
8902
- # A time unit in seconds”, minutes”, hours”, or days for the
8903
- # value in AccessTokenValidity, defaulting to hours.
8998
+ # A time unit of `seconds`, `minutes`, `hours`, or `days` for the
8999
+ # value that you set in the `AccessTokenValidity` parameter. The
9000
+ # default `AccessTokenValidity` time unit is hours.
8904
9001
  # @return [String]
8905
9002
  #
8906
9003
  # @!attribute [rw] id_token
8907
- # A time unit in seconds”, minutes”, hours”, or days for the
8908
- # value in IdTokenValidity, defaulting to hours.
9004
+ # A time unit of `seconds`, `minutes`, `hours`, or `days` for the
9005
+ # value that you set in the `IdTokenValidity` parameter. The default
9006
+ # `IdTokenValidity` time unit is hours.
8909
9007
  # @return [String]
8910
9008
  #
8911
9009
  # @!attribute [rw] refresh_token
8912
- # A time unit in seconds”, minutes”, hours”, or days for the
8913
- # value in RefreshTokenValidity, defaulting to days.
9010
+ # A time unit of `seconds`, `minutes`, `hours`, or `days` for the
9011
+ # value that you set in the `RefreshTokenValidity` parameter. The
9012
+ # default `RefreshTokenValidity` time unit is days.
8914
9013
  # @return [String]
8915
9014
  #
8916
9015
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/TokenValidityUnitsType AWS API Documentation
@@ -9517,6 +9616,7 @@ module Aws::CognitoIdentityProvider
9517
9616
  # },
9518
9617
  # prevent_user_existence_errors: "LEGACY", # accepts LEGACY, ENABLED
9519
9618
  # enable_token_revocation: false,
9619
+ # enable_propagate_additional_user_context_data: false,
9520
9620
  # }
9521
9621
  #
9522
9622
  # @!attribute [rw] user_pool_id
@@ -9620,9 +9720,9 @@ module Aws::CognitoIdentityProvider
9620
9720
  #
9621
9721
  # @!attribute [rw] supported_identity_providers
9622
9722
  # A list of provider names for the IdPs that this client supports. The
9623
- # following are supported: `COGNITO`, `Facebook`, `Google`
9624
- # `LoginWithAmazon`, and the names of your own SAML and OIDC
9625
- # providers.
9723
+ # following are supported: `COGNITO`, `Facebook`, `Google`,
9724
+ # `SignInWithApple`, `LoginWithAmazon`, and the names of your own SAML
9725
+ # and OIDC providers.
9626
9726
  # @return [Array<String>]
9627
9727
  #
9628
9728
  # @!attribute [rw] callback_urls
@@ -9749,6 +9849,20 @@ module Aws::CognitoIdentityProvider
9749
9849
  # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html
9750
9850
  # @return [Boolean]
9751
9851
  #
9852
+ # @!attribute [rw] enable_propagate_additional_user_context_data
9853
+ # Activates the propagation of additional user context data. For more
9854
+ # information about propagation of user context data, see [ Adding
9855
+ # advanced security to a user pool][1]. If you don’t include this
9856
+ # parameter, you can't send device fingerprint information, including
9857
+ # source IP address, to Amazon Cognito advanced security. You can only
9858
+ # activate `EnablePropagateAdditionalUserContextData` in an app client
9859
+ # that has a client secret.
9860
+ #
9861
+ #
9862
+ #
9863
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html
9864
+ # @return [Boolean]
9865
+ #
9752
9866
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPoolClientRequest AWS API Documentation
9753
9867
  #
9754
9868
  class UpdateUserPoolClientRequest < Struct.new(
@@ -9771,7 +9885,8 @@ module Aws::CognitoIdentityProvider
9771
9885
  :allowed_o_auth_flows_user_pool_client,
9772
9886
  :analytics_configuration,
9773
9887
  :prevent_user_existence_errors,
9774
- :enable_token_revocation)
9888
+ :enable_token_revocation,
9889
+ :enable_propagate_additional_user_context_data)
9775
9890
  SENSITIVE = [:client_id]
9776
9891
  include Aws::Structure
9777
9892
  end
@@ -9986,6 +10101,16 @@ module Aws::CognitoIdentityProvider
9986
10101
  # @return [String]
9987
10102
  #
9988
10103
  # @!attribute [rw] user_attribute_update_settings
10104
+ # The settings for updates to user attributes. These settings include
10105
+ # the property `AttributesRequireVerificationBeforeUpdate`, a
10106
+ # user-pool setting that tells Amazon Cognito how to handle changes to
10107
+ # the value of your users' email address and phone number attributes.
10108
+ # For more information, see [ Verifying updates to email addresses and
10109
+ # phone numbers][1].
10110
+ #
10111
+ #
10112
+ #
10113
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates
9989
10114
  # @return [Types::UserAttributeUpdateSettingsType]
9990
10115
  #
9991
10116
  # @!attribute [rw] mfa_configuration
@@ -10008,7 +10133,14 @@ module Aws::CognitoIdentityProvider
10008
10133
  # @return [String]
10009
10134
  #
10010
10135
  # @!attribute [rw] device_configuration
10011
- # Device configuration.
10136
+ # The device-remembering configuration for a user pool. A null value
10137
+ # indicates that you have deactivated device remembering in your user
10138
+ # pool.
10139
+ #
10140
+ # <note markdown="1"> When you provide a value for any `DeviceConfiguration` field, you
10141
+ # activate the Amazon Cognito device-remembering feature.
10142
+ #
10143
+ # </note>
10012
10144
  # @return [Types::DeviceConfigurationType]
10013
10145
  #
10014
10146
  # @!attribute [rw] email_configuration
@@ -10085,7 +10217,16 @@ module Aws::CognitoIdentityProvider
10085
10217
  #
10086
10218
  class UpdateUserPoolResponse < Aws::EmptyStructure; end
10087
10219
 
10088
- # The settings for updates to user attributes.
10220
+ # The settings for updates to user attributes. These settings include
10221
+ # the property `AttributesRequireVerificationBeforeUpdate`, a user-pool
10222
+ # setting that tells Amazon Cognito how to handle changes to the value
10223
+ # of your users' email address and phone number attributes. For more
10224
+ # information, see [ Verifying updates to email addresses and phone
10225
+ # numbers][1].
10226
+ #
10227
+ #
10228
+ #
10229
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates
10089
10230
  #
10090
10231
  # @note When making an API call, you may pass UserAttributeUpdateSettingsType
10091
10232
  # data as a hash:
@@ -10130,27 +10271,37 @@ module Aws::CognitoIdentityProvider
10130
10271
  include Aws::Structure
10131
10272
  end
10132
10273
 
10133
- # Information that your app generates about a user's
10134
- # `AdminInitiateAuth` or `AdminRespondToAuthChallenge` session. Amazon
10135
- # Cognito advanced security features calculate risk levels for user
10136
- # sessions based on this context data.
10274
+ # Contextual data, such as the user's device fingerprint, IP address,
10275
+ # or location, used for evaluating the risk of an unexpected event by
10276
+ # Amazon Cognito advanced security.
10137
10277
  #
10138
10278
  # @note When making an API call, you may pass UserContextDataType
10139
10279
  # data as a hash:
10140
10280
  #
10141
10281
  # {
10282
+ # ip_address: "StringType",
10142
10283
  # encoded_data: "StringType",
10143
10284
  # }
10144
10285
  #
10286
+ # @!attribute [rw] ip_address
10287
+ # The source IP address of your user's device.
10288
+ # @return [String]
10289
+ #
10145
10290
  # @!attribute [rw] encoded_data
10146
- # Contextual data, such as the user's device fingerprint, IP address,
10147
- # or location, used for evaluating the risk of an unexpected event by
10148
- # Amazon Cognito advanced security.
10291
+ # Encoded device-fingerprint details that your app collected with the
10292
+ # Amazon Cognito context data collection library. For more
10293
+ # information, see [Adding user device and session data to API
10294
+ # requests][1].
10295
+ #
10296
+ #
10297
+ #
10298
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint
10149
10299
  # @return [String]
10150
10300
  #
10151
10301
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UserContextDataType AWS API Documentation
10152
10302
  #
10153
10303
  class UserContextDataType < Struct.new(
10304
+ :ip_address,
10154
10305
  :encoded_data)
10155
10306
  SENSITIVE = []
10156
10307
  include Aws::Structure
@@ -10486,9 +10637,9 @@ module Aws::CognitoIdentityProvider
10486
10637
  #
10487
10638
  # @!attribute [rw] supported_identity_providers
10488
10639
  # A list of provider names for the IdPs that this client supports. The
10489
- # following are supported: `COGNITO`, `Facebook`, `Google`
10490
- # `LoginWithAmazon`, and the names of your own SAML and OIDC
10491
- # providers.
10640
+ # following are supported: `COGNITO`, `Facebook`, `Google`,
10641
+ # `SignInWithApple`, `LoginWithAmazon`, and the names of your own SAML
10642
+ # and OIDC providers.
10492
10643
  # @return [Array<String>]
10493
10644
  #
10494
10645
  # @!attribute [rw] callback_urls
@@ -10616,6 +10767,33 @@ module Aws::CognitoIdentityProvider
10616
10767
  # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html
10617
10768
  # @return [Boolean]
10618
10769
  #
10770
+ # @!attribute [rw] enable_propagate_additional_user_context_data
10771
+ # When `EnablePropagateAdditionalUserContextData` is true, Amazon
10772
+ # Cognito accepts an `IpAddress` value that you send in the
10773
+ # `UserContextData` parameter. The `UserContextData` parameter sends
10774
+ # information to Amazon Cognito advanced security for risk analysis.
10775
+ # You can send `UserContextData` when you sign in Amazon Cognito
10776
+ # native users with the `InitiateAuth` and `RespondToAuthChallenge`
10777
+ # API operations.
10778
+ #
10779
+ # When `EnablePropagateAdditionalUserContextData` is false, you can't
10780
+ # send your user's source IP address to Amazon Cognito advanced
10781
+ # security with unauthenticated API operations.
10782
+ # `EnablePropagateAdditionalUserContextData` doesn't affect whether
10783
+ # you can send a source IP address in a `ContextData` parameter with
10784
+ # the authenticated API operations `AdminInitiateAuth` and
10785
+ # `AdminRespondToAuthChallenge`.
10786
+ #
10787
+ # You can only activate `EnablePropagateAdditionalUserContextData` in
10788
+ # an app client that has a client secret. For more information about
10789
+ # propagation of user context data, see [Adding user device and
10790
+ # session data to API requests][1].
10791
+ #
10792
+ #
10793
+ #
10794
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint
10795
+ # @return [Boolean]
10796
+ #
10619
10797
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UserPoolClientType AWS API Documentation
10620
10798
  #
10621
10799
  class UserPoolClientType < Struct.new(
@@ -10641,7 +10819,8 @@ module Aws::CognitoIdentityProvider
10641
10819
  :allowed_o_auth_flows_user_pool_client,
10642
10820
  :analytics_configuration,
10643
10821
  :prevent_user_existence_errors,
10644
- :enable_token_revocation)
10822
+ :enable_token_revocation,
10823
+ :enable_propagate_additional_user_context_data)
10645
10824
  SENSITIVE = [:client_id, :client_secret]
10646
10825
  include Aws::Structure
10647
10826
  end
@@ -10795,6 +10974,16 @@ module Aws::CognitoIdentityProvider
10795
10974
  # @return [String]
10796
10975
  #
10797
10976
  # @!attribute [rw] user_attribute_update_settings
10977
+ # The settings for updates to user attributes. These settings include
10978
+ # the property `AttributesRequireVerificationBeforeUpdate`, a
10979
+ # user-pool setting that tells Amazon Cognito how to handle changes to
10980
+ # the value of your users' email address and phone number attributes.
10981
+ # For more information, see [ Verifying updates to email addresses and
10982
+ # phone numbers][1].
10983
+ #
10984
+ #
10985
+ #
10986
+ # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates
10798
10987
  # @return [Types::UserAttributeUpdateSettingsType]
10799
10988
  #
10800
10989
  # @!attribute [rw] mfa_configuration
@@ -10811,7 +11000,14 @@ module Aws::CognitoIdentityProvider
10811
11000
  # @return [String]
10812
11001
  #
10813
11002
  # @!attribute [rw] device_configuration
10814
- # The device configuration.
11003
+ # The device-remembering configuration for a user pool. A null value
11004
+ # indicates that you have deactivated device remembering in your user
11005
+ # pool.
11006
+ #
11007
+ # <note markdown="1"> When you provide a value for any `DeviceConfiguration` field, you
11008
+ # activate the Amazon Cognito device-remembering feature.
11009
+ #
11010
+ # </note>
10815
11011
  # @return [Types::DeviceConfigurationType]
10816
11012
  #
10817
11013
  # @!attribute [rw] estimated_number_of_users