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
@@ -1480,7 +1480,9 @@ module Aws::CognitoIdentityProvider
|
|
1480
1480
|
# @return [String]
|
1481
1481
|
#
|
1482
1482
|
# @!attribute [rw] max_results
|
1483
|
-
# The maximum number of authentication events to return.
|
1483
|
+
# The maximum number of authentication events to return. Returns 60
|
1484
|
+
# events if you set `MaxResults` to 0, or if you don't include a
|
1485
|
+
# `MaxResults` parameter.
|
1484
1486
|
# @return [Integer]
|
1485
1487
|
#
|
1486
1488
|
# @!attribute [rw] next_token
|
@@ -3401,6 +3403,7 @@ module Aws::CognitoIdentityProvider
|
|
3401
3403
|
# prevent_user_existence_errors: "LEGACY", # accepts LEGACY, ENABLED
|
3402
3404
|
# enable_token_revocation: false,
|
3403
3405
|
# enable_propagate_additional_user_context_data: false,
|
3406
|
+
# auth_session_validity: 1,
|
3404
3407
|
# }
|
3405
3408
|
#
|
3406
3409
|
# @!attribute [rw] user_pool_id
|
@@ -3431,6 +3434,9 @@ module Aws::CognitoIdentityProvider
|
|
3431
3434
|
# is days. You can't set `RefreshTokenValidity` to 0. If you do,
|
3432
3435
|
# Amazon Cognito overrides the value with the default value of 30
|
3433
3436
|
# days. *Valid range* is displayed below in seconds.
|
3437
|
+
#
|
3438
|
+
# If you don't specify otherwise in the configuration of your app
|
3439
|
+
# client, your refresh tokens are valid for 30 days.
|
3434
3440
|
# @return [Integer]
|
3435
3441
|
#
|
3436
3442
|
# @!attribute [rw] access_token_validity
|
@@ -3445,6 +3451,9 @@ module Aws::CognitoIdentityProvider
|
|
3445
3451
|
#
|
3446
3452
|
# The default time unit for `AccessTokenValidity` in an API request is
|
3447
3453
|
# hours. *Valid range* is displayed below in seconds.
|
3454
|
+
#
|
3455
|
+
# If you don't specify otherwise in the configuration of your app
|
3456
|
+
# client, your access tokens are valid for one hour.
|
3448
3457
|
# @return [Integer]
|
3449
3458
|
#
|
3450
3459
|
# @!attribute [rw] id_token_validity
|
@@ -3459,6 +3468,9 @@ module Aws::CognitoIdentityProvider
|
|
3459
3468
|
#
|
3460
3469
|
# The default time unit for `AccessTokenValidity` in an API request is
|
3461
3470
|
# hours. *Valid range* is displayed below in seconds.
|
3471
|
+
#
|
3472
|
+
# If you don't specify otherwise in the configuration of your app
|
3473
|
+
# client, your ID tokens are valid for one hour.
|
3462
3474
|
# @return [Integer]
|
3463
3475
|
#
|
3464
3476
|
# @!attribute [rw] token_validity_units
|
@@ -3488,45 +3500,44 @@ module Aws::CognitoIdentityProvider
|
|
3488
3500
|
# @return [Array<String>]
|
3489
3501
|
#
|
3490
3502
|
# @!attribute [rw] explicit_auth_flows
|
3491
|
-
# The authentication flows that
|
3492
|
-
#
|
3493
|
-
#
|
3503
|
+
# The authentication flows that you want your user pool client to
|
3504
|
+
# support. For each app client in your user pool, you can sign in your
|
3505
|
+
# users with any combination of one or more flows, including with a
|
3506
|
+
# user name and Secure Remote Password (SRP), a user name and
|
3507
|
+
# password, or a custom authentication process that you define with
|
3508
|
+
# Lambda functions.
|
3494
3509
|
#
|
3495
|
-
# <note markdown="1">
|
3496
|
-
# `
|
3510
|
+
# <note markdown="1"> If you don't specify a value for `ExplicitAuthFlows`, your user
|
3511
|
+
# client supports `ALLOW_REFRESH_TOKEN_AUTH`, `ALLOW_USER_SRP_AUTH`,
|
3512
|
+
# and `ALLOW_CUSTOM_AUTH`.
|
3497
3513
|
#
|
3498
3514
|
# </note>
|
3499
3515
|
#
|
3500
3516
|
# Valid values include:
|
3501
3517
|
#
|
3502
|
-
#
|
3503
|
-
#
|
3504
|
-
#
|
3505
|
-
#
|
3506
|
-
#
|
3507
|
-
#
|
3508
|
-
# Secure Remote Password (SRP) protocol to verify passwords.
|
3509
|
-
#
|
3510
|
-
# ALLOW\_CUSTOM\_AUTH
|
3511
|
-
#
|
3512
|
-
# : Enable Lambda trigger based authentication.
|
3513
|
-
#
|
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.
|
3518
|
+
# * `ALLOW_ADMIN_USER_PASSWORD_AUTH`\: Enable admin based user
|
3519
|
+
# password authentication flow `ADMIN_USER_PASSWORD_AUTH`. This
|
3520
|
+
# setting replaces the `ADMIN_NO_SRP_AUTH` setting. With this
|
3521
|
+
# authentication flow, your app passes a user name and password to
|
3522
|
+
# Amazon Cognito in the request, instead of using the Secure Remote
|
3523
|
+
# Password (SRP) protocol to securely transmit the password.
|
3519
3524
|
#
|
3520
|
-
#
|
3525
|
+
# * `ALLOW_CUSTOM_AUTH`\: Enable Lambda trigger based authentication.
|
3521
3526
|
#
|
3522
|
-
#
|
3527
|
+
# * `ALLOW_USER_PASSWORD_AUTH`\: Enable user password-based
|
3528
|
+
# authentication. In this flow, Amazon Cognito receives the password
|
3529
|
+
# in the request instead of using the SRP protocol to verify
|
3530
|
+
# passwords.
|
3523
3531
|
#
|
3524
|
-
#
|
3532
|
+
# * `ALLOW_USER_SRP_AUTH`\: Enable SRP-based authentication.
|
3525
3533
|
#
|
3526
|
-
#
|
3534
|
+
# * `ALLOW_REFRESH_TOKEN_AUTH`\: Enable authflow to refresh tokens.
|
3527
3535
|
#
|
3528
|
-
#
|
3529
|
-
#
|
3536
|
+
# In some environments, you will see the values `ADMIN_NO_SRP_AUTH`,
|
3537
|
+
# `CUSTOM_AUTH_FLOW_ONLY`, or `USER_PASSWORD_AUTH`. You can't assign
|
3538
|
+
# these legacy `ExplicitAuthFlows` values to user pool clients at the
|
3539
|
+
# same time as values that begin with `ALLOW_`, like
|
3540
|
+
# `ALLOW_USER_SRP_AUTH`.
|
3530
3541
|
# @return [Array<String>]
|
3531
3542
|
#
|
3532
3543
|
# @!attribute [rw] supported_identity_providers
|
@@ -3678,6 +3689,13 @@ module Aws::CognitoIdentityProvider
|
|
3678
3689
|
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html
|
3679
3690
|
# @return [Boolean]
|
3680
3691
|
#
|
3692
|
+
# @!attribute [rw] auth_session_validity
|
3693
|
+
# Amazon Cognito creates a session token for each API request in an
|
3694
|
+
# authentication flow. `AuthSessionValidity` is the duration, in
|
3695
|
+
# minutes, of that session token. Your user pool native user must
|
3696
|
+
# respond to each authentication challenge before the session expires.
|
3697
|
+
# @return [Integer]
|
3698
|
+
#
|
3681
3699
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolClientRequest AWS API Documentation
|
3682
3700
|
#
|
3683
3701
|
class CreateUserPoolClientRequest < Struct.new(
|
@@ -3701,7 +3719,8 @@ module Aws::CognitoIdentityProvider
|
|
3701
3719
|
:analytics_configuration,
|
3702
3720
|
:prevent_user_existence_errors,
|
3703
3721
|
:enable_token_revocation,
|
3704
|
-
:enable_propagate_additional_user_context_data
|
3722
|
+
:enable_propagate_additional_user_context_data,
|
3723
|
+
:auth_session_validity)
|
3705
3724
|
SENSITIVE = []
|
3706
3725
|
include Aws::Structure
|
3707
3726
|
end
|
@@ -3797,6 +3816,7 @@ module Aws::CognitoIdentityProvider
|
|
3797
3816
|
# temporary_password_validity_days: 1,
|
3798
3817
|
# },
|
3799
3818
|
# },
|
3819
|
+
# deletion_protection: "ACTIVE", # accepts ACTIVE, INACTIVE
|
3800
3820
|
# lambda_config: {
|
3801
3821
|
# pre_sign_up: "ArnType",
|
3802
3822
|
# custom_message: "ArnType",
|
@@ -3906,6 +3926,18 @@ module Aws::CognitoIdentityProvider
|
|
3906
3926
|
# The policies associated with the new user pool.
|
3907
3927
|
# @return [Types::UserPoolPolicyType]
|
3908
3928
|
#
|
3929
|
+
# @!attribute [rw] deletion_protection
|
3930
|
+
# When active, `DeletionProtection` prevents accidental deletion of
|
3931
|
+
# your user pool. Before you can delete a user pool that you have
|
3932
|
+
# protected against deletion, you must deactivate this feature.
|
3933
|
+
#
|
3934
|
+
# When you try to delete a protected user pool in a `DeleteUserPool`
|
3935
|
+
# API request, Amazon Cognito returns an `InvalidParameterException`
|
3936
|
+
# error. To delete a protected user pool, send a new `DeleteUserPool`
|
3937
|
+
# request after you deactivate deletion protection in an
|
3938
|
+
# `UpdateUserPool` API request.
|
3939
|
+
# @return [String]
|
3940
|
+
#
|
3909
3941
|
# @!attribute [rw] lambda_config
|
3910
3942
|
# The Lambda trigger configuration information for the new user pool.
|
3911
3943
|
#
|
@@ -3945,27 +3977,30 @@ module Aws::CognitoIdentityProvider
|
|
3945
3977
|
# @return [Array<String>]
|
3946
3978
|
#
|
3947
3979
|
# @!attribute [rw] sms_verification_message
|
3948
|
-
#
|
3980
|
+
# This parameter is no longer used. See
|
3981
|
+
# [VerificationMessageTemplateType][1].
|
3982
|
+
#
|
3983
|
+
#
|
3984
|
+
#
|
3985
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html
|
3949
3986
|
# @return [String]
|
3950
3987
|
#
|
3951
3988
|
# @!attribute [rw] email_verification_message
|
3952
|
-
#
|
3953
|
-
#
|
3954
|
-
# [EmailSendingAccount][1] is DEVELOPER.
|
3989
|
+
# This parameter is no longer used. See
|
3990
|
+
# [VerificationMessageTemplateType][1].
|
3955
3991
|
#
|
3956
3992
|
#
|
3957
3993
|
#
|
3958
|
-
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/
|
3994
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html
|
3959
3995
|
# @return [String]
|
3960
3996
|
#
|
3961
3997
|
# @!attribute [rw] email_verification_subject
|
3962
|
-
#
|
3963
|
-
#
|
3964
|
-
# [EmailSendingAccount][1] is DEVELOPER.
|
3998
|
+
# This parameter is no longer used. See
|
3999
|
+
# [VerificationMessageTemplateType][1].
|
3965
4000
|
#
|
3966
4001
|
#
|
3967
4002
|
#
|
3968
|
-
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/
|
4003
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html
|
3969
4004
|
# @return [String]
|
3970
4005
|
#
|
3971
4006
|
# @!attribute [rw] verification_message_template
|
@@ -4068,6 +4103,7 @@ module Aws::CognitoIdentityProvider
|
|
4068
4103
|
class CreateUserPoolRequest < Struct.new(
|
4069
4104
|
:pool_name,
|
4070
4105
|
:policies,
|
4106
|
+
:deletion_protection,
|
4071
4107
|
:lambda_config,
|
4072
4108
|
:auto_verified_attributes,
|
4073
4109
|
:alias_attributes,
|
@@ -4432,7 +4468,7 @@ module Aws::CognitoIdentityProvider
|
|
4432
4468
|
end
|
4433
4469
|
|
4434
4470
|
# @!attribute [rw] identity_provider
|
4435
|
-
# The
|
4471
|
+
# The identity provider details.
|
4436
4472
|
# @return [Types::IdentityProviderType]
|
4437
4473
|
#
|
4438
4474
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeIdentityProviderResponse AWS API Documentation
|
@@ -4672,15 +4708,35 @@ module Aws::CognitoIdentityProvider
|
|
4672
4708
|
include Aws::Structure
|
4673
4709
|
end
|
4674
4710
|
|
4675
|
-
# The device-remembering configuration for a user pool. A
|
4676
|
-
#
|
4677
|
-
# pool.
|
4711
|
+
# The device-remembering configuration for a user pool. A [
|
4712
|
+
# DescribeUserPool][1] request returns a null value for this object when
|
4713
|
+
# the user pool isn't configured to remember devices. When device
|
4714
|
+
# remembering is active, you can remember a user's device with a
|
4715
|
+
# [ConfirmDevice][2] API request. Additionally. when the property
|
4716
|
+
# `DeviceOnlyRememberedOnUserPrompt` is `true`, you must follow
|
4717
|
+
# `ConfirmDevice` with an [UpdateDeviceStatus][3] API request that sets
|
4718
|
+
# the user's device to `remembered` or `not_remembered`.
|
4719
|
+
#
|
4720
|
+
# To sign in with a remembered device, include `DEVICE_KEY` in the
|
4721
|
+
# authentication parameters in your user's [ InitiateAuth][4] request.
|
4722
|
+
# If your app doesn't include a `DEVICE_KEY` parameter, the
|
4723
|
+
# [response][5] from Amazon Cognito includes newly-generated
|
4724
|
+
# `DEVICE_KEY` and `DEVICE_GROUP_KEY` values under `NewDeviceMetadata`.
|
4725
|
+
# Store these values to use in future device-authentication requests.
|
4678
4726
|
#
|
4679
|
-
# <note markdown="1"> When you provide a value for any `DeviceConfiguration
|
4680
|
-
# activate the
|
4727
|
+
# <note markdown="1"> When you provide a value for any property of `DeviceConfiguration`,
|
4728
|
+
# you activate the device remembering for the user pool.
|
4681
4729
|
#
|
4682
4730
|
# </note>
|
4683
4731
|
#
|
4732
|
+
#
|
4733
|
+
#
|
4734
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html
|
4735
|
+
# [2]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html
|
4736
|
+
# [3]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html
|
4737
|
+
# [4]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html
|
4738
|
+
# [5]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html#API_InitiateAuth_ResponseSyntax
|
4739
|
+
#
|
4684
4740
|
# @note When making an API call, you may pass DeviceConfigurationType
|
4685
4741
|
# data as a hash:
|
4686
4742
|
#
|
@@ -4690,27 +4746,32 @@ module Aws::CognitoIdentityProvider
|
|
4690
4746
|
# }
|
4691
4747
|
#
|
4692
4748
|
# @!attribute [rw] challenge_required_on_new_device
|
4693
|
-
# When true, device
|
4694
|
-
#
|
4695
|
-
# (MFA).
|
4749
|
+
# When true, a remembered device can sign in with device
|
4750
|
+
# authentication instead of SMS and time-based one-time password
|
4751
|
+
# (TOTP) factors for multi-factor authentication (MFA).
|
4696
4752
|
#
|
4697
|
-
# <note markdown="1">
|
4698
|
-
# devices that have not been confirmed or remembered must
|
4699
|
-
# second factor
|
4753
|
+
# <note markdown="1"> Whether or not `ChallengeRequiredOnNewDevice` is true, users who
|
4754
|
+
# sign in with devices that have not been confirmed or remembered must
|
4755
|
+
# still provide a second factor in a user pool that requires MFA.
|
4700
4756
|
#
|
4701
4757
|
# </note>
|
4702
4758
|
# @return [Boolean]
|
4703
4759
|
#
|
4704
4760
|
# @!attribute [rw] device_only_remembered_on_user_prompt
|
4705
|
-
# When true, Amazon Cognito doesn't remember
|
4706
|
-
#
|
4707
|
-
#
|
4708
|
-
#
|
4709
|
-
#
|
4761
|
+
# When true, Amazon Cognito doesn't automatically remember a user's
|
4762
|
+
# device when your app sends a [ ConfirmDevice][1] API request. In
|
4763
|
+
# your app, create a prompt for your user to choose whether they want
|
4764
|
+
# to remember their device. Return the user's choice in an [
|
4765
|
+
# UpdateDeviceStatus][2] API request.
|
4710
4766
|
#
|
4767
|
+
# When `DeviceOnlyRememberedOnUserPrompt` is `false`, Amazon Cognito
|
4768
|
+
# immediately remembers devices that you register in a `ConfirmDevice`
|
4769
|
+
# API request.
|
4711
4770
|
#
|
4712
4771
|
#
|
4713
|
-
#
|
4772
|
+
#
|
4773
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html
|
4774
|
+
# [2]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html
|
4714
4775
|
# @return [Boolean]
|
4715
4776
|
#
|
4716
4777
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeviceConfigurationType AWS API Documentation
|
@@ -4926,7 +4987,7 @@ module Aws::CognitoIdentityProvider
|
|
4926
4987
|
# configuration.
|
4927
4988
|
#
|
4928
4989
|
# To look up the email delivery limit for the default option, see
|
4929
|
-
# [Limits
|
4990
|
+
# [Limits][1] in the *Amazon Cognito Developer Guide*.
|
4930
4991
|
#
|
4931
4992
|
# The default FROM address is `no-reply@verificationemail.com`. To
|
4932
4993
|
# customize the FROM address, provide the Amazon Resource Name (ARN)
|
@@ -4948,12 +5009,12 @@ module Aws::CognitoIdentityProvider
|
|
4948
5009
|
# Before Amazon Cognito can email your users, it requires additional
|
4949
5010
|
# permissions to call Amazon SES on your behalf. When you update
|
4950
5011
|
# your user pool with this option, Amazon Cognito creates a
|
4951
|
-
# *service-linked role*, which is a type of role
|
4952
|
-
# Services account. This role contains the permissions that allow
|
4953
|
-
# access Amazon SES and send email messages
|
4954
|
-
# more information about the service-linked role that
|
4955
|
-
# creates, see [Using Service-Linked Roles for Amazon
|
4956
|
-
# the *Amazon Cognito Developer Guide*.
|
5012
|
+
# *service-linked role*, which is a type of role in your Amazon Web
|
5013
|
+
# Services account. This role contains the permissions that allow
|
5014
|
+
# you to access Amazon SES and send email messages from your email
|
5015
|
+
# address. For more information about the service-linked role that
|
5016
|
+
# Amazon Cognito creates, see [Using Service-Linked Roles for Amazon
|
5017
|
+
# Cognito][2] in the *Amazon Cognito Developer Guide*.
|
4957
5018
|
#
|
4958
5019
|
#
|
4959
5020
|
#
|
@@ -5426,7 +5487,7 @@ module Aws::CognitoIdentityProvider
|
|
5426
5487
|
end
|
5427
5488
|
|
5428
5489
|
# @!attribute [rw] identity_provider
|
5429
|
-
# The
|
5490
|
+
# The identity provider details.
|
5430
5491
|
# @return [Types::IdentityProviderType]
|
5431
5492
|
#
|
5432
5493
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetIdentityProviderByIdentifierResponse AWS API Documentation
|
@@ -8405,8 +8466,7 @@ module Aws::CognitoIdentityProvider
|
|
8405
8466
|
# The MFA configuration. If you set the MfaConfiguration value to
|
8406
8467
|
# ‘ON’, only users who have set up an MFA factor can sign in. To learn
|
8407
8468
|
# more, see [Adding Multi-Factor Authentication (MFA) to a user
|
8408
|
-
# pool]
|
8409
|
-
# Valid values include:
|
8469
|
+
# pool][1]. Valid values include:
|
8410
8470
|
#
|
8411
8471
|
# * `OFF` MFA won't be used for any users.
|
8412
8472
|
#
|
@@ -8414,6 +8474,10 @@ module Aws::CognitoIdentityProvider
|
|
8414
8474
|
#
|
8415
8475
|
# * `OPTIONAL` MFA will be required only for individual users who have
|
8416
8476
|
# an MFA factor activated.
|
8477
|
+
#
|
8478
|
+
#
|
8479
|
+
#
|
8480
|
+
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html
|
8417
8481
|
# @return [String]
|
8418
8482
|
#
|
8419
8483
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetUserPoolMfaConfigRequest AWS API Documentation
|
@@ -9413,7 +9477,7 @@ module Aws::CognitoIdentityProvider
|
|
9413
9477
|
end
|
9414
9478
|
|
9415
9479
|
# @!attribute [rw] identity_provider
|
9416
|
-
# The
|
9480
|
+
# The identity provider details.
|
9417
9481
|
# @return [Types::IdentityProviderType]
|
9418
9482
|
#
|
9419
9483
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateIdentityProviderResponse AWS API Documentation
|
@@ -9617,6 +9681,7 @@ module Aws::CognitoIdentityProvider
|
|
9617
9681
|
# prevent_user_existence_errors: "LEGACY", # accepts LEGACY, ENABLED
|
9618
9682
|
# enable_token_revocation: false,
|
9619
9683
|
# enable_propagate_additional_user_context_data: false,
|
9684
|
+
# auth_session_validity: 1,
|
9620
9685
|
# }
|
9621
9686
|
#
|
9622
9687
|
# @!attribute [rw] user_pool_id
|
@@ -9646,6 +9711,9 @@ module Aws::CognitoIdentityProvider
|
|
9646
9711
|
# is days. You can't set `RefreshTokenValidity` to 0. If you do,
|
9647
9712
|
# Amazon Cognito overrides the value with the default value of 30
|
9648
9713
|
# days. *Valid range* is displayed below in seconds.
|
9714
|
+
#
|
9715
|
+
# If you don't specify otherwise in the configuration of your app
|
9716
|
+
# client, your refresh tokens are valid for 30 days.
|
9649
9717
|
# @return [Integer]
|
9650
9718
|
#
|
9651
9719
|
# @!attribute [rw] access_token_validity
|
@@ -9660,6 +9728,9 @@ module Aws::CognitoIdentityProvider
|
|
9660
9728
|
#
|
9661
9729
|
# The default time unit for `AccessTokenValidity` in an API request is
|
9662
9730
|
# hours. *Valid range* is displayed below in seconds.
|
9731
|
+
#
|
9732
|
+
# If you don't specify otherwise in the configuration of your app
|
9733
|
+
# client, your access tokens are valid for one hour.
|
9663
9734
|
# @return [Integer]
|
9664
9735
|
#
|
9665
9736
|
# @!attribute [rw] id_token_validity
|
@@ -9674,6 +9745,9 @@ module Aws::CognitoIdentityProvider
|
|
9674
9745
|
#
|
9675
9746
|
# The default time unit for `AccessTokenValidity` in an API request is
|
9676
9747
|
# hours. *Valid range* is displayed below in seconds.
|
9748
|
+
#
|
9749
|
+
# If you don't specify otherwise in the configuration of your app
|
9750
|
+
# client, your ID tokens are valid for one hour.
|
9677
9751
|
# @return [Integer]
|
9678
9752
|
#
|
9679
9753
|
# @!attribute [rw] token_validity_units
|
@@ -9691,20 +9765,27 @@ module Aws::CognitoIdentityProvider
|
|
9691
9765
|
# @return [Array<String>]
|
9692
9766
|
#
|
9693
9767
|
# @!attribute [rw] explicit_auth_flows
|
9694
|
-
# The authentication flows that
|
9695
|
-
#
|
9696
|
-
#
|
9697
|
-
#
|
9698
|
-
#
|
9768
|
+
# The authentication flows that you want your user pool client to
|
9769
|
+
# support. For each app client in your user pool, you can sign in your
|
9770
|
+
# users with any combination of one or more flows, including with a
|
9771
|
+
# user name and Secure Remote Password (SRP), a user name and
|
9772
|
+
# password, or a custom authentication process that you define with
|
9773
|
+
# Lambda functions.
|
9774
|
+
#
|
9775
|
+
# <note markdown="1"> If you don't specify a value for `ExplicitAuthFlows`, your user
|
9776
|
+
# client supports `ALLOW_REFRESH_TOKEN_AUTH`, `ALLOW_USER_SRP_AUTH`,
|
9777
|
+
# and `ALLOW_CUSTOM_AUTH`.
|
9778
|
+
#
|
9779
|
+
# </note>
|
9699
9780
|
#
|
9700
9781
|
# Valid values include:
|
9701
9782
|
#
|
9702
9783
|
# * `ALLOW_ADMIN_USER_PASSWORD_AUTH`\: Enable admin based user
|
9703
9784
|
# password authentication flow `ADMIN_USER_PASSWORD_AUTH`. This
|
9704
9785
|
# setting replaces the `ADMIN_NO_SRP_AUTH` setting. With this
|
9705
|
-
# authentication flow,
|
9706
|
-
# request instead of using the Secure Remote
|
9707
|
-
# to
|
9786
|
+
# authentication flow, your app passes a user name and password to
|
9787
|
+
# Amazon Cognito in the request, instead of using the Secure Remote
|
9788
|
+
# Password (SRP) protocol to securely transmit the password.
|
9708
9789
|
#
|
9709
9790
|
# * `ALLOW_CUSTOM_AUTH`\: Enable Lambda trigger based authentication.
|
9710
9791
|
#
|
@@ -9716,6 +9797,12 @@ module Aws::CognitoIdentityProvider
|
|
9716
9797
|
# * `ALLOW_USER_SRP_AUTH`\: Enable SRP-based authentication.
|
9717
9798
|
#
|
9718
9799
|
# * `ALLOW_REFRESH_TOKEN_AUTH`\: Enable authflow to refresh tokens.
|
9800
|
+
#
|
9801
|
+
# In some environments, you will see the values `ADMIN_NO_SRP_AUTH`,
|
9802
|
+
# `CUSTOM_AUTH_FLOW_ONLY`, or `USER_PASSWORD_AUTH`. You can't assign
|
9803
|
+
# these legacy `ExplicitAuthFlows` values to user pool clients at the
|
9804
|
+
# same time as values that begin with `ALLOW_`, like
|
9805
|
+
# `ALLOW_USER_SRP_AUTH`.
|
9719
9806
|
# @return [Array<String>]
|
9720
9807
|
#
|
9721
9808
|
# @!attribute [rw] supported_identity_providers
|
@@ -9863,6 +9950,13 @@ module Aws::CognitoIdentityProvider
|
|
9863
9950
|
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html
|
9864
9951
|
# @return [Boolean]
|
9865
9952
|
#
|
9953
|
+
# @!attribute [rw] auth_session_validity
|
9954
|
+
# Amazon Cognito creates a session token for each API request in an
|
9955
|
+
# authentication flow. `AuthSessionValidity` is the duration, in
|
9956
|
+
# minutes, of that session token. Your user pool native user must
|
9957
|
+
# respond to each authentication challenge before the session expires.
|
9958
|
+
# @return [Integer]
|
9959
|
+
#
|
9866
9960
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPoolClientRequest AWS API Documentation
|
9867
9961
|
#
|
9868
9962
|
class UpdateUserPoolClientRequest < Struct.new(
|
@@ -9886,7 +9980,8 @@ module Aws::CognitoIdentityProvider
|
|
9886
9980
|
:analytics_configuration,
|
9887
9981
|
:prevent_user_existence_errors,
|
9888
9982
|
:enable_token_revocation,
|
9889
|
-
:enable_propagate_additional_user_context_data
|
9983
|
+
:enable_propagate_additional_user_context_data,
|
9984
|
+
:auth_session_validity)
|
9890
9985
|
SENSITIVE = [:client_id]
|
9891
9986
|
include Aws::Structure
|
9892
9987
|
end
|
@@ -9983,6 +10078,7 @@ module Aws::CognitoIdentityProvider
|
|
9983
10078
|
# temporary_password_validity_days: 1,
|
9984
10079
|
# },
|
9985
10080
|
# },
|
10081
|
+
# deletion_protection: "ACTIVE", # accepts ACTIVE, INACTIVE
|
9986
10082
|
# lambda_config: {
|
9987
10083
|
# pre_sign_up: "ArnType",
|
9988
10084
|
# custom_message: "ArnType",
|
@@ -10070,6 +10166,18 @@ module Aws::CognitoIdentityProvider
|
|
10070
10166
|
# A container with the policies you want to update in a user pool.
|
10071
10167
|
# @return [Types::UserPoolPolicyType]
|
10072
10168
|
#
|
10169
|
+
# @!attribute [rw] deletion_protection
|
10170
|
+
# When active, `DeletionProtection` prevents accidental deletion of
|
10171
|
+
# your user pool. Before you can delete a user pool that you have
|
10172
|
+
# protected against deletion, you must deactivate this feature.
|
10173
|
+
#
|
10174
|
+
# When you try to delete a protected user pool in a `DeleteUserPool`
|
10175
|
+
# API request, Amazon Cognito returns an `InvalidParameterException`
|
10176
|
+
# error. To delete a protected user pool, send a new `DeleteUserPool`
|
10177
|
+
# request after you deactivate deletion protection in an
|
10178
|
+
# `UpdateUserPool` API request.
|
10179
|
+
# @return [String]
|
10180
|
+
#
|
10073
10181
|
# @!attribute [rw] lambda_config
|
10074
10182
|
# The Lambda configuration information from the request to update the
|
10075
10183
|
# user pool.
|
@@ -10081,15 +10189,30 @@ module Aws::CognitoIdentityProvider
|
|
10081
10189
|
# @return [Array<String>]
|
10082
10190
|
#
|
10083
10191
|
# @!attribute [rw] sms_verification_message
|
10084
|
-
#
|
10192
|
+
# This parameter is no longer used. See
|
10193
|
+
# [VerificationMessageTemplateType][1].
|
10194
|
+
#
|
10195
|
+
#
|
10196
|
+
#
|
10197
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html
|
10085
10198
|
# @return [String]
|
10086
10199
|
#
|
10087
10200
|
# @!attribute [rw] email_verification_message
|
10088
|
-
#
|
10201
|
+
# This parameter is no longer used. See
|
10202
|
+
# [VerificationMessageTemplateType][1].
|
10203
|
+
#
|
10204
|
+
#
|
10205
|
+
#
|
10206
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html
|
10089
10207
|
# @return [String]
|
10090
10208
|
#
|
10091
10209
|
# @!attribute [rw] email_verification_subject
|
10092
|
-
#
|
10210
|
+
# This parameter is no longer used. See
|
10211
|
+
# [VerificationMessageTemplateType][1].
|
10212
|
+
#
|
10213
|
+
#
|
10214
|
+
#
|
10215
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html
|
10093
10216
|
# @return [String]
|
10094
10217
|
#
|
10095
10218
|
# @!attribute [rw] verification_message_template
|
@@ -10190,6 +10313,7 @@ module Aws::CognitoIdentityProvider
|
|
10190
10313
|
class UpdateUserPoolRequest < Struct.new(
|
10191
10314
|
:user_pool_id,
|
10192
10315
|
:policies,
|
10316
|
+
:deletion_protection,
|
10193
10317
|
:lambda_config,
|
10194
10318
|
:auto_verified_attributes,
|
10195
10319
|
:sms_verification_message,
|
@@ -10564,6 +10688,9 @@ module Aws::CognitoIdentityProvider
|
|
10564
10688
|
# is days. You can't set `RefreshTokenValidity` to 0. If you do,
|
10565
10689
|
# Amazon Cognito overrides the value with the default value of 30
|
10566
10690
|
# days. *Valid range* is displayed below in seconds.
|
10691
|
+
#
|
10692
|
+
# If you don't specify otherwise in the configuration of your app
|
10693
|
+
# client, your refresh tokens are valid for 30 days.
|
10567
10694
|
# @return [Integer]
|
10568
10695
|
#
|
10569
10696
|
# @!attribute [rw] access_token_validity
|
@@ -10578,6 +10705,9 @@ module Aws::CognitoIdentityProvider
|
|
10578
10705
|
#
|
10579
10706
|
# The default time unit for `AccessTokenValidity` in an API request is
|
10580
10707
|
# hours. *Valid range* is displayed below in seconds.
|
10708
|
+
#
|
10709
|
+
# If you don't specify otherwise in the configuration of your app
|
10710
|
+
# client, your access tokens are valid for one hour.
|
10581
10711
|
# @return [Integer]
|
10582
10712
|
#
|
10583
10713
|
# @!attribute [rw] id_token_validity
|
@@ -10592,6 +10722,9 @@ module Aws::CognitoIdentityProvider
|
|
10592
10722
|
#
|
10593
10723
|
# The default time unit for `AccessTokenValidity` in an API request is
|
10594
10724
|
# hours. *Valid range* is displayed below in seconds.
|
10725
|
+
#
|
10726
|
+
# If you don't specify otherwise in the configuration of your app
|
10727
|
+
# client, your ID tokens are valid for one hour.
|
10595
10728
|
# @return [Integer]
|
10596
10729
|
#
|
10597
10730
|
# @!attribute [rw] token_validity_units
|
@@ -10608,20 +10741,27 @@ module Aws::CognitoIdentityProvider
|
|
10608
10741
|
# @return [Array<String>]
|
10609
10742
|
#
|
10610
10743
|
# @!attribute [rw] explicit_auth_flows
|
10611
|
-
# The authentication flows that
|
10612
|
-
#
|
10613
|
-
#
|
10614
|
-
#
|
10615
|
-
#
|
10744
|
+
# The authentication flows that you want your user pool client to
|
10745
|
+
# support. For each app client in your user pool, you can sign in your
|
10746
|
+
# users with any combination of one or more flows, including with a
|
10747
|
+
# user name and Secure Remote Password (SRP), a user name and
|
10748
|
+
# password, or a custom authentication process that you define with
|
10749
|
+
# Lambda functions.
|
10750
|
+
#
|
10751
|
+
# <note markdown="1"> If you don't specify a value for `ExplicitAuthFlows`, your user
|
10752
|
+
# client supports `ALLOW_REFRESH_TOKEN_AUTH`, `ALLOW_USER_SRP_AUTH`,
|
10753
|
+
# and `ALLOW_CUSTOM_AUTH`.
|
10754
|
+
#
|
10755
|
+
# </note>
|
10616
10756
|
#
|
10617
10757
|
# Valid values include:
|
10618
10758
|
#
|
10619
10759
|
# * `ALLOW_ADMIN_USER_PASSWORD_AUTH`\: Enable admin based user
|
10620
10760
|
# password authentication flow `ADMIN_USER_PASSWORD_AUTH`. This
|
10621
10761
|
# setting replaces the `ADMIN_NO_SRP_AUTH` setting. With this
|
10622
|
-
# authentication flow,
|
10623
|
-
# request instead of using the Secure Remote
|
10624
|
-
# to
|
10762
|
+
# authentication flow, your app passes a user name and password to
|
10763
|
+
# Amazon Cognito in the request, instead of using the Secure Remote
|
10764
|
+
# Password (SRP) protocol to securely transmit the password.
|
10625
10765
|
#
|
10626
10766
|
# * `ALLOW_CUSTOM_AUTH`\: Enable Lambda trigger based authentication.
|
10627
10767
|
#
|
@@ -10633,6 +10773,12 @@ module Aws::CognitoIdentityProvider
|
|
10633
10773
|
# * `ALLOW_USER_SRP_AUTH`\: Enable SRP-based authentication.
|
10634
10774
|
#
|
10635
10775
|
# * `ALLOW_REFRESH_TOKEN_AUTH`\: Enable authflow to refresh tokens.
|
10776
|
+
#
|
10777
|
+
# In some environments, you will see the values `ADMIN_NO_SRP_AUTH`,
|
10778
|
+
# `CUSTOM_AUTH_FLOW_ONLY`, or `USER_PASSWORD_AUTH`. You can't assign
|
10779
|
+
# these legacy `ExplicitAuthFlows` values to user pool clients at the
|
10780
|
+
# same time as values that begin with `ALLOW_`, like
|
10781
|
+
# `ALLOW_USER_SRP_AUTH`.
|
10636
10782
|
# @return [Array<String>]
|
10637
10783
|
#
|
10638
10784
|
# @!attribute [rw] supported_identity_providers
|
@@ -10794,6 +10940,13 @@ module Aws::CognitoIdentityProvider
|
|
10794
10940
|
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint
|
10795
10941
|
# @return [Boolean]
|
10796
10942
|
#
|
10943
|
+
# @!attribute [rw] auth_session_validity
|
10944
|
+
# Amazon Cognito creates a session token for each API request in an
|
10945
|
+
# authentication flow. `AuthSessionValidity` is the duration, in
|
10946
|
+
# minutes, of that session token. Your user pool native user must
|
10947
|
+
# respond to each authentication challenge before the session expires.
|
10948
|
+
# @return [Integer]
|
10949
|
+
#
|
10797
10950
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UserPoolClientType AWS API Documentation
|
10798
10951
|
#
|
10799
10952
|
class UserPoolClientType < Struct.new(
|
@@ -10820,7 +10973,8 @@ module Aws::CognitoIdentityProvider
|
|
10820
10973
|
:analytics_configuration,
|
10821
10974
|
:prevent_user_existence_errors,
|
10822
10975
|
:enable_token_revocation,
|
10823
|
-
:enable_propagate_additional_user_context_data
|
10976
|
+
:enable_propagate_additional_user_context_data,
|
10977
|
+
:auth_session_validity)
|
10824
10978
|
SENSITIVE = [:client_id, :client_secret]
|
10825
10979
|
include Aws::Structure
|
10826
10980
|
end
|
@@ -10920,6 +11074,18 @@ module Aws::CognitoIdentityProvider
|
|
10920
11074
|
# The policies associated with the user pool.
|
10921
11075
|
# @return [Types::UserPoolPolicyType]
|
10922
11076
|
#
|
11077
|
+
# @!attribute [rw] deletion_protection
|
11078
|
+
# When active, `DeletionProtection` prevents accidental deletion of
|
11079
|
+
# your user pool. Before you can delete a user pool that you have
|
11080
|
+
# protected against deletion, you must deactivate this feature.
|
11081
|
+
#
|
11082
|
+
# When you try to delete a protected user pool in a `DeleteUserPool`
|
11083
|
+
# API request, Amazon Cognito returns an `InvalidParameterException`
|
11084
|
+
# error. To delete a protected user pool, send a new `DeleteUserPool`
|
11085
|
+
# request after you deactivate deletion protection in an
|
11086
|
+
# `UpdateUserPool` API request.
|
11087
|
+
# @return [String]
|
11088
|
+
#
|
10923
11089
|
# @!attribute [rw] lambda_config
|
10924
11090
|
# The Lambda triggers associated with the user pool.
|
10925
11091
|
# @return [Types::LambdaConfigType]
|
@@ -10954,15 +11120,30 @@ module Aws::CognitoIdentityProvider
|
|
10954
11120
|
# @return [Array<String>]
|
10955
11121
|
#
|
10956
11122
|
# @!attribute [rw] sms_verification_message
|
10957
|
-
#
|
11123
|
+
# This parameter is no longer used. See
|
11124
|
+
# [VerificationMessageTemplateType][1].
|
11125
|
+
#
|
11126
|
+
#
|
11127
|
+
#
|
11128
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html
|
10958
11129
|
# @return [String]
|
10959
11130
|
#
|
10960
11131
|
# @!attribute [rw] email_verification_message
|
10961
|
-
#
|
11132
|
+
# This parameter is no longer used. See
|
11133
|
+
# [VerificationMessageTemplateType][1].
|
11134
|
+
#
|
11135
|
+
#
|
11136
|
+
#
|
11137
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html
|
10962
11138
|
# @return [String]
|
10963
11139
|
#
|
10964
11140
|
# @!attribute [rw] email_verification_subject
|
10965
|
-
#
|
11141
|
+
# This parameter is no longer used. See
|
11142
|
+
# [VerificationMessageTemplateType][1].
|
11143
|
+
#
|
11144
|
+
#
|
11145
|
+
#
|
11146
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html
|
10966
11147
|
# @return [String]
|
10967
11148
|
#
|
10968
11149
|
# @!attribute [rw] verification_message_template
|
@@ -11129,6 +11310,7 @@ module Aws::CognitoIdentityProvider
|
|
11129
11310
|
:id,
|
11130
11311
|
:name,
|
11131
11312
|
:policies,
|
11313
|
+
:deletion_protection,
|
11132
11314
|
:lambda_config,
|
11133
11315
|
:status,
|
11134
11316
|
:last_modified_date,
|