aws-sdk-cognitoidentityprovider 1.69.0 → 1.71.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cognitoidentityprovider/client.rb +164 -61
- data/lib/aws-sdk-cognitoidentityprovider/client_api.rb +11 -0
- data/lib/aws-sdk-cognitoidentityprovider/types.rb +274 -92
- data/lib/aws-sdk-cognitoidentityprovider.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 390ff4767100b25fe34e4e87de3a85abc461fe848b76839de7dc9e1ba6e0c18c
|
4
|
+
data.tar.gz: 54bfe00cc0f1ba95b07a5fa20d46a2ec3d1ddcbd6cc3d0a3898ad289839451c1
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f775c3a1ed63da810a0fd3afa8525069fa127482124ce7fe6a9467c61f3fefc46b00d2f524be1e5596b62b09a31d9997f9cb08b9df59861e2f8e6c1546845ec4
|
7
|
+
data.tar.gz: af7590d16b8cdd2c65950cf592bf9ad063cfe8c31d5de1f6097b55e16b4dc0bd5e0304465e150b88af5f506b55700b1973811066395195bcd869f4bb99e8fa32
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.71.0 (2022-10-21)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release adds a new "DeletionProtection" field to the UserPool in Cognito. Application admins can configure this value with either ACTIVE or INACTIVE value. Setting this field to ACTIVE will prevent a user pool from accidental deletion.
|
8
|
+
|
9
|
+
1.70.0 (2022-09-02)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release adds a new "AuthSessionValidity" field to the UserPoolClient in Cognito. Application admins can configure this value for their users' authentication duration, which is currently fixed at 3 minutes, up to 15 minutes. Setting this field will also apply to the SMS MFA authentication flow.
|
13
|
+
|
4
14
|
1.69.0 (2022-08-18)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.71.0
|
@@ -873,9 +873,12 @@ module Aws::CognitoIdentityProvider
|
|
873
873
|
req.send_request(options)
|
874
874
|
end
|
875
875
|
|
876
|
-
#
|
876
|
+
# Deactivates a user and revokes all access tokens for the user. A
|
877
|
+
# deactivated user can't sign in, but still appears in the responses to
|
878
|
+
# `GetUser` and `ListUsers` API requests.
|
877
879
|
#
|
878
|
-
#
|
880
|
+
# You must make this API request with Amazon Web Services credentials
|
881
|
+
# that have `cognito-idp:AdminDisableUser` permissions.
|
879
882
|
#
|
880
883
|
# @option params [required, String] :user_pool_id
|
881
884
|
# The user pool ID for the user pool where you want to disable the user.
|
@@ -1500,7 +1503,9 @@ module Aws::CognitoIdentityProvider
|
|
1500
1503
|
# The user pool username or an alias.
|
1501
1504
|
#
|
1502
1505
|
# @option params [Integer] :max_results
|
1503
|
-
# The maximum number of authentication events to return.
|
1506
|
+
# The maximum number of authentication events to return. Returns 60
|
1507
|
+
# events if you set `MaxResults` to 0, or if you don't include a
|
1508
|
+
# `MaxResults` parameter.
|
1504
1509
|
#
|
1505
1510
|
# @option params [String] :next_token
|
1506
1511
|
# A pagination token.
|
@@ -2970,6 +2975,17 @@ module Aws::CognitoIdentityProvider
|
|
2970
2975
|
# @option params [Types::UserPoolPolicyType] :policies
|
2971
2976
|
# The policies associated with the new user pool.
|
2972
2977
|
#
|
2978
|
+
# @option params [String] :deletion_protection
|
2979
|
+
# When active, `DeletionProtection` prevents accidental deletion of your
|
2980
|
+
# user pool. Before you can delete a user pool that you have protected
|
2981
|
+
# against deletion, you must deactivate this feature.
|
2982
|
+
#
|
2983
|
+
# When you try to delete a protected user pool in a `DeleteUserPool` API
|
2984
|
+
# request, Amazon Cognito returns an `InvalidParameterException` error.
|
2985
|
+
# To delete a protected user pool, send a new `DeleteUserPool` request
|
2986
|
+
# after you deactivate deletion protection in an `UpdateUserPool` API
|
2987
|
+
# request.
|
2988
|
+
#
|
2973
2989
|
# @option params [Types::LambdaConfigType] :lambda_config
|
2974
2990
|
# The Lambda trigger configuration information for the new user pool.
|
2975
2991
|
#
|
@@ -3005,25 +3021,28 @@ module Aws::CognitoIdentityProvider
|
|
3005
3021
|
# username when they sign up.
|
3006
3022
|
#
|
3007
3023
|
# @option params [String] :sms_verification_message
|
3008
|
-
#
|
3024
|
+
# This parameter is no longer used. See
|
3025
|
+
# [VerificationMessageTemplateType][1].
|
3026
|
+
#
|
3027
|
+
#
|
3028
|
+
#
|
3029
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html
|
3009
3030
|
#
|
3010
3031
|
# @option params [String] :email_verification_message
|
3011
|
-
#
|
3012
|
-
#
|
3013
|
-
# is DEVELOPER.
|
3032
|
+
# This parameter is no longer used. See
|
3033
|
+
# [VerificationMessageTemplateType][1].
|
3014
3034
|
#
|
3015
3035
|
#
|
3016
3036
|
#
|
3017
|
-
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/
|
3037
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html
|
3018
3038
|
#
|
3019
3039
|
# @option params [String] :email_verification_subject
|
3020
|
-
#
|
3021
|
-
#
|
3022
|
-
# is DEVELOPER.
|
3040
|
+
# This parameter is no longer used. See
|
3041
|
+
# [VerificationMessageTemplateType][1].
|
3023
3042
|
#
|
3024
3043
|
#
|
3025
3044
|
#
|
3026
|
-
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/
|
3045
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html
|
3027
3046
|
#
|
3028
3047
|
# @option params [Types::VerificationMessageTemplateType] :verification_message_template
|
3029
3048
|
# The template for the verification message that the user sees when the
|
@@ -3125,6 +3144,7 @@ module Aws::CognitoIdentityProvider
|
|
3125
3144
|
# temporary_password_validity_days: 1,
|
3126
3145
|
# },
|
3127
3146
|
# },
|
3147
|
+
# deletion_protection: "ACTIVE", # accepts ACTIVE, INACTIVE
|
3128
3148
|
# lambda_config: {
|
3129
3149
|
# pre_sign_up: "ArnType",
|
3130
3150
|
# custom_message: "ArnType",
|
@@ -3236,6 +3256,7 @@ module Aws::CognitoIdentityProvider
|
|
3236
3256
|
# resp.user_pool.policies.password_policy.require_numbers #=> Boolean
|
3237
3257
|
# resp.user_pool.policies.password_policy.require_symbols #=> Boolean
|
3238
3258
|
# resp.user_pool.policies.password_policy.temporary_password_validity_days #=> Integer
|
3259
|
+
# resp.user_pool.deletion_protection #=> String, one of "ACTIVE", "INACTIVE"
|
3239
3260
|
# resp.user_pool.lambda_config.pre_sign_up #=> String
|
3240
3261
|
# resp.user_pool.lambda_config.custom_message #=> String
|
3241
3262
|
# resp.user_pool.lambda_config.post_confirmation #=> String
|
@@ -3357,6 +3378,9 @@ module Aws::CognitoIdentityProvider
|
|
3357
3378
|
# Cognito overrides the value with the default value of 30 days. *Valid
|
3358
3379
|
# range* is displayed below in seconds.
|
3359
3380
|
#
|
3381
|
+
# If you don't specify otherwise in the configuration of your app
|
3382
|
+
# client, your refresh tokens are valid for 30 days.
|
3383
|
+
#
|
3360
3384
|
# @option params [Integer] :access_token_validity
|
3361
3385
|
# The access token time limit. After this limit expires, your user
|
3362
3386
|
# can't use their access token. To specify the time unit for
|
@@ -3370,6 +3394,9 @@ module Aws::CognitoIdentityProvider
|
|
3370
3394
|
# The default time unit for `AccessTokenValidity` in an API request is
|
3371
3395
|
# hours. *Valid range* is displayed below in seconds.
|
3372
3396
|
#
|
3397
|
+
# If you don't specify otherwise in the configuration of your app
|
3398
|
+
# client, your access tokens are valid for one hour.
|
3399
|
+
#
|
3373
3400
|
# @option params [Integer] :id_token_validity
|
3374
3401
|
# The ID token time limit. After this limit expires, your user can't
|
3375
3402
|
# use their ID token. To specify the time unit for `IdTokenValidity` as
|
@@ -3383,6 +3410,9 @@ module Aws::CognitoIdentityProvider
|
|
3383
3410
|
# The default time unit for `AccessTokenValidity` in an API request is
|
3384
3411
|
# hours. *Valid range* is displayed below in seconds.
|
3385
3412
|
#
|
3413
|
+
# If you don't specify otherwise in the configuration of your app
|
3414
|
+
# client, your ID tokens are valid for one hour.
|
3415
|
+
#
|
3386
3416
|
# @option params [Types::TokenValidityUnitsType] :token_validity_units
|
3387
3417
|
# The units in which the validity times are represented. The default
|
3388
3418
|
# unit for RefreshToken is days, and default for ID and access tokens
|
@@ -3407,45 +3437,43 @@ module Aws::CognitoIdentityProvider
|
|
3407
3437
|
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html
|
3408
3438
|
#
|
3409
3439
|
# @option params [Array<String>] :explicit_auth_flows
|
3410
|
-
# The authentication flows that
|
3411
|
-
#
|
3412
|
-
#
|
3440
|
+
# The authentication flows that you want your user pool client to
|
3441
|
+
# support. For each app client in your user pool, you can sign in your
|
3442
|
+
# users with any combination of one or more flows, including with a user
|
3443
|
+
# name and Secure Remote Password (SRP), a user name and password, or a
|
3444
|
+
# custom authentication process that you define with Lambda functions.
|
3413
3445
|
#
|
3414
|
-
# <note markdown="1">
|
3415
|
-
#
|
3446
|
+
# <note markdown="1"> If you don't specify a value for `ExplicitAuthFlows`, your user
|
3447
|
+
# client supports `ALLOW_REFRESH_TOKEN_AUTH`, `ALLOW_USER_SRP_AUTH`, and
|
3448
|
+
# `ALLOW_CUSTOM_AUTH`.
|
3416
3449
|
#
|
3417
3450
|
# </note>
|
3418
3451
|
#
|
3419
3452
|
# Valid values include:
|
3420
3453
|
#
|
3421
|
-
#
|
3422
|
-
#
|
3423
|
-
#
|
3424
|
-
#
|
3425
|
-
#
|
3426
|
-
#
|
3427
|
-
# Secure Remote Password (SRP) protocol to verify passwords.
|
3428
|
-
#
|
3429
|
-
# ALLOW\_CUSTOM\_AUTH
|
3430
|
-
#
|
3431
|
-
# : Enable Lambda trigger based authentication.
|
3432
|
-
#
|
3433
|
-
# ALLOW\_USER\_PASSWORD\_AUTH
|
3434
|
-
#
|
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.
|
3454
|
+
# * `ALLOW_ADMIN_USER_PASSWORD_AUTH`\: Enable admin based user password
|
3455
|
+
# authentication flow `ADMIN_USER_PASSWORD_AUTH`. This setting
|
3456
|
+
# replaces the `ADMIN_NO_SRP_AUTH` setting. With this authentication
|
3457
|
+
# flow, your app passes a user name and password to Amazon Cognito in
|
3458
|
+
# the request, instead of using the Secure Remote Password (SRP)
|
3459
|
+
# protocol to securely transmit the password.
|
3438
3460
|
#
|
3439
|
-
#
|
3461
|
+
# * `ALLOW_CUSTOM_AUTH`\: Enable Lambda trigger based authentication.
|
3440
3462
|
#
|
3441
|
-
#
|
3463
|
+
# * `ALLOW_USER_PASSWORD_AUTH`\: Enable user password-based
|
3464
|
+
# authentication. In this flow, Amazon Cognito receives the password
|
3465
|
+
# in the request instead of using the SRP protocol to verify
|
3466
|
+
# passwords.
|
3442
3467
|
#
|
3443
|
-
#
|
3468
|
+
# * `ALLOW_USER_SRP_AUTH`\: Enable SRP-based authentication.
|
3444
3469
|
#
|
3445
|
-
#
|
3470
|
+
# * `ALLOW_REFRESH_TOKEN_AUTH`\: Enable authflow to refresh tokens.
|
3446
3471
|
#
|
3447
|
-
#
|
3448
|
-
#
|
3472
|
+
# In some environments, you will see the values `ADMIN_NO_SRP_AUTH`,
|
3473
|
+
# `CUSTOM_AUTH_FLOW_ONLY`, or `USER_PASSWORD_AUTH`. You can't assign
|
3474
|
+
# these legacy `ExplicitAuthFlows` values to user pool clients at the
|
3475
|
+
# same time as values that begin with `ALLOW_`, like
|
3476
|
+
# `ALLOW_USER_SRP_AUTH`.
|
3449
3477
|
#
|
3450
3478
|
# @option params [Array<String>] :supported_identity_providers
|
3451
3479
|
# A list of provider names for the identity providers (IdPs) that are
|
@@ -3585,6 +3613,12 @@ module Aws::CognitoIdentityProvider
|
|
3585
3613
|
#
|
3586
3614
|
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html
|
3587
3615
|
#
|
3616
|
+
# @option params [Integer] :auth_session_validity
|
3617
|
+
# Amazon Cognito creates a session token for each API request in an
|
3618
|
+
# authentication flow. `AuthSessionValidity` is the duration, in
|
3619
|
+
# minutes, of that session token. Your user pool native user must
|
3620
|
+
# respond to each authentication challenge before the session expires.
|
3621
|
+
#
|
3588
3622
|
# @return [Types::CreateUserPoolClientResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3589
3623
|
#
|
3590
3624
|
# * {Types::CreateUserPoolClientResponse#user_pool_client #user_pool_client} => Types::UserPoolClientType
|
@@ -3623,6 +3657,7 @@ module Aws::CognitoIdentityProvider
|
|
3623
3657
|
# prevent_user_existence_errors: "LEGACY", # accepts LEGACY, ENABLED
|
3624
3658
|
# enable_token_revocation: false,
|
3625
3659
|
# enable_propagate_additional_user_context_data: false,
|
3660
|
+
# auth_session_validity: 1,
|
3626
3661
|
# })
|
3627
3662
|
#
|
3628
3663
|
# @example Response structure
|
@@ -3665,6 +3700,7 @@ module Aws::CognitoIdentityProvider
|
|
3665
3700
|
# resp.user_pool_client.prevent_user_existence_errors #=> String, one of "LEGACY", "ENABLED"
|
3666
3701
|
# resp.user_pool_client.enable_token_revocation #=> Boolean
|
3667
3702
|
# resp.user_pool_client.enable_propagate_additional_user_context_data #=> Boolean
|
3703
|
+
# resp.user_pool_client.auth_session_validity #=> Integer
|
3668
3704
|
#
|
3669
3705
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolClient AWS API Documentation
|
3670
3706
|
#
|
@@ -4147,6 +4183,7 @@ module Aws::CognitoIdentityProvider
|
|
4147
4183
|
# resp.user_pool.policies.password_policy.require_numbers #=> Boolean
|
4148
4184
|
# resp.user_pool.policies.password_policy.require_symbols #=> Boolean
|
4149
4185
|
# resp.user_pool.policies.password_policy.temporary_password_validity_days #=> Integer
|
4186
|
+
# resp.user_pool.deletion_protection #=> String, one of "ACTIVE", "INACTIVE"
|
4150
4187
|
# resp.user_pool.lambda_config.pre_sign_up #=> String
|
4151
4188
|
# resp.user_pool.lambda_config.custom_message #=> String
|
4152
4189
|
# resp.user_pool.lambda_config.post_confirmation #=> String
|
@@ -4292,6 +4329,7 @@ module Aws::CognitoIdentityProvider
|
|
4292
4329
|
# resp.user_pool_client.prevent_user_existence_errors #=> String, one of "LEGACY", "ENABLED"
|
4293
4330
|
# resp.user_pool_client.enable_token_revocation #=> Boolean
|
4294
4331
|
# resp.user_pool_client.enable_propagate_additional_user_context_data #=> Boolean
|
4332
|
+
# resp.user_pool_client.auth_session_validity #=> Integer
|
4295
4333
|
#
|
4296
4334
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPoolClient AWS API Documentation
|
4297
4335
|
#
|
@@ -4656,6 +4694,12 @@ module Aws::CognitoIdentityProvider
|
|
4656
4694
|
end
|
4657
4695
|
|
4658
4696
|
# This method takes a user pool ID, and returns the signing certificate.
|
4697
|
+
# The issued certificate is valid for 10 years from the date of issue.
|
4698
|
+
#
|
4699
|
+
# Amazon Cognito issues and assigns a new signing certificate annually.
|
4700
|
+
# This process returns a new value in the response to
|
4701
|
+
# `GetSigningCertificate`, but doesn't invalidate the original
|
4702
|
+
# certificate.
|
4659
4703
|
#
|
4660
4704
|
# @option params [required, String] :user_pool_id
|
4661
4705
|
# The user pool ID.
|
@@ -4908,11 +4952,9 @@ module Aws::CognitoIdentityProvider
|
|
4908
4952
|
end
|
4909
4953
|
|
4910
4954
|
# Signs out users from all devices. It also invalidates all refresh
|
4911
|
-
# tokens that Amazon Cognito has issued to a user.
|
4912
|
-
#
|
4913
|
-
#
|
4914
|
-
# A user can still use a hosted UI cookie to retrieve new tokens for the
|
4915
|
-
# duration of the cookie validity period of 1 hour.
|
4955
|
+
# tokens that Amazon Cognito has issued to a user. A user can still use
|
4956
|
+
# a hosted UI cookie to retrieve new tokens for the duration of the
|
4957
|
+
# 1-hour cookie validity period.
|
4916
4958
|
#
|
4917
4959
|
# @option params [required, String] :access_token
|
4918
4960
|
# A valid access token that Amazon Cognito issued to the user who you
|
@@ -6037,9 +6079,10 @@ module Aws::CognitoIdentityProvider
|
|
6037
6079
|
req.send_request(options)
|
6038
6080
|
end
|
6039
6081
|
|
6040
|
-
# Revokes all of the access tokens generated by the
|
6041
|
-
# token. After
|
6042
|
-
# access Amazon Cognito
|
6082
|
+
# Revokes all of the access tokens generated by, and at the same time
|
6083
|
+
# as, the specified refresh token. After a token is revoked, you can't
|
6084
|
+
# use the revoked token to access Amazon Cognito user APIs, or to
|
6085
|
+
# authorize access to your resource server.
|
6043
6086
|
#
|
6044
6087
|
# @option params [required, String] :token
|
6045
6088
|
# The refresh token that you want to revoke.
|
@@ -6342,8 +6385,7 @@ module Aws::CognitoIdentityProvider
|
|
6342
6385
|
# @option params [String] :mfa_configuration
|
6343
6386
|
# The MFA configuration. If you set the MfaConfiguration value to ‘ON’,
|
6344
6387
|
# only users who have set up an MFA factor can sign in. To learn more,
|
6345
|
-
# see [Adding Multi-Factor Authentication (MFA) to a user
|
6346
|
-
# pool](cognito/latest/developerguide/user-pool-settings-mfa.html).
|
6388
|
+
# see [Adding Multi-Factor Authentication (MFA) to a user pool][1].
|
6347
6389
|
# Valid values include:
|
6348
6390
|
#
|
6349
6391
|
# * `OFF` MFA won't be used for any users.
|
@@ -6353,6 +6395,10 @@ module Aws::CognitoIdentityProvider
|
|
6353
6395
|
# * `OPTIONAL` MFA will be required only for individual users who have
|
6354
6396
|
# an MFA factor activated.
|
6355
6397
|
#
|
6398
|
+
#
|
6399
|
+
#
|
6400
|
+
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html
|
6401
|
+
#
|
6356
6402
|
# @return [Types::SetUserPoolMfaConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6357
6403
|
#
|
6358
6404
|
# * {Types::SetUserPoolMfaConfigResponse#sms_mfa_configuration #sms_mfa_configuration} => Types::SmsMfaConfigType
|
@@ -7151,6 +7197,17 @@ module Aws::CognitoIdentityProvider
|
|
7151
7197
|
# @option params [Types::UserPoolPolicyType] :policies
|
7152
7198
|
# A container with the policies you want to update in a user pool.
|
7153
7199
|
#
|
7200
|
+
# @option params [String] :deletion_protection
|
7201
|
+
# When active, `DeletionProtection` prevents accidental deletion of your
|
7202
|
+
# user pool. Before you can delete a user pool that you have protected
|
7203
|
+
# against deletion, you must deactivate this feature.
|
7204
|
+
#
|
7205
|
+
# When you try to delete a protected user pool in a `DeleteUserPool` API
|
7206
|
+
# request, Amazon Cognito returns an `InvalidParameterException` error.
|
7207
|
+
# To delete a protected user pool, send a new `DeleteUserPool` request
|
7208
|
+
# after you deactivate deletion protection in an `UpdateUserPool` API
|
7209
|
+
# request.
|
7210
|
+
#
|
7154
7211
|
# @option params [Types::LambdaConfigType] :lambda_config
|
7155
7212
|
# The Lambda configuration information from the request to update the
|
7156
7213
|
# user pool.
|
@@ -7160,13 +7217,28 @@ module Aws::CognitoIdentityProvider
|
|
7160
7217
|
# requests to update user pools.
|
7161
7218
|
#
|
7162
7219
|
# @option params [String] :sms_verification_message
|
7163
|
-
#
|
7220
|
+
# This parameter is no longer used. See
|
7221
|
+
# [VerificationMessageTemplateType][1].
|
7222
|
+
#
|
7223
|
+
#
|
7224
|
+
#
|
7225
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html
|
7164
7226
|
#
|
7165
7227
|
# @option params [String] :email_verification_message
|
7166
|
-
#
|
7228
|
+
# This parameter is no longer used. See
|
7229
|
+
# [VerificationMessageTemplateType][1].
|
7230
|
+
#
|
7231
|
+
#
|
7232
|
+
#
|
7233
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html
|
7167
7234
|
#
|
7168
7235
|
# @option params [String] :email_verification_subject
|
7169
|
-
#
|
7236
|
+
# This parameter is no longer used. See
|
7237
|
+
# [VerificationMessageTemplateType][1].
|
7238
|
+
#
|
7239
|
+
#
|
7240
|
+
#
|
7241
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html
|
7170
7242
|
#
|
7171
7243
|
# @option params [Types::VerificationMessageTemplateType] :verification_message_template
|
7172
7244
|
# The template for verification messages.
|
@@ -7266,6 +7338,7 @@ module Aws::CognitoIdentityProvider
|
|
7266
7338
|
# temporary_password_validity_days: 1,
|
7267
7339
|
# },
|
7268
7340
|
# },
|
7341
|
+
# deletion_protection: "ACTIVE", # accepts ACTIVE, INACTIVE
|
7269
7342
|
# lambda_config: {
|
7270
7343
|
# pre_sign_up: "ArnType",
|
7271
7344
|
# custom_message: "ArnType",
|
@@ -7395,6 +7468,9 @@ module Aws::CognitoIdentityProvider
|
|
7395
7468
|
# Cognito overrides the value with the default value of 30 days. *Valid
|
7396
7469
|
# range* is displayed below in seconds.
|
7397
7470
|
#
|
7471
|
+
# If you don't specify otherwise in the configuration of your app
|
7472
|
+
# client, your refresh tokens are valid for 30 days.
|
7473
|
+
#
|
7398
7474
|
# @option params [Integer] :access_token_validity
|
7399
7475
|
# The access token time limit. After this limit expires, your user
|
7400
7476
|
# can't use their access token. To specify the time unit for
|
@@ -7408,6 +7484,9 @@ module Aws::CognitoIdentityProvider
|
|
7408
7484
|
# The default time unit for `AccessTokenValidity` in an API request is
|
7409
7485
|
# hours. *Valid range* is displayed below in seconds.
|
7410
7486
|
#
|
7487
|
+
# If you don't specify otherwise in the configuration of your app
|
7488
|
+
# client, your access tokens are valid for one hour.
|
7489
|
+
#
|
7411
7490
|
# @option params [Integer] :id_token_validity
|
7412
7491
|
# The ID token time limit. After this limit expires, your user can't
|
7413
7492
|
# use their ID token. To specify the time unit for `IdTokenValidity` as
|
@@ -7421,6 +7500,9 @@ module Aws::CognitoIdentityProvider
|
|
7421
7500
|
# The default time unit for `AccessTokenValidity` in an API request is
|
7422
7501
|
# hours. *Valid range* is displayed below in seconds.
|
7423
7502
|
#
|
7503
|
+
# If you don't specify otherwise in the configuration of your app
|
7504
|
+
# client, your ID tokens are valid for one hour.
|
7505
|
+
#
|
7424
7506
|
# @option params [Types::TokenValidityUnitsType] :token_validity_units
|
7425
7507
|
# The units in which the validity times are represented. The default
|
7426
7508
|
# unit for RefreshToken is days, and the default for ID and access
|
@@ -7433,19 +7515,26 @@ module Aws::CognitoIdentityProvider
|
|
7433
7515
|
# The writeable attributes of the user pool.
|
7434
7516
|
#
|
7435
7517
|
# @option params [Array<String>] :explicit_auth_flows
|
7436
|
-
# The authentication flows that
|
7437
|
-
#
|
7438
|
-
#
|
7439
|
-
#
|
7440
|
-
#
|
7518
|
+
# The authentication flows that you want your user pool client to
|
7519
|
+
# support. For each app client in your user pool, you can sign in your
|
7520
|
+
# users with any combination of one or more flows, including with a user
|
7521
|
+
# name and Secure Remote Password (SRP), a user name and password, or a
|
7522
|
+
# custom authentication process that you define with Lambda functions.
|
7523
|
+
#
|
7524
|
+
# <note markdown="1"> If you don't specify a value for `ExplicitAuthFlows`, your user
|
7525
|
+
# client supports `ALLOW_REFRESH_TOKEN_AUTH`, `ALLOW_USER_SRP_AUTH`, and
|
7526
|
+
# `ALLOW_CUSTOM_AUTH`.
|
7527
|
+
#
|
7528
|
+
# </note>
|
7441
7529
|
#
|
7442
7530
|
# Valid values include:
|
7443
7531
|
#
|
7444
7532
|
# * `ALLOW_ADMIN_USER_PASSWORD_AUTH`\: Enable admin based user password
|
7445
7533
|
# authentication flow `ADMIN_USER_PASSWORD_AUTH`. This setting
|
7446
7534
|
# replaces the `ADMIN_NO_SRP_AUTH` setting. With this authentication
|
7447
|
-
# flow,
|
7448
|
-
# using the Secure Remote Password (SRP)
|
7535
|
+
# flow, your app passes a user name and password to Amazon Cognito in
|
7536
|
+
# the request, instead of using the Secure Remote Password (SRP)
|
7537
|
+
# protocol to securely transmit the password.
|
7449
7538
|
#
|
7450
7539
|
# * `ALLOW_CUSTOM_AUTH`\: Enable Lambda trigger based authentication.
|
7451
7540
|
#
|
@@ -7458,6 +7547,12 @@ module Aws::CognitoIdentityProvider
|
|
7458
7547
|
#
|
7459
7548
|
# * `ALLOW_REFRESH_TOKEN_AUTH`\: Enable authflow to refresh tokens.
|
7460
7549
|
#
|
7550
|
+
# In some environments, you will see the values `ADMIN_NO_SRP_AUTH`,
|
7551
|
+
# `CUSTOM_AUTH_FLOW_ONLY`, or `USER_PASSWORD_AUTH`. You can't assign
|
7552
|
+
# these legacy `ExplicitAuthFlows` values to user pool clients at the
|
7553
|
+
# same time as values that begin with `ALLOW_`, like
|
7554
|
+
# `ALLOW_USER_SRP_AUTH`.
|
7555
|
+
#
|
7461
7556
|
# @option params [Array<String>] :supported_identity_providers
|
7462
7557
|
# A list of provider names for the IdPs that this client supports. The
|
7463
7558
|
# following are supported: `COGNITO`, `Facebook`, `Google`,
|
@@ -7592,6 +7687,12 @@ module Aws::CognitoIdentityProvider
|
|
7592
7687
|
#
|
7593
7688
|
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html
|
7594
7689
|
#
|
7690
|
+
# @option params [Integer] :auth_session_validity
|
7691
|
+
# Amazon Cognito creates a session token for each API request in an
|
7692
|
+
# authentication flow. `AuthSessionValidity` is the duration, in
|
7693
|
+
# minutes, of that session token. Your user pool native user must
|
7694
|
+
# respond to each authentication challenge before the session expires.
|
7695
|
+
#
|
7595
7696
|
# @return [Types::UpdateUserPoolClientResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7596
7697
|
#
|
7597
7698
|
# * {Types::UpdateUserPoolClientResponse#user_pool_client #user_pool_client} => Types::UserPoolClientType
|
@@ -7630,6 +7731,7 @@ module Aws::CognitoIdentityProvider
|
|
7630
7731
|
# prevent_user_existence_errors: "LEGACY", # accepts LEGACY, ENABLED
|
7631
7732
|
# enable_token_revocation: false,
|
7632
7733
|
# enable_propagate_additional_user_context_data: false,
|
7734
|
+
# auth_session_validity: 1,
|
7633
7735
|
# })
|
7634
7736
|
#
|
7635
7737
|
# @example Response structure
|
@@ -7672,6 +7774,7 @@ module Aws::CognitoIdentityProvider
|
|
7672
7774
|
# resp.user_pool_client.prevent_user_existence_errors #=> String, one of "LEGACY", "ENABLED"
|
7673
7775
|
# resp.user_pool_client.enable_token_revocation #=> Boolean
|
7674
7776
|
# resp.user_pool_client.enable_propagate_additional_user_context_data #=> Boolean
|
7777
|
+
# resp.user_pool_client.auth_session_validity #=> Integer
|
7675
7778
|
#
|
7676
7779
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPoolClient AWS API Documentation
|
7677
7780
|
#
|
@@ -7867,7 +7970,7 @@ module Aws::CognitoIdentityProvider
|
|
7867
7970
|
params: params,
|
7868
7971
|
config: config)
|
7869
7972
|
context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
|
7870
|
-
context[:gem_version] = '1.
|
7973
|
+
context[:gem_version] = '1.71.0'
|
7871
7974
|
Seahorse::Client::Request.new(handlers, context)
|
7872
7975
|
end
|
7873
7976
|
|
@@ -95,6 +95,7 @@ module Aws::CognitoIdentityProvider
|
|
95
95
|
AuthEventsType = Shapes::ListShape.new(name: 'AuthEventsType')
|
96
96
|
AuthFlowType = Shapes::StringShape.new(name: 'AuthFlowType')
|
97
97
|
AuthParametersType = Shapes::MapShape.new(name: 'AuthParametersType')
|
98
|
+
AuthSessionValidityType = Shapes::IntegerShape.new(name: 'AuthSessionValidityType')
|
98
99
|
AuthenticationResultType = Shapes::StructureShape.new(name: 'AuthenticationResultType')
|
99
100
|
BlockedIPRangeListType = Shapes::ListShape.new(name: 'BlockedIPRangeListType')
|
100
101
|
BooleanType = Shapes::BooleanShape.new(name: 'BooleanType')
|
@@ -166,6 +167,7 @@ module Aws::CognitoIdentityProvider
|
|
166
167
|
DeleteUserPoolDomainResponse = Shapes::StructureShape.new(name: 'DeleteUserPoolDomainResponse')
|
167
168
|
DeleteUserPoolRequest = Shapes::StructureShape.new(name: 'DeleteUserPoolRequest')
|
168
169
|
DeleteUserRequest = Shapes::StructureShape.new(name: 'DeleteUserRequest')
|
170
|
+
DeletionProtectionType = Shapes::StringShape.new(name: 'DeletionProtectionType')
|
169
171
|
DeliveryMediumListType = Shapes::ListShape.new(name: 'DeliveryMediumListType')
|
170
172
|
DeliveryMediumType = Shapes::StringShape.new(name: 'DeliveryMediumType')
|
171
173
|
DescribeIdentityProviderRequest = Shapes::StructureShape.new(name: 'DescribeIdentityProviderRequest')
|
@@ -930,6 +932,7 @@ module Aws::CognitoIdentityProvider
|
|
930
932
|
CreateUserPoolClientRequest.add_member(:prevent_user_existence_errors, Shapes::ShapeRef.new(shape: PreventUserExistenceErrorTypes, location_name: "PreventUserExistenceErrors"))
|
931
933
|
CreateUserPoolClientRequest.add_member(:enable_token_revocation, Shapes::ShapeRef.new(shape: WrappedBooleanType, location_name: "EnableTokenRevocation"))
|
932
934
|
CreateUserPoolClientRequest.add_member(:enable_propagate_additional_user_context_data, Shapes::ShapeRef.new(shape: WrappedBooleanType, location_name: "EnablePropagateAdditionalUserContextData"))
|
935
|
+
CreateUserPoolClientRequest.add_member(:auth_session_validity, Shapes::ShapeRef.new(shape: AuthSessionValidityType, location_name: "AuthSessionValidity"))
|
933
936
|
CreateUserPoolClientRequest.struct_class = Types::CreateUserPoolClientRequest
|
934
937
|
|
935
938
|
CreateUserPoolClientResponse.add_member(:user_pool_client, Shapes::ShapeRef.new(shape: UserPoolClientType, location_name: "UserPoolClient"))
|
@@ -945,6 +948,7 @@ module Aws::CognitoIdentityProvider
|
|
945
948
|
|
946
949
|
CreateUserPoolRequest.add_member(:pool_name, Shapes::ShapeRef.new(shape: UserPoolNameType, required: true, location_name: "PoolName"))
|
947
950
|
CreateUserPoolRequest.add_member(:policies, Shapes::ShapeRef.new(shape: UserPoolPolicyType, location_name: "Policies"))
|
951
|
+
CreateUserPoolRequest.add_member(:deletion_protection, Shapes::ShapeRef.new(shape: DeletionProtectionType, location_name: "DeletionProtection"))
|
948
952
|
CreateUserPoolRequest.add_member(:lambda_config, Shapes::ShapeRef.new(shape: LambdaConfigType, location_name: "LambdaConfig"))
|
949
953
|
CreateUserPoolRequest.add_member(:auto_verified_attributes, Shapes::ShapeRef.new(shape: VerifiedAttributesListType, location_name: "AutoVerifiedAttributes"))
|
950
954
|
CreateUserPoolRequest.add_member(:alias_attributes, Shapes::ShapeRef.new(shape: AliasAttributesListType, location_name: "AliasAttributes"))
|
@@ -1788,6 +1792,7 @@ module Aws::CognitoIdentityProvider
|
|
1788
1792
|
UpdateUserPoolClientRequest.add_member(:prevent_user_existence_errors, Shapes::ShapeRef.new(shape: PreventUserExistenceErrorTypes, location_name: "PreventUserExistenceErrors"))
|
1789
1793
|
UpdateUserPoolClientRequest.add_member(:enable_token_revocation, Shapes::ShapeRef.new(shape: WrappedBooleanType, location_name: "EnableTokenRevocation"))
|
1790
1794
|
UpdateUserPoolClientRequest.add_member(:enable_propagate_additional_user_context_data, Shapes::ShapeRef.new(shape: WrappedBooleanType, location_name: "EnablePropagateAdditionalUserContextData"))
|
1795
|
+
UpdateUserPoolClientRequest.add_member(:auth_session_validity, Shapes::ShapeRef.new(shape: AuthSessionValidityType, location_name: "AuthSessionValidity"))
|
1791
1796
|
UpdateUserPoolClientRequest.struct_class = Types::UpdateUserPoolClientRequest
|
1792
1797
|
|
1793
1798
|
UpdateUserPoolClientResponse.add_member(:user_pool_client, Shapes::ShapeRef.new(shape: UserPoolClientType, location_name: "UserPoolClient"))
|
@@ -1803,6 +1808,7 @@ module Aws::CognitoIdentityProvider
|
|
1803
1808
|
|
1804
1809
|
UpdateUserPoolRequest.add_member(:user_pool_id, Shapes::ShapeRef.new(shape: UserPoolIdType, required: true, location_name: "UserPoolId"))
|
1805
1810
|
UpdateUserPoolRequest.add_member(:policies, Shapes::ShapeRef.new(shape: UserPoolPolicyType, location_name: "Policies"))
|
1811
|
+
UpdateUserPoolRequest.add_member(:deletion_protection, Shapes::ShapeRef.new(shape: DeletionProtectionType, location_name: "DeletionProtection"))
|
1806
1812
|
UpdateUserPoolRequest.add_member(:lambda_config, Shapes::ShapeRef.new(shape: LambdaConfigType, location_name: "LambdaConfig"))
|
1807
1813
|
UpdateUserPoolRequest.add_member(:auto_verified_attributes, Shapes::ShapeRef.new(shape: VerifiedAttributesListType, location_name: "AutoVerifiedAttributes"))
|
1808
1814
|
UpdateUserPoolRequest.add_member(:sms_verification_message, Shapes::ShapeRef.new(shape: SmsVerificationMessageType, location_name: "SmsVerificationMessage"))
|
@@ -1898,6 +1904,7 @@ module Aws::CognitoIdentityProvider
|
|
1898
1904
|
UserPoolClientType.add_member(:prevent_user_existence_errors, Shapes::ShapeRef.new(shape: PreventUserExistenceErrorTypes, location_name: "PreventUserExistenceErrors"))
|
1899
1905
|
UserPoolClientType.add_member(:enable_token_revocation, Shapes::ShapeRef.new(shape: WrappedBooleanType, location_name: "EnableTokenRevocation"))
|
1900
1906
|
UserPoolClientType.add_member(:enable_propagate_additional_user_context_data, Shapes::ShapeRef.new(shape: WrappedBooleanType, location_name: "EnablePropagateAdditionalUserContextData"))
|
1907
|
+
UserPoolClientType.add_member(:auth_session_validity, Shapes::ShapeRef.new(shape: AuthSessionValidityType, location_name: "AuthSessionValidity"))
|
1901
1908
|
UserPoolClientType.struct_class = Types::UserPoolClientType
|
1902
1909
|
|
1903
1910
|
UserPoolDescriptionType.add_member(:id, Shapes::ShapeRef.new(shape: UserPoolIdType, location_name: "Id"))
|
@@ -1924,6 +1931,7 @@ module Aws::CognitoIdentityProvider
|
|
1924
1931
|
UserPoolType.add_member(:id, Shapes::ShapeRef.new(shape: UserPoolIdType, location_name: "Id"))
|
1925
1932
|
UserPoolType.add_member(:name, Shapes::ShapeRef.new(shape: UserPoolNameType, location_name: "Name"))
|
1926
1933
|
UserPoolType.add_member(:policies, Shapes::ShapeRef.new(shape: UserPoolPolicyType, location_name: "Policies"))
|
1934
|
+
UserPoolType.add_member(:deletion_protection, Shapes::ShapeRef.new(shape: DeletionProtectionType, location_name: "DeletionProtection"))
|
1927
1935
|
UserPoolType.add_member(:lambda_config, Shapes::ShapeRef.new(shape: LambdaConfigType, location_name: "LambdaConfig"))
|
1928
1936
|
UserPoolType.add_member(:status, Shapes::ShapeRef.new(shape: StatusType, location_name: "Status"))
|
1929
1937
|
UserPoolType.add_member(:last_modified_date, Shapes::ShapeRef.new(shape: DateType, location_name: "LastModifiedDate"))
|
@@ -2700,6 +2708,7 @@ module Aws::CognitoIdentityProvider
|
|
2700
2708
|
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
2701
2709
|
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
2702
2710
|
o.errors << Shapes::ShapeRef.new(shape: UnsupportedIdentityProviderException)
|
2711
|
+
o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
|
2703
2712
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
2704
2713
|
o.errors << Shapes::ShapeRef.new(shape: NotAuthorizedException)
|
2705
2714
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
@@ -2779,6 +2788,7 @@ module Aws::CognitoIdentityProvider
|
|
2779
2788
|
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
2780
2789
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
2781
2790
|
o.errors << Shapes::ShapeRef.new(shape: NotAuthorizedException)
|
2791
|
+
o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
|
2782
2792
|
o.errors << Shapes::ShapeRef.new(shape: InternalErrorException)
|
2783
2793
|
end)
|
2784
2794
|
|
@@ -3561,6 +3571,7 @@ module Aws::CognitoIdentityProvider
|
|
3561
3571
|
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
3562
3572
|
o.errors << Shapes::ShapeRef.new(shape: UnsupportedIdentityProviderException)
|
3563
3573
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
3574
|
+
o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
|
3564
3575
|
o.errors << Shapes::ShapeRef.new(shape: NotAuthorizedException)
|
3565
3576
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
3566
3577
|
o.errors << Shapes::ShapeRef.new(shape: InternalErrorException)
|