aws-sdk-cognitoidentityprovider 1.42.0 → 1.43.0
Sign up to get free protection for your applications and to get access to all the features.
@@ -14,6 +14,7 @@ module Aws::CognitoIdentityProvider
|
|
14
14
|
include Seahorse::Model
|
15
15
|
|
16
16
|
AWSAccountIdType = Shapes::StringShape.new(name: 'AWSAccountIdType')
|
17
|
+
AccessTokenValidityType = Shapes::IntegerShape.new(name: 'AccessTokenValidityType')
|
17
18
|
AccountRecoverySettingType = Shapes::StructureShape.new(name: 'AccountRecoverySettingType')
|
18
19
|
AccountTakeoverActionNotifyType = Shapes::BooleanShape.new(name: 'AccountTakeoverActionNotifyType')
|
19
20
|
AccountTakeoverActionType = Shapes::StructureShape.new(name: 'AccountTakeoverActionType')
|
@@ -243,6 +244,7 @@ module Aws::CognitoIdentityProvider
|
|
243
244
|
HexStringType = Shapes::StringShape.new(name: 'HexStringType')
|
244
245
|
HttpHeader = Shapes::StructureShape.new(name: 'HttpHeader')
|
245
246
|
HttpHeaderList = Shapes::ListShape.new(name: 'HttpHeaderList')
|
247
|
+
IdTokenValidityType = Shapes::IntegerShape.new(name: 'IdTokenValidityType')
|
246
248
|
IdentityProviderType = Shapes::StructureShape.new(name: 'IdentityProviderType')
|
247
249
|
IdentityProviderTypeType = Shapes::StringShape.new(name: 'IdentityProviderTypeType')
|
248
250
|
IdpIdentifierType = Shapes::StringShape.new(name: 'IdpIdentifierType')
|
@@ -389,7 +391,9 @@ module Aws::CognitoIdentityProvider
|
|
389
391
|
TagResourceResponse = Shapes::StructureShape.new(name: 'TagResourceResponse')
|
390
392
|
TagValueType = Shapes::StringShape.new(name: 'TagValueType')
|
391
393
|
TemporaryPasswordValidityDaysType = Shapes::IntegerShape.new(name: 'TemporaryPasswordValidityDaysType')
|
394
|
+
TimeUnitsType = Shapes::StringShape.new(name: 'TimeUnitsType')
|
392
395
|
TokenModelType = Shapes::StringShape.new(name: 'TokenModelType')
|
396
|
+
TokenValidityUnitsType = Shapes::StructureShape.new(name: 'TokenValidityUnitsType')
|
393
397
|
TooManyFailedAttemptsException = Shapes::StructureShape.new(name: 'TooManyFailedAttemptsException')
|
394
398
|
TooManyRequestsException = Shapes::StructureShape.new(name: 'TooManyRequestsException')
|
395
399
|
UICustomizationType = Shapes::StructureShape.new(name: 'UICustomizationType')
|
@@ -893,6 +897,9 @@ module Aws::CognitoIdentityProvider
|
|
893
897
|
CreateUserPoolClientRequest.add_member(:client_name, Shapes::ShapeRef.new(shape: ClientNameType, required: true, location_name: "ClientName"))
|
894
898
|
CreateUserPoolClientRequest.add_member(:generate_secret, Shapes::ShapeRef.new(shape: GenerateSecret, location_name: "GenerateSecret"))
|
895
899
|
CreateUserPoolClientRequest.add_member(:refresh_token_validity, Shapes::ShapeRef.new(shape: RefreshTokenValidityType, location_name: "RefreshTokenValidity"))
|
900
|
+
CreateUserPoolClientRequest.add_member(:access_token_validity, Shapes::ShapeRef.new(shape: AccessTokenValidityType, location_name: "AccessTokenValidity"))
|
901
|
+
CreateUserPoolClientRequest.add_member(:id_token_validity, Shapes::ShapeRef.new(shape: IdTokenValidityType, location_name: "IdTokenValidity"))
|
902
|
+
CreateUserPoolClientRequest.add_member(:token_validity_units, Shapes::ShapeRef.new(shape: TokenValidityUnitsType, location_name: "TokenValidityUnits"))
|
896
903
|
CreateUserPoolClientRequest.add_member(:read_attributes, Shapes::ShapeRef.new(shape: ClientPermissionListType, location_name: "ReadAttributes"))
|
897
904
|
CreateUserPoolClientRequest.add_member(:write_attributes, Shapes::ShapeRef.new(shape: ClientPermissionListType, location_name: "WriteAttributes"))
|
898
905
|
CreateUserPoolClientRequest.add_member(:explicit_auth_flows, Shapes::ShapeRef.new(shape: ExplicitAuthFlowsListType, location_name: "ExplicitAuthFlows"))
|
@@ -1622,6 +1629,11 @@ module Aws::CognitoIdentityProvider
|
|
1622
1629
|
|
1623
1630
|
TagResourceResponse.struct_class = Types::TagResourceResponse
|
1624
1631
|
|
1632
|
+
TokenValidityUnitsType.add_member(:access_token, Shapes::ShapeRef.new(shape: TimeUnitsType, location_name: "AccessToken"))
|
1633
|
+
TokenValidityUnitsType.add_member(:id_token, Shapes::ShapeRef.new(shape: TimeUnitsType, location_name: "IdToken"))
|
1634
|
+
TokenValidityUnitsType.add_member(:refresh_token, Shapes::ShapeRef.new(shape: TimeUnitsType, location_name: "RefreshToken"))
|
1635
|
+
TokenValidityUnitsType.struct_class = Types::TokenValidityUnitsType
|
1636
|
+
|
1625
1637
|
TooManyFailedAttemptsException.add_member(:message, Shapes::ShapeRef.new(shape: MessageType, location_name: "message"))
|
1626
1638
|
TooManyFailedAttemptsException.struct_class = Types::TooManyFailedAttemptsException
|
1627
1639
|
|
@@ -1709,6 +1721,9 @@ module Aws::CognitoIdentityProvider
|
|
1709
1721
|
UpdateUserPoolClientRequest.add_member(:client_id, Shapes::ShapeRef.new(shape: ClientIdType, required: true, location_name: "ClientId"))
|
1710
1722
|
UpdateUserPoolClientRequest.add_member(:client_name, Shapes::ShapeRef.new(shape: ClientNameType, location_name: "ClientName"))
|
1711
1723
|
UpdateUserPoolClientRequest.add_member(:refresh_token_validity, Shapes::ShapeRef.new(shape: RefreshTokenValidityType, location_name: "RefreshTokenValidity"))
|
1724
|
+
UpdateUserPoolClientRequest.add_member(:access_token_validity, Shapes::ShapeRef.new(shape: AccessTokenValidityType, location_name: "AccessTokenValidity"))
|
1725
|
+
UpdateUserPoolClientRequest.add_member(:id_token_validity, Shapes::ShapeRef.new(shape: IdTokenValidityType, location_name: "IdTokenValidity"))
|
1726
|
+
UpdateUserPoolClientRequest.add_member(:token_validity_units, Shapes::ShapeRef.new(shape: TokenValidityUnitsType, location_name: "TokenValidityUnits"))
|
1712
1727
|
UpdateUserPoolClientRequest.add_member(:read_attributes, Shapes::ShapeRef.new(shape: ClientPermissionListType, location_name: "ReadAttributes"))
|
1713
1728
|
UpdateUserPoolClientRequest.add_member(:write_attributes, Shapes::ShapeRef.new(shape: ClientPermissionListType, location_name: "WriteAttributes"))
|
1714
1729
|
UpdateUserPoolClientRequest.add_member(:explicit_auth_flows, Shapes::ShapeRef.new(shape: ExplicitAuthFlowsListType, location_name: "ExplicitAuthFlows"))
|
@@ -1809,6 +1824,9 @@ module Aws::CognitoIdentityProvider
|
|
1809
1824
|
UserPoolClientType.add_member(:last_modified_date, Shapes::ShapeRef.new(shape: DateType, location_name: "LastModifiedDate"))
|
1810
1825
|
UserPoolClientType.add_member(:creation_date, Shapes::ShapeRef.new(shape: DateType, location_name: "CreationDate"))
|
1811
1826
|
UserPoolClientType.add_member(:refresh_token_validity, Shapes::ShapeRef.new(shape: RefreshTokenValidityType, location_name: "RefreshTokenValidity"))
|
1827
|
+
UserPoolClientType.add_member(:access_token_validity, Shapes::ShapeRef.new(shape: AccessTokenValidityType, location_name: "AccessTokenValidity"))
|
1828
|
+
UserPoolClientType.add_member(:id_token_validity, Shapes::ShapeRef.new(shape: IdTokenValidityType, location_name: "IdTokenValidity"))
|
1829
|
+
UserPoolClientType.add_member(:token_validity_units, Shapes::ShapeRef.new(shape: TokenValidityUnitsType, location_name: "TokenValidityUnits"))
|
1812
1830
|
UserPoolClientType.add_member(:read_attributes, Shapes::ShapeRef.new(shape: ClientPermissionListType, location_name: "ReadAttributes"))
|
1813
1831
|
UserPoolClientType.add_member(:write_attributes, Shapes::ShapeRef.new(shape: ClientPermissionListType, location_name: "WriteAttributes"))
|
1814
1832
|
UserPoolClientType.add_member(:explicit_auth_flows, Shapes::ShapeRef.new(shape: ExplicitAuthFlowsListType, location_name: "ExplicitAuthFlows"))
|
@@ -2397,6 +2415,7 @@ module Aws::CognitoIdentityProvider
|
|
2397
2415
|
o.http_request_uri = "/"
|
2398
2416
|
o.input = Shapes::ShapeRef.new(shape: AssociateSoftwareTokenRequest)
|
2399
2417
|
o.output = Shapes::ShapeRef.new(shape: AssociateSoftwareTokenResponse)
|
2418
|
+
o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
|
2400
2419
|
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
2401
2420
|
o.errors << Shapes::ShapeRef.new(shape: NotAuthorizedException)
|
2402
2421
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
@@ -431,10 +431,11 @@ module Aws::CognitoIdentityProvider
|
|
431
431
|
# An array of name-value pairs that contain user attributes and
|
432
432
|
# attribute values to be set for the user to be created. You can
|
433
433
|
# create a user without specifying any attributes other than
|
434
|
-
# `Username`. However, any attributes that you specify as required
|
435
|
-
# or in the **Attributes** tab of the
|
436
|
-
# by you (in your call to
|
437
|
-
# or
|
434
|
+
# `Username`. However, any attributes that you specify as required
|
435
|
+
# (when creating a user pool or in the **Attributes** tab of the
|
436
|
+
# console) must be supplied either by you (in your call to
|
437
|
+
# `AdminCreateUser`) or by the user (when he or she signs up in
|
438
|
+
# response to your welcome message).
|
438
439
|
#
|
439
440
|
# For custom attributes, you must prepend the `custom:` prefix to the
|
440
441
|
# attribute name.
|
@@ -446,7 +447,8 @@ module Aws::CognitoIdentityProvider
|
|
446
447
|
#
|
447
448
|
# In your call to `AdminCreateUser`, you can set the `email_verified`
|
448
449
|
# attribute to `True`, and you can set the `phone_number_verified`
|
449
|
-
# attribute to `True`. (You can also do this by calling
|
450
|
+
# attribute to `True`. (You can also do this by calling
|
451
|
+
# [AdminUpdateUserAttributes][1].)
|
450
452
|
#
|
451
453
|
# * **email**\: The email address of the user to whom the message that
|
452
454
|
# contains the code and username will be sent. Required if the
|
@@ -457,6 +459,10 @@ module Aws::CognitoIdentityProvider
|
|
457
459
|
# message that contains the code and username will be sent. Required
|
458
460
|
# if the `phone_number_verified` attribute is set to `True`, or if
|
459
461
|
# `"SMS"` is specified in the `DesiredDeliveryMediums` parameter.
|
462
|
+
#
|
463
|
+
#
|
464
|
+
#
|
465
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html
|
460
466
|
# @return [Array<Types::AttributeType>]
|
461
467
|
#
|
462
468
|
# @!attribute [rw] validation_data
|
@@ -926,8 +932,8 @@ module Aws::CognitoIdentityProvider
|
|
926
932
|
# *This response parameter is no longer supported.* It provides
|
927
933
|
# information only about SMS MFA configurations. It doesn't provide
|
928
934
|
# information about TOTP software token MFA configurations. To look up
|
929
|
-
# information about either type of MFA configuration, use
|
930
|
-
#
|
935
|
+
# information about either type of MFA configuration, use
|
936
|
+
# UserMFASettingList instead.
|
931
937
|
# @return [Array<Types::MFAOptionType>]
|
932
938
|
#
|
933
939
|
# @!attribute [rw] preferred_mfa_setting
|
@@ -1042,18 +1048,20 @@ module Aws::CognitoIdentityProvider
|
|
1042
1048
|
#
|
1043
1049
|
# * For `USER_SRP_AUTH`\: `USERNAME` (required), `SRP_A` (required),
|
1044
1050
|
# `SECRET_HASH` (required if the app client is configured with a
|
1045
|
-
# client secret), `DEVICE_KEY
|
1051
|
+
# client secret), `DEVICE_KEY`.
|
1046
1052
|
#
|
1047
1053
|
# * For `REFRESH_TOKEN_AUTH/REFRESH_TOKEN`\: `REFRESH_TOKEN`
|
1048
1054
|
# (required), `SECRET_HASH` (required if the app client is
|
1049
|
-
# configured with a client secret), `DEVICE_KEY
|
1055
|
+
# configured with a client secret), `DEVICE_KEY`.
|
1050
1056
|
#
|
1051
1057
|
# * For `ADMIN_NO_SRP_AUTH`\: `USERNAME` (required), `SECRET_HASH` (if
|
1052
1058
|
# app client is configured with client secret), `PASSWORD`
|
1053
|
-
# (required), `DEVICE_KEY
|
1059
|
+
# (required), `DEVICE_KEY`.
|
1054
1060
|
#
|
1055
1061
|
# * For `CUSTOM_AUTH`\: `USERNAME` (required), `SECRET_HASH` (if app
|
1056
|
-
# client is configured with client secret), `DEVICE_KEY
|
1062
|
+
# client is configured with client secret), `DEVICE_KEY`. To start
|
1063
|
+
# the authentication flow with password verification, include
|
1064
|
+
# `ChallengeName: SRP_A` and `SRP_A: (The SRP_A Value)`.
|
1057
1065
|
# @return [Hash<String,String>]
|
1058
1066
|
#
|
1059
1067
|
# @!attribute [rw] client_metadata
|
@@ -1637,7 +1645,12 @@ module Aws::CognitoIdentityProvider
|
|
1637
1645
|
# @return [String]
|
1638
1646
|
#
|
1639
1647
|
# @!attribute [rw] challenge_name
|
1640
|
-
# The challenge name. For more information, see
|
1648
|
+
# The challenge name. For more information, see
|
1649
|
+
# [AdminInitiateAuth][1].
|
1650
|
+
#
|
1651
|
+
#
|
1652
|
+
#
|
1653
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html
|
1641
1654
|
# @return [String]
|
1642
1655
|
#
|
1643
1656
|
# @!attribute [rw] challenge_responses
|
@@ -1745,19 +1758,29 @@ module Aws::CognitoIdentityProvider
|
|
1745
1758
|
# Responds to the authentication challenge, as an administrator.
|
1746
1759
|
#
|
1747
1760
|
# @!attribute [rw] challenge_name
|
1748
|
-
# The name of the challenge. For more information, see
|
1761
|
+
# The name of the challenge. For more information, see
|
1762
|
+
# [AdminInitiateAuth][1].
|
1763
|
+
#
|
1764
|
+
#
|
1765
|
+
#
|
1766
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html
|
1749
1767
|
# @return [String]
|
1750
1768
|
#
|
1751
1769
|
# @!attribute [rw] session
|
1752
1770
|
# The session which should be passed both ways in challenge-response
|
1753
|
-
# calls to the service. If the
|
1754
|
-
#
|
1755
|
-
#
|
1756
|
-
#
|
1771
|
+
# calls to the service. If the caller needs to go through another
|
1772
|
+
# challenge, they return a session with other challenge parameters.
|
1773
|
+
# This session should be passed as it is to the next
|
1774
|
+
# `RespondToAuthChallenge` API call.
|
1757
1775
|
# @return [String]
|
1758
1776
|
#
|
1759
1777
|
# @!attribute [rw] challenge_parameters
|
1760
|
-
# The challenge parameters. For more information, see
|
1778
|
+
# The challenge parameters. For more information, see
|
1779
|
+
# [AdminInitiateAuth][1].
|
1780
|
+
#
|
1781
|
+
#
|
1782
|
+
#
|
1783
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html
|
1761
1784
|
# @return [Hash<String,String>]
|
1762
1785
|
#
|
1763
1786
|
# @!attribute [rw] authentication_result
|
@@ -2147,9 +2170,10 @@ module Aws::CognitoIdentityProvider
|
|
2147
2170
|
# The Amazon Pinpoint analytics configuration for collecting metrics for
|
2148
2171
|
# a user pool.
|
2149
2172
|
#
|
2150
|
-
# <note markdown="1">
|
2151
|
-
#
|
2152
|
-
#
|
2173
|
+
# <note markdown="1"> In regions where Pinpoint is not available, Cognito User Pools only
|
2174
|
+
# supports sending events to Amazon Pinpoint projects in us-east-1. In
|
2175
|
+
# regions where Pinpoint is available, Cognito User Pools will support
|
2176
|
+
# sending events to Amazon Pinpoint projects within that same region.
|
2153
2177
|
#
|
2154
2178
|
# </note>
|
2155
2179
|
#
|
@@ -2662,7 +2686,11 @@ module Aws::CognitoIdentityProvider
|
|
2662
2686
|
#
|
2663
2687
|
# @!attribute [rw] confirmation_code
|
2664
2688
|
# The confirmation code sent by a user's request to retrieve a
|
2665
|
-
# forgotten password. For more information, see
|
2689
|
+
# forgotten password. For more information, see [ForgotPassword][1].
|
2690
|
+
#
|
2691
|
+
#
|
2692
|
+
#
|
2693
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ForgotPassword.html
|
2666
2694
|
# @return [String]
|
2667
2695
|
#
|
2668
2696
|
# @!attribute [rw] password
|
@@ -3020,7 +3048,7 @@ module Aws::CognitoIdentityProvider
|
|
3020
3048
|
# The identity provider details. The following list describes the
|
3021
3049
|
# provider detail keys for each identity provider type.
|
3022
3050
|
#
|
3023
|
-
# * For Google
|
3051
|
+
# * For Google and Login with Amazon:
|
3024
3052
|
#
|
3025
3053
|
# * client\_id
|
3026
3054
|
#
|
@@ -3028,6 +3056,16 @@ module Aws::CognitoIdentityProvider
|
|
3028
3056
|
#
|
3029
3057
|
# * authorize\_scopes
|
3030
3058
|
#
|
3059
|
+
# * For Facebook:
|
3060
|
+
#
|
3061
|
+
# * client\_id
|
3062
|
+
#
|
3063
|
+
# * client\_secret
|
3064
|
+
#
|
3065
|
+
# * authorize\_scopes
|
3066
|
+
#
|
3067
|
+
# * api\_version
|
3068
|
+
#
|
3031
3069
|
# * For Sign in with Apple:
|
3032
3070
|
#
|
3033
3071
|
# * client\_id
|
@@ -3064,8 +3102,6 @@ module Aws::CognitoIdentityProvider
|
|
3064
3102
|
# * jwks\_uri *if not available from discovery URL specified by
|
3065
3103
|
# oidc\_issuer key*
|
3066
3104
|
#
|
3067
|
-
# * authorize\_scopes
|
3068
|
-
#
|
3069
3105
|
# * For SAML providers:
|
3070
3106
|
#
|
3071
3107
|
# * MetadataFile OR MetadataURL
|
@@ -3224,6 +3260,13 @@ module Aws::CognitoIdentityProvider
|
|
3224
3260
|
# client_name: "ClientNameType", # required
|
3225
3261
|
# generate_secret: false,
|
3226
3262
|
# refresh_token_validity: 1,
|
3263
|
+
# access_token_validity: 1,
|
3264
|
+
# id_token_validity: 1,
|
3265
|
+
# token_validity_units: {
|
3266
|
+
# access_token: "seconds", # accepts seconds, minutes, hours, days
|
3267
|
+
# id_token: "seconds", # accepts seconds, minutes, hours, days
|
3268
|
+
# refresh_token: "seconds", # accepts seconds, minutes, hours, days
|
3269
|
+
# },
|
3227
3270
|
# read_attributes: ["ClientPermissionType"],
|
3228
3271
|
# write_attributes: ["ClientPermissionType"],
|
3229
3272
|
# explicit_auth_flows: ["ADMIN_NO_SRP_AUTH"], # accepts ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH
|
@@ -3262,6 +3305,24 @@ module Aws::CognitoIdentityProvider
|
|
3262
3305
|
# valid and cannot be used.
|
3263
3306
|
# @return [Integer]
|
3264
3307
|
#
|
3308
|
+
# @!attribute [rw] access_token_validity
|
3309
|
+
# The time limit, between 5 minutes and 1 day, after which the access
|
3310
|
+
# token is no longer valid and cannot be used. This value will be
|
3311
|
+
# overridden if you have entered a value in TokenValidityUnits.
|
3312
|
+
# @return [Integer]
|
3313
|
+
#
|
3314
|
+
# @!attribute [rw] id_token_validity
|
3315
|
+
# The time limit, between 5 minutes and 1 day, after which the ID
|
3316
|
+
# token is no longer valid and cannot be used. This value will be
|
3317
|
+
# overridden if you have entered a value in TokenValidityUnits.
|
3318
|
+
# @return [Integer]
|
3319
|
+
#
|
3320
|
+
# @!attribute [rw] token_validity_units
|
3321
|
+
# The units in which the validity times are represented in. Default
|
3322
|
+
# for RefreshToken is days, and default for ID and access tokens are
|
3323
|
+
# hours.
|
3324
|
+
# @return [Types::TokenValidityUnitsType]
|
3325
|
+
#
|
3265
3326
|
# @!attribute [rw] read_attributes
|
3266
3327
|
# The read attributes.
|
3267
3328
|
# @return [Array<String>]
|
@@ -3398,9 +3459,10 @@ module Aws::CognitoIdentityProvider
|
|
3398
3459
|
# The Amazon Pinpoint analytics configuration for collecting metrics
|
3399
3460
|
# for this user pool.
|
3400
3461
|
#
|
3401
|
-
# <note markdown="1">
|
3402
|
-
#
|
3403
|
-
#
|
3462
|
+
# <note markdown="1"> In regions where Pinpoint is not available, Cognito User Pools only
|
3463
|
+
# supports sending events to Amazon Pinpoint projects in us-east-1. In
|
3464
|
+
# regions where Pinpoint is available, Cognito User Pools will support
|
3465
|
+
# sending events to Amazon Pinpoint projects within that same region.
|
3404
3466
|
#
|
3405
3467
|
# </note>
|
3406
3468
|
# @return [Types::AnalyticsConfigurationType]
|
@@ -3423,24 +3485,6 @@ module Aws::CognitoIdentityProvider
|
|
3423
3485
|
# * `LEGACY` - This represents the old behavior of Cognito where user
|
3424
3486
|
# existence related errors are not prevented.
|
3425
3487
|
#
|
3426
|
-
# This setting affects the behavior of following APIs:
|
3427
|
-
#
|
3428
|
-
# * AdminInitiateAuth
|
3429
|
-
#
|
3430
|
-
# * AdminRespondToAuthChallenge
|
3431
|
-
#
|
3432
|
-
# * InitiateAuth
|
3433
|
-
#
|
3434
|
-
# * RespondToAuthChallenge
|
3435
|
-
#
|
3436
|
-
# * ForgotPassword
|
3437
|
-
#
|
3438
|
-
# * ConfirmForgotPassword
|
3439
|
-
#
|
3440
|
-
# * ConfirmSignUp
|
3441
|
-
#
|
3442
|
-
# * ResendConfirmationCode
|
3443
|
-
#
|
3444
3488
|
# <note markdown="1"> After February 15th 2020, the value of `PreventUserExistenceErrors`
|
3445
3489
|
# will default to `ENABLED` for newly created user pool clients if no
|
3446
3490
|
# value is provided.
|
@@ -3455,6 +3499,9 @@ module Aws::CognitoIdentityProvider
|
|
3455
3499
|
:client_name,
|
3456
3500
|
:generate_secret,
|
3457
3501
|
:refresh_token_validity,
|
3502
|
+
:access_token_validity,
|
3503
|
+
:id_token_validity,
|
3504
|
+
:token_validity_units,
|
3458
3505
|
:read_attributes,
|
3459
3506
|
:write_attributes,
|
3460
3507
|
:explicit_auth_flows,
|
@@ -3756,7 +3803,11 @@ module Aws::CognitoIdentityProvider
|
|
3756
3803
|
# selected sign-in option. For example, when this is set to `False`,
|
3757
3804
|
# users will be able to sign in using either "username" or
|
3758
3805
|
# "Username". This configuration is immutable once it has been set.
|
3759
|
-
# For more information, see .
|
3806
|
+
# For more information, see [UsernameConfigurationType][1].
|
3807
|
+
#
|
3808
|
+
#
|
3809
|
+
#
|
3810
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html
|
3760
3811
|
# @return [Types::UsernameConfigurationType]
|
3761
3812
|
#
|
3762
3813
|
# @!attribute [rw] account_recovery_setting
|
@@ -3768,13 +3819,6 @@ module Aws::CognitoIdentityProvider
|
|
3768
3819
|
# enabled. In the absence of this setting, Cognito uses the legacy
|
3769
3820
|
# behavior to determine the recovery method where SMS is preferred
|
3770
3821
|
# over email.
|
3771
|
-
#
|
3772
|
-
# <note markdown="1"> Starting February 1, 2020, the value of `AccountRecoverySetting`
|
3773
|
-
# will default to `verified_email` first and `verified_phone_number`
|
3774
|
-
# as the second option for newly created user pools if no value is
|
3775
|
-
# provided.
|
3776
|
-
#
|
3777
|
-
# </note>
|
3778
3822
|
# @return [Types::AccountRecoverySettingType]
|
3779
3823
|
#
|
3780
3824
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolRequest AWS API Documentation
|
@@ -5255,8 +5299,8 @@ module Aws::CognitoIdentityProvider
|
|
5255
5299
|
# *This response parameter is no longer supported.* It provides
|
5256
5300
|
# information only about SMS MFA configurations. It doesn't provide
|
5257
5301
|
# information about TOTP software token MFA configurations. To look up
|
5258
|
-
# information about either type of MFA configuration, use
|
5259
|
-
#
|
5302
|
+
# information about either type of MFA configuration, use
|
5303
|
+
# UserMFASettingList instead.
|
5260
5304
|
# @return [Array<Types::MFAOptionType>]
|
5261
5305
|
#
|
5262
5306
|
# @!attribute [rw] preferred_mfa_setting
|
@@ -5426,7 +5470,7 @@ module Aws::CognitoIdentityProvider
|
|
5426
5470
|
# The identity provider details. The following list describes the
|
5427
5471
|
# provider detail keys for each identity provider type.
|
5428
5472
|
#
|
5429
|
-
# * For Google
|
5473
|
+
# * For Google and Login with Amazon:
|
5430
5474
|
#
|
5431
5475
|
# * client\_id
|
5432
5476
|
#
|
@@ -5434,6 +5478,16 @@ module Aws::CognitoIdentityProvider
|
|
5434
5478
|
#
|
5435
5479
|
# * authorize\_scopes
|
5436
5480
|
#
|
5481
|
+
# * For Facebook:
|
5482
|
+
#
|
5483
|
+
# * client\_id
|
5484
|
+
#
|
5485
|
+
# * client\_secret
|
5486
|
+
#
|
5487
|
+
# * authorize\_scopes
|
5488
|
+
#
|
5489
|
+
# * api\_version
|
5490
|
+
#
|
5437
5491
|
# * For Sign in with Apple:
|
5438
5492
|
#
|
5439
5493
|
# * client\_id
|
@@ -5578,14 +5632,16 @@ module Aws::CognitoIdentityProvider
|
|
5578
5632
|
#
|
5579
5633
|
# * For `USER_SRP_AUTH`\: `USERNAME` (required), `SRP_A` (required),
|
5580
5634
|
# `SECRET_HASH` (required if the app client is configured with a
|
5581
|
-
# client secret), `DEVICE_KEY
|
5635
|
+
# client secret), `DEVICE_KEY`.
|
5582
5636
|
#
|
5583
5637
|
# * For `REFRESH_TOKEN_AUTH/REFRESH_TOKEN`\: `REFRESH_TOKEN`
|
5584
5638
|
# (required), `SECRET_HASH` (required if the app client is
|
5585
|
-
# configured with a client secret), `DEVICE_KEY
|
5639
|
+
# configured with a client secret), `DEVICE_KEY`.
|
5586
5640
|
#
|
5587
5641
|
# * For `CUSTOM_AUTH`\: `USERNAME` (required), `SECRET_HASH` (if app
|
5588
|
-
# client is configured with client secret), `DEVICE_KEY
|
5642
|
+
# client is configured with client secret), `DEVICE_KEY`. To start
|
5643
|
+
# the authentication flow with password verification, include
|
5644
|
+
# `ChallengeName: SRP_A` and `SRP_A: (The SRP_A Value)`.
|
5589
5645
|
# @return [Hash<String,String>]
|
5590
5646
|
#
|
5591
5647
|
# @!attribute [rw] client_metadata
|
@@ -5717,10 +5773,10 @@ module Aws::CognitoIdentityProvider
|
|
5717
5773
|
#
|
5718
5774
|
# @!attribute [rw] session
|
5719
5775
|
# The session which should be passed both ways in challenge-response
|
5720
|
-
# calls to the service. If the
|
5721
|
-
#
|
5722
|
-
#
|
5723
|
-
#
|
5776
|
+
# calls to the service. If the caller needs to go through another
|
5777
|
+
# challenge, they return a session with other challenge parameters.
|
5778
|
+
# This session should be passed as it is to the next
|
5779
|
+
# `RespondToAuthChallenge` API call.
|
5724
5780
|
# @return [String]
|
5725
5781
|
#
|
5726
5782
|
# @!attribute [rw] challenge_parameters
|
@@ -6581,13 +6637,6 @@ module Aws::CognitoIdentityProvider
|
|
6581
6637
|
# MFA configurations. You can't use it for TOTP software token MFA
|
6582
6638
|
# configurations.
|
6583
6639
|
#
|
6584
|
-
# To set either type of MFA configuration, use the
|
6585
|
-
# AdminSetUserMFAPreference or SetUserMFAPreference actions.
|
6586
|
-
#
|
6587
|
-
# To look up information about either type of MFA configuration, use the
|
6588
|
-
# AdminGetUserResponse$UserMFASettingList or
|
6589
|
-
# GetUserResponse$UserMFASettingList responses.
|
6590
|
-
#
|
6591
6640
|
# @note When making an API call, you may pass MFAOptionType
|
6592
6641
|
# data as a hash:
|
6593
6642
|
#
|
@@ -7214,9 +7263,13 @@ module Aws::CognitoIdentityProvider
|
|
7214
7263
|
# @return [String]
|
7215
7264
|
#
|
7216
7265
|
# @!attribute [rw] challenge_name
|
7217
|
-
# The challenge name. For more information, see .
|
7266
|
+
# The challenge name. For more information, see [InitiateAuth][1].
|
7218
7267
|
#
|
7219
7268
|
# `ADMIN_NO_SRP_AUTH` is not a valid value.
|
7269
|
+
#
|
7270
|
+
#
|
7271
|
+
#
|
7272
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html
|
7220
7273
|
# @return [String]
|
7221
7274
|
#
|
7222
7275
|
# @!attribute [rw] session
|
@@ -7324,19 +7377,28 @@ module Aws::CognitoIdentityProvider
|
|
7324
7377
|
# The response to respond to the authentication challenge.
|
7325
7378
|
#
|
7326
7379
|
# @!attribute [rw] challenge_name
|
7327
|
-
# The challenge name. For more information, see .
|
7380
|
+
# The challenge name. For more information, see [InitiateAuth][1].
|
7381
|
+
#
|
7382
|
+
#
|
7383
|
+
#
|
7384
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html
|
7328
7385
|
# @return [String]
|
7329
7386
|
#
|
7330
7387
|
# @!attribute [rw] session
|
7331
7388
|
# The session which should be passed both ways in challenge-response
|
7332
|
-
# calls to the service. If the
|
7333
|
-
#
|
7334
|
-
#
|
7335
|
-
#
|
7389
|
+
# calls to the service. If the caller needs to go through another
|
7390
|
+
# challenge, they return a session with other challenge parameters.
|
7391
|
+
# This session should be passed as it is to the next
|
7392
|
+
# `RespondToAuthChallenge` API call.
|
7336
7393
|
# @return [String]
|
7337
7394
|
#
|
7338
7395
|
# @!attribute [rw] challenge_parameters
|
7339
|
-
# The challenge parameters. For more information, see
|
7396
|
+
# The challenge parameters. For more information, see
|
7397
|
+
# [InitiateAuth][1].
|
7398
|
+
#
|
7399
|
+
#
|
7400
|
+
#
|
7401
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html
|
7340
7402
|
# @return [Hash<String,String>]
|
7341
7403
|
#
|
7342
7404
|
# @!attribute [rw] authentication_result
|
@@ -7493,8 +7555,9 @@ module Aws::CognitoIdentityProvider
|
|
7493
7555
|
# Specifies whether the attribute type is developer only. This
|
7494
7556
|
# attribute can only be modified by an administrator. Users will not
|
7495
7557
|
# be able to modify this attribute using their access token. For
|
7496
|
-
# example, `DeveloperOnlyAttribute` can be modified using
|
7497
|
-
# cannot be updated using
|
7558
|
+
# example, `DeveloperOnlyAttribute` can be modified using
|
7559
|
+
# AdminUpdateUserAttributes but cannot be updated using
|
7560
|
+
# UpdateUserAttributes.
|
7498
7561
|
#
|
7499
7562
|
#
|
7500
7563
|
#
|
@@ -8311,6 +8374,43 @@ module Aws::CognitoIdentityProvider
|
|
8311
8374
|
#
|
8312
8375
|
class TagResourceResponse < Aws::EmptyStructure; end
|
8313
8376
|
|
8377
|
+
# The data type for TokenValidityUnits that specifics the time
|
8378
|
+
# measurements for token validity.
|
8379
|
+
#
|
8380
|
+
# @note When making an API call, you may pass TokenValidityUnitsType
|
8381
|
+
# data as a hash:
|
8382
|
+
#
|
8383
|
+
# {
|
8384
|
+
# access_token: "seconds", # accepts seconds, minutes, hours, days
|
8385
|
+
# id_token: "seconds", # accepts seconds, minutes, hours, days
|
8386
|
+
# refresh_token: "seconds", # accepts seconds, minutes, hours, days
|
8387
|
+
# }
|
8388
|
+
#
|
8389
|
+
# @!attribute [rw] access_token
|
8390
|
+
# A time unit in “seconds”, “minutes”, “hours” or “days” for the value
|
8391
|
+
# in AccessTokenValidity, defaults to hours.
|
8392
|
+
# @return [String]
|
8393
|
+
#
|
8394
|
+
# @!attribute [rw] id_token
|
8395
|
+
# A time unit in “seconds”, “minutes”, “hours” or “days” for the value
|
8396
|
+
# in IdTokenValidity, defaults to hours.
|
8397
|
+
# @return [String]
|
8398
|
+
#
|
8399
|
+
# @!attribute [rw] refresh_token
|
8400
|
+
# A time unit in “seconds”, “minutes”, “hours” or “days” for the value
|
8401
|
+
# in RefreshTokenValidity, defaults to days.
|
8402
|
+
# @return [String]
|
8403
|
+
#
|
8404
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/TokenValidityUnitsType AWS API Documentation
|
8405
|
+
#
|
8406
|
+
class TokenValidityUnitsType < Struct.new(
|
8407
|
+
:access_token,
|
8408
|
+
:id_token,
|
8409
|
+
:refresh_token)
|
8410
|
+
SENSITIVE = []
|
8411
|
+
include Aws::Structure
|
8412
|
+
end
|
8413
|
+
|
8314
8414
|
# This exception is thrown when the user has made too many failed
|
8315
8415
|
# attempts for a given action (e.g., sign in).
|
8316
8416
|
#
|
@@ -8578,7 +8678,11 @@ module Aws::CognitoIdentityProvider
|
|
8578
8678
|
#
|
8579
8679
|
# @!attribute [rw] precedence
|
8580
8680
|
# The new precedence value for the group. For more information about
|
8581
|
-
# this parameter, see .
|
8681
|
+
# this parameter, see [CreateGroup][1].
|
8682
|
+
#
|
8683
|
+
#
|
8684
|
+
#
|
8685
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateGroup.html
|
8582
8686
|
# @return [Integer]
|
8583
8687
|
#
|
8584
8688
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateGroupRequest AWS API Documentation
|
@@ -8823,6 +8927,13 @@ module Aws::CognitoIdentityProvider
|
|
8823
8927
|
# client_id: "ClientIdType", # required
|
8824
8928
|
# client_name: "ClientNameType",
|
8825
8929
|
# refresh_token_validity: 1,
|
8930
|
+
# access_token_validity: 1,
|
8931
|
+
# id_token_validity: 1,
|
8932
|
+
# token_validity_units: {
|
8933
|
+
# access_token: "seconds", # accepts seconds, minutes, hours, days
|
8934
|
+
# id_token: "seconds", # accepts seconds, minutes, hours, days
|
8935
|
+
# refresh_token: "seconds", # accepts seconds, minutes, hours, days
|
8936
|
+
# },
|
8826
8937
|
# read_attributes: ["ClientPermissionType"],
|
8827
8938
|
# write_attributes: ["ClientPermissionType"],
|
8828
8939
|
# explicit_auth_flows: ["ADMIN_NO_SRP_AUTH"], # accepts ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH
|
@@ -8860,6 +8971,22 @@ module Aws::CognitoIdentityProvider
|
|
8860
8971
|
# valid and cannot be used.
|
8861
8972
|
# @return [Integer]
|
8862
8973
|
#
|
8974
|
+
# @!attribute [rw] access_token_validity
|
8975
|
+
# The time limit, after which the access token is no longer valid and
|
8976
|
+
# cannot be used.
|
8977
|
+
# @return [Integer]
|
8978
|
+
#
|
8979
|
+
# @!attribute [rw] id_token_validity
|
8980
|
+
# The time limit, after which the ID token is no longer valid and
|
8981
|
+
# cannot be used.
|
8982
|
+
# @return [Integer]
|
8983
|
+
#
|
8984
|
+
# @!attribute [rw] token_validity_units
|
8985
|
+
# The units in which the validity times are represented in. Default
|
8986
|
+
# for RefreshToken is days, and default for ID and access tokens are
|
8987
|
+
# hours.
|
8988
|
+
# @return [Types::TokenValidityUnitsType]
|
8989
|
+
#
|
8863
8990
|
# @!attribute [rw] read_attributes
|
8864
8991
|
# The read-only attributes of the user pool.
|
8865
8992
|
# @return [Array<String>]
|
@@ -8982,9 +9109,10 @@ module Aws::CognitoIdentityProvider
|
|
8982
9109
|
# The Amazon Pinpoint analytics configuration for collecting metrics
|
8983
9110
|
# for this user pool.
|
8984
9111
|
#
|
8985
|
-
# <note markdown="1">
|
8986
|
-
#
|
8987
|
-
#
|
9112
|
+
# <note markdown="1"> In regions where Pinpoint is not available, Cognito User Pools only
|
9113
|
+
# supports sending events to Amazon Pinpoint projects in us-east-1. In
|
9114
|
+
# regions where Pinpoint is available, Cognito User Pools will support
|
9115
|
+
# sending events to Amazon Pinpoint projects within that same region.
|
8988
9116
|
#
|
8989
9117
|
# </note>
|
8990
9118
|
# @return [Types::AnalyticsConfigurationType]
|
@@ -9007,24 +9135,6 @@ module Aws::CognitoIdentityProvider
|
|
9007
9135
|
# * `LEGACY` - This represents the old behavior of Cognito where user
|
9008
9136
|
# existence related errors are not prevented.
|
9009
9137
|
#
|
9010
|
-
# This setting affects the behavior of following APIs:
|
9011
|
-
#
|
9012
|
-
# * AdminInitiateAuth
|
9013
|
-
#
|
9014
|
-
# * AdminRespondToAuthChallenge
|
9015
|
-
#
|
9016
|
-
# * InitiateAuth
|
9017
|
-
#
|
9018
|
-
# * RespondToAuthChallenge
|
9019
|
-
#
|
9020
|
-
# * ForgotPassword
|
9021
|
-
#
|
9022
|
-
# * ConfirmForgotPassword
|
9023
|
-
#
|
9024
|
-
# * ConfirmSignUp
|
9025
|
-
#
|
9026
|
-
# * ResendConfirmationCode
|
9027
|
-
#
|
9028
9138
|
# <note markdown="1"> After February 15th 2020, the value of `PreventUserExistenceErrors`
|
9029
9139
|
# will default to `ENABLED` for newly created user pool clients if no
|
9030
9140
|
# value is provided.
|
@@ -9039,6 +9149,9 @@ module Aws::CognitoIdentityProvider
|
|
9039
9149
|
:client_id,
|
9040
9150
|
:client_name,
|
9041
9151
|
:refresh_token_validity,
|
9152
|
+
:access_token_validity,
|
9153
|
+
:id_token_validity,
|
9154
|
+
:token_validity_units,
|
9042
9155
|
:read_attributes,
|
9043
9156
|
:write_attributes,
|
9044
9157
|
:explicit_auth_flows,
|
@@ -9604,6 +9717,23 @@ module Aws::CognitoIdentityProvider
|
|
9604
9717
|
# valid and cannot be used.
|
9605
9718
|
# @return [Integer]
|
9606
9719
|
#
|
9720
|
+
# @!attribute [rw] access_token_validity
|
9721
|
+
# The time limit, specified by tokenValidityUnits, defaulting to
|
9722
|
+
# hours, after which the access token is no longer valid and cannot be
|
9723
|
+
# used.
|
9724
|
+
# @return [Integer]
|
9725
|
+
#
|
9726
|
+
# @!attribute [rw] id_token_validity
|
9727
|
+
# The time limit, specified by tokenValidityUnits, defaulting to
|
9728
|
+
# hours, after which the refresh token is no longer valid and cannot
|
9729
|
+
# be used.
|
9730
|
+
# @return [Integer]
|
9731
|
+
#
|
9732
|
+
# @!attribute [rw] token_validity_units
|
9733
|
+
# The time units used to specify the token validity times of their
|
9734
|
+
# respective token.
|
9735
|
+
# @return [Types::TokenValidityUnitsType]
|
9736
|
+
#
|
9607
9737
|
# @!attribute [rw] read_attributes
|
9608
9738
|
# The Read-only attributes.
|
9609
9739
|
# @return [Array<String>]
|
@@ -9751,24 +9881,6 @@ module Aws::CognitoIdentityProvider
|
|
9751
9881
|
# * `LEGACY` - This represents the old behavior of Cognito where user
|
9752
9882
|
# existence related errors are not prevented.
|
9753
9883
|
#
|
9754
|
-
# This setting affects the behavior of following APIs:
|
9755
|
-
#
|
9756
|
-
# * AdminInitiateAuth
|
9757
|
-
#
|
9758
|
-
# * AdminRespondToAuthChallenge
|
9759
|
-
#
|
9760
|
-
# * InitiateAuth
|
9761
|
-
#
|
9762
|
-
# * RespondToAuthChallenge
|
9763
|
-
#
|
9764
|
-
# * ForgotPassword
|
9765
|
-
#
|
9766
|
-
# * ConfirmForgotPassword
|
9767
|
-
#
|
9768
|
-
# * ConfirmSignUp
|
9769
|
-
#
|
9770
|
-
# * ResendConfirmationCode
|
9771
|
-
#
|
9772
9884
|
# <note markdown="1"> After February 15th 2020, the value of `PreventUserExistenceErrors`
|
9773
9885
|
# will default to `ENABLED` for newly created user pool clients if no
|
9774
9886
|
# value is provided.
|
@@ -9786,6 +9898,9 @@ module Aws::CognitoIdentityProvider
|
|
9786
9898
|
:last_modified_date,
|
9787
9899
|
:creation_date,
|
9788
9900
|
:refresh_token_validity,
|
9901
|
+
:access_token_validity,
|
9902
|
+
:id_token_validity,
|
9903
|
+
:token_validity_units,
|
9789
9904
|
:read_attributes,
|
9790
9905
|
:write_attributes,
|
9791
9906
|
:explicit_auth_flows,
|
@@ -10028,7 +10143,11 @@ module Aws::CognitoIdentityProvider
|
|
10028
10143
|
# the selected sign-in option. For example, when this is set to
|
10029
10144
|
# `False`, users will be able to sign in using either "username" or
|
10030
10145
|
# "Username". This configuration is immutable once it has been set.
|
10031
|
-
# For more information, see .
|
10146
|
+
# For more information, see [UsernameConfigurationType][1].
|
10147
|
+
#
|
10148
|
+
#
|
10149
|
+
#
|
10150
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html
|
10032
10151
|
# @return [Types::UsernameConfigurationType]
|
10033
10152
|
#
|
10034
10153
|
# @!attribute [rw] arn
|
@@ -10272,6 +10391,11 @@ module Aws::CognitoIdentityProvider
|
|
10272
10391
|
#
|
10273
10392
|
# @!attribute [rw] user_code
|
10274
10393
|
# The one time password computed using the secret code returned by
|
10394
|
+
# [AssociateSoftwareToken"][1].
|
10395
|
+
#
|
10396
|
+
#
|
10397
|
+
#
|
10398
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AssociateSoftwareToken.html
|
10275
10399
|
# @return [String]
|
10276
10400
|
#
|
10277
10401
|
# @!attribute [rw] friendly_device_name
|