@aws-sdk/client-cognito-identity-provider 3.473.0 → 3.476.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -12
- package/dist-cjs/commands/SetRiskConfigurationCommand.js +1 -2
- package/dist-cjs/models/models_0.js +7 -8
- package/dist-cjs/models/models_1.js +6 -1
- package/dist-es/commands/SetRiskConfigurationCommand.js +1 -2
- package/dist-es/models/models_0.js +4 -4
- package/dist-es/models/models_1.js +4 -0
- package/dist-types/CognitoIdentityProvider.d.ts +28 -12
- package/dist-types/CognitoIdentityProviderClient.d.ts +28 -12
- package/dist-types/commands/AdminAddUserToGroupCommand.d.ts +3 -1
- package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +9 -2
- package/dist-types/commands/AdminListGroupsForUserCommand.d.ts +1 -1
- package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +7 -1
- package/dist-types/commands/AdminUserGlobalSignOutCommand.d.ts +24 -8
- package/dist-types/commands/ConfirmSignUpCommand.d.ts +12 -1
- package/dist-types/commands/CreateUserPoolCommand.d.ts +8 -0
- package/dist-types/commands/DescribeUserPoolCommand.d.ts +4 -0
- package/dist-types/commands/GlobalSignOutCommand.d.ts +24 -8
- package/dist-types/commands/ListUserPoolsCommand.d.ts +4 -0
- package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +7 -1
- package/dist-types/commands/SetLogDeliveryConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/SetRiskConfigurationCommand.d.ts +1 -2
- package/dist-types/commands/UpdateUserAttributesCommand.d.ts +5 -1
- package/dist-types/commands/UpdateUserPoolCommand.d.ts +4 -0
- package/dist-types/index.d.ts +28 -12
- package/dist-types/models/models_0.d.ts +421 -230
- package/dist-types/models/models_1.d.ts +96 -6
- package/dist-types/ts3.4/commands/SetLogDeliveryConfigurationCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/SetRiskConfigurationCommand.d.ts +4 -2
- package/dist-types/ts3.4/models/models_0.d.ts +11 -13
- package/dist-types/ts3.4/models/models_1.d.ts +17 -0
- package/package.json +4 -4
|
@@ -251,13 +251,23 @@ export interface StringAttributeConstraintsType {
|
|
|
251
251
|
export interface SchemaAttributeType {
|
|
252
252
|
/**
|
|
253
253
|
* @public
|
|
254
|
-
* <p>The name of your user pool attribute
|
|
255
|
-
*
|
|
254
|
+
* <p>The name of your user pool attribute. When you create or update a user pool, adding a
|
|
255
|
+
* schema attribute creates a custom or developer-only attribute. When you add an attribute
|
|
256
|
+
* with a <code>Name</code> value of <code>MyAttribute</code>, Amazon Cognito creates the custom
|
|
257
|
+
* attribute <code>custom:MyAttribute</code>. When <code>DeveloperOnlyAttribute</code> is
|
|
258
|
+
* <code>true</code>, Amazon Cognito creates your attribute as <code>dev:MyAttribute</code>. In
|
|
259
|
+
* an operation that describes a user pool, Amazon Cognito returns this value as <code>value</code>
|
|
260
|
+
* for standard attributes, <code>custom:value</code> for custom attributes, and
|
|
261
|
+
* <code>dev:value</code> for developer-only attributes..</p>
|
|
256
262
|
*/
|
|
257
263
|
Name?: string;
|
|
258
264
|
/**
|
|
259
265
|
* @public
|
|
260
|
-
* <p>The data format of the values for your attribute
|
|
266
|
+
* <p>The data format of the values for your attribute. When you choose an
|
|
267
|
+
* <code>AttributeDataType</code>, Amazon Cognito validates the input against the data type. A
|
|
268
|
+
* custom attribute value in your user's ID token is always a string, for example
|
|
269
|
+
* <code>"custom:isMember" : "true"</code> or <code>"custom:YearsAsMember" :
|
|
270
|
+
* "12"</code>. </p>
|
|
261
271
|
*/
|
|
262
272
|
AttributeDataType?: AttributeDataType;
|
|
263
273
|
/**
|
|
@@ -410,12 +420,14 @@ export interface AdminAddUserToGroupRequest {
|
|
|
410
420
|
UserPoolId: string | undefined;
|
|
411
421
|
/**
|
|
412
422
|
* @public
|
|
413
|
-
* <p>The username
|
|
423
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
424
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
425
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
414
426
|
*/
|
|
415
427
|
Username: string | undefined;
|
|
416
428
|
/**
|
|
417
429
|
* @public
|
|
418
|
-
* <p>The group
|
|
430
|
+
* <p>The name of the group that you want to add your user to.</p>
|
|
419
431
|
*/
|
|
420
432
|
GroupName: string | undefined;
|
|
421
433
|
}
|
|
@@ -443,7 +455,9 @@ export interface AdminConfirmSignUpRequest {
|
|
|
443
455
|
UserPoolId: string | undefined;
|
|
444
456
|
/**
|
|
445
457
|
* @public
|
|
446
|
-
* <p>The
|
|
458
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
459
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
460
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
447
461
|
*/
|
|
448
462
|
Username: string | undefined;
|
|
449
463
|
/**
|
|
@@ -664,14 +678,15 @@ export interface AdminCreateUserRequest {
|
|
|
664
678
|
UserAttributes?: AttributeType[];
|
|
665
679
|
/**
|
|
666
680
|
* @public
|
|
667
|
-
* <p>
|
|
668
|
-
*
|
|
669
|
-
*
|
|
670
|
-
*
|
|
671
|
-
*
|
|
672
|
-
*
|
|
673
|
-
*
|
|
674
|
-
*
|
|
681
|
+
* <p>Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda
|
|
682
|
+
* trigger. This set of key-value pairs are for custom validation of information that you
|
|
683
|
+
* collect from your users but don't need to retain.</p>
|
|
684
|
+
* <p>Your Lambda function can analyze this additional data and act on it. Your function
|
|
685
|
+
* might perform external API operations like logging user attributes and validation data
|
|
686
|
+
* to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns
|
|
687
|
+
* to Amazon Cognito, like automatically confirming the user if they sign up from within your
|
|
688
|
+
* network.</p>
|
|
689
|
+
* <p>For more information about the pre sign-up Lambda trigger, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html">Pre sign-up Lambda trigger</a>.</p>
|
|
675
690
|
*/
|
|
676
691
|
ValidationData?: AttributeType[];
|
|
677
692
|
/**
|
|
@@ -994,7 +1009,8 @@ export interface AdminCreateUserConfigType {
|
|
|
994
1009
|
* <p>The user account expiration limit, in days, after which a new account that hasn't
|
|
995
1010
|
* signed in is no longer usable. To reset the account after that time limit, you must call
|
|
996
1011
|
* <code>AdminCreateUser</code> again, specifying <code>"RESEND"</code> for the
|
|
997
|
-
* <code>MessageAction</code> parameter. The default value for this parameter is
|
|
1012
|
+
* <code>MessageAction</code> parameter. The default value for this parameter is
|
|
1013
|
+
* 7.</p>
|
|
998
1014
|
* <note>
|
|
999
1015
|
* <p>If you set a value for <code>TemporaryPasswordValidityDays</code> in
|
|
1000
1016
|
* <code>PasswordPolicy</code>, that value will be used, and
|
|
@@ -1022,7 +1038,9 @@ export interface AdminDeleteUserRequest {
|
|
|
1022
1038
|
UserPoolId: string | undefined;
|
|
1023
1039
|
/**
|
|
1024
1040
|
* @public
|
|
1025
|
-
* <p>The
|
|
1041
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
1042
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
1043
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
1026
1044
|
*/
|
|
1027
1045
|
Username: string | undefined;
|
|
1028
1046
|
}
|
|
@@ -1038,7 +1056,9 @@ export interface AdminDeleteUserAttributesRequest {
|
|
|
1038
1056
|
UserPoolId: string | undefined;
|
|
1039
1057
|
/**
|
|
1040
1058
|
* @public
|
|
1041
|
-
* <p>The
|
|
1059
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
1060
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
1061
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
1042
1062
|
*/
|
|
1043
1063
|
Username: string | undefined;
|
|
1044
1064
|
/**
|
|
@@ -1126,7 +1146,9 @@ export interface AdminDisableUserRequest {
|
|
|
1126
1146
|
UserPoolId: string | undefined;
|
|
1127
1147
|
/**
|
|
1128
1148
|
* @public
|
|
1129
|
-
* <p>The
|
|
1149
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
1150
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
1151
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
1130
1152
|
*/
|
|
1131
1153
|
Username: string | undefined;
|
|
1132
1154
|
}
|
|
@@ -1149,7 +1171,9 @@ export interface AdminEnableUserRequest {
|
|
|
1149
1171
|
UserPoolId: string | undefined;
|
|
1150
1172
|
/**
|
|
1151
1173
|
* @public
|
|
1152
|
-
* <p>The
|
|
1174
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
1175
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
1176
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
1153
1177
|
*/
|
|
1154
1178
|
Username: string | undefined;
|
|
1155
1179
|
}
|
|
@@ -1172,7 +1196,9 @@ export interface AdminForgetDeviceRequest {
|
|
|
1172
1196
|
UserPoolId: string | undefined;
|
|
1173
1197
|
/**
|
|
1174
1198
|
* @public
|
|
1175
|
-
* <p>The user
|
|
1199
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
1200
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
1201
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
1176
1202
|
*/
|
|
1177
1203
|
Username: string | undefined;
|
|
1178
1204
|
/**
|
|
@@ -1210,7 +1236,9 @@ export interface AdminGetDeviceRequest {
|
|
|
1210
1236
|
UserPoolId: string | undefined;
|
|
1211
1237
|
/**
|
|
1212
1238
|
* @public
|
|
1213
|
-
* <p>The user
|
|
1239
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
1240
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
1241
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
1214
1242
|
*/
|
|
1215
1243
|
Username: string | undefined;
|
|
1216
1244
|
}
|
|
@@ -1269,7 +1297,9 @@ export interface AdminGetUserRequest {
|
|
|
1269
1297
|
UserPoolId: string | undefined;
|
|
1270
1298
|
/**
|
|
1271
1299
|
* @public
|
|
1272
|
-
* <p>The
|
|
1300
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
1301
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
1302
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
1273
1303
|
*/
|
|
1274
1304
|
Username: string | undefined;
|
|
1275
1305
|
}
|
|
@@ -1577,9 +1607,6 @@ export interface AdminInitiateAuthRequest {
|
|
|
1577
1607
|
* <li>
|
|
1578
1608
|
* <p>Define auth challenge</p>
|
|
1579
1609
|
* </li>
|
|
1580
|
-
* <li>
|
|
1581
|
-
* <p>Verify auth challenge</p>
|
|
1582
|
-
* </li>
|
|
1583
1610
|
* </ul>
|
|
1584
1611
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">
|
|
1585
1612
|
* Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
@@ -1768,7 +1795,7 @@ export interface AdminInitiateAuthResponse {
|
|
|
1768
1795
|
* <p>
|
|
1769
1796
|
* <code>MFA_SETUP</code>: For users who are required to set up an MFA factor
|
|
1770
1797
|
* before they can sign in. The MFA types activated for the user pool will be
|
|
1771
|
-
* listed in the challenge parameters <code>
|
|
1798
|
+
* listed in the challenge parameters <code>MFAS_CAN_SETUP</code> value. </p>
|
|
1772
1799
|
* <p> To set up software token MFA, use the session returned here from
|
|
1773
1800
|
* <code>InitiateAuth</code> as an input to
|
|
1774
1801
|
* <code>AssociateSoftwareToken</code>, and use the session returned by
|
|
@@ -1929,7 +1956,9 @@ export interface AdminListDevicesRequest {
|
|
|
1929
1956
|
UserPoolId: string | undefined;
|
|
1930
1957
|
/**
|
|
1931
1958
|
* @public
|
|
1932
|
-
* <p>The user
|
|
1959
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
1960
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
1961
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
1933
1962
|
*/
|
|
1934
1963
|
Username: string | undefined;
|
|
1935
1964
|
/**
|
|
@@ -1939,7 +1968,11 @@ export interface AdminListDevicesRequest {
|
|
|
1939
1968
|
Limit?: number;
|
|
1940
1969
|
/**
|
|
1941
1970
|
* @public
|
|
1942
|
-
* <p>The pagination token
|
|
1971
|
+
* <p>This API operation returns a limited number of results. The pagination token is
|
|
1972
|
+
* an identifier that you can present in an additional API request with the same parameters. When
|
|
1973
|
+
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
1974
|
+
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
1975
|
+
* through the full list of items.</p>
|
|
1943
1976
|
*/
|
|
1944
1977
|
PaginationToken?: string;
|
|
1945
1978
|
}
|
|
@@ -1955,7 +1988,9 @@ export interface AdminListDevicesResponse {
|
|
|
1955
1988
|
Devices?: DeviceType[];
|
|
1956
1989
|
/**
|
|
1957
1990
|
* @public
|
|
1958
|
-
* <p>The
|
|
1991
|
+
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
1992
|
+
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
1993
|
+
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
1959
1994
|
*/
|
|
1960
1995
|
PaginationToken?: string;
|
|
1961
1996
|
}
|
|
@@ -1965,7 +2000,9 @@ export interface AdminListDevicesResponse {
|
|
|
1965
2000
|
export interface AdminListGroupsForUserRequest {
|
|
1966
2001
|
/**
|
|
1967
2002
|
* @public
|
|
1968
|
-
* <p>The username
|
|
2003
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
2004
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
2005
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
1969
2006
|
*/
|
|
1970
2007
|
Username: string | undefined;
|
|
1971
2008
|
/**
|
|
@@ -2066,7 +2103,9 @@ export interface AdminListUserAuthEventsRequest {
|
|
|
2066
2103
|
UserPoolId: string | undefined;
|
|
2067
2104
|
/**
|
|
2068
2105
|
* @public
|
|
2069
|
-
* <p>The user
|
|
2106
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
2107
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
2108
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
2070
2109
|
*/
|
|
2071
2110
|
Username: string | undefined;
|
|
2072
2111
|
/**
|
|
@@ -2354,7 +2393,9 @@ export interface AdminRemoveUserFromGroupRequest {
|
|
|
2354
2393
|
UserPoolId: string | undefined;
|
|
2355
2394
|
/**
|
|
2356
2395
|
* @public
|
|
2357
|
-
* <p>The username
|
|
2396
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
2397
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
2398
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
2358
2399
|
*/
|
|
2359
2400
|
Username: string | undefined;
|
|
2360
2401
|
/**
|
|
@@ -2375,7 +2416,9 @@ export interface AdminResetUserPasswordRequest {
|
|
|
2375
2416
|
UserPoolId: string | undefined;
|
|
2376
2417
|
/**
|
|
2377
2418
|
* @public
|
|
2378
|
-
* <p>The
|
|
2419
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
2420
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
2421
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
2379
2422
|
*/
|
|
2380
2423
|
Username: string | undefined;
|
|
2381
2424
|
/**
|
|
@@ -2456,61 +2499,100 @@ export interface AdminRespondToAuthChallengeRequest {
|
|
|
2456
2499
|
ChallengeName: ChallengeNameType | undefined;
|
|
2457
2500
|
/**
|
|
2458
2501
|
* @public
|
|
2459
|
-
* <p>The
|
|
2460
|
-
*
|
|
2461
|
-
*
|
|
2462
|
-
*
|
|
2502
|
+
* <p>The responses to the challenge that you received in the previous request. Each
|
|
2503
|
+
* challenge has its own required response parameters. The following examples are partial
|
|
2504
|
+
* JSON request bodies that highlight challenge-response parameters.</p>
|
|
2505
|
+
* <important>
|
|
2506
|
+
* <p>You must provide a SECRET_HASH parameter in all challenge responses to an app
|
|
2507
|
+
* client that has a client secret.</p>
|
|
2508
|
+
* </important>
|
|
2509
|
+
* <dl>
|
|
2510
|
+
* <dt>SMS_MFA</dt>
|
|
2511
|
+
* <dd>
|
|
2463
2512
|
* <p>
|
|
2464
|
-
* <code>SMS_MFA
|
|
2465
|
-
*
|
|
2466
|
-
*
|
|
2467
|
-
* </
|
|
2468
|
-
* <
|
|
2513
|
+
* <code>"ChallengeName": "SMS_MFA", "ChallengeResponses": \{"SMS_MFA_CODE":
|
|
2514
|
+
* "[SMS_code]", "USERNAME": "[username]"\}</code>
|
|
2515
|
+
* </p>
|
|
2516
|
+
* </dd>
|
|
2517
|
+
* <dt>PASSWORD_VERIFIER</dt>
|
|
2518
|
+
* <dd>
|
|
2469
2519
|
* <p>
|
|
2470
|
-
* <code>PASSWORD_VERIFIER
|
|
2471
|
-
*
|
|
2472
|
-
*
|
|
2473
|
-
*
|
|
2474
|
-
*
|
|
2475
|
-
*
|
|
2476
|
-
*
|
|
2477
|
-
*
|
|
2478
|
-
*
|
|
2479
|
-
*
|
|
2480
|
-
* <li>
|
|
2520
|
+
* <code>"ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses":
|
|
2521
|
+
* \{"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]",
|
|
2522
|
+
* "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP":
|
|
2523
|
+
* [timestamp], "USERNAME": "[username]"\}</code>
|
|
2524
|
+
* </p>
|
|
2525
|
+
* <p>Add <code>"DEVICE_KEY"</code> when you sign in with a remembered
|
|
2526
|
+
* device.</p>
|
|
2527
|
+
* </dd>
|
|
2528
|
+
* <dt>CUSTOM_CHALLENGE</dt>
|
|
2529
|
+
* <dd>
|
|
2481
2530
|
* <p>
|
|
2482
|
-
* <code>
|
|
2483
|
-
*
|
|
2484
|
-
*
|
|
2485
|
-
*
|
|
2486
|
-
*
|
|
2531
|
+
* <code>"ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses":
|
|
2532
|
+
* \{"USERNAME": "[username]", "ANSWER": "[challenge_answer]"\}</code>
|
|
2533
|
+
* </p>
|
|
2534
|
+
* <p>Add <code>"DEVICE_KEY"</code> when you sign in with a remembered
|
|
2535
|
+
* device.</p>
|
|
2536
|
+
* </dd>
|
|
2537
|
+
* <dt>NEW_PASSWORD_REQUIRED</dt>
|
|
2538
|
+
* <dd>
|
|
2487
2539
|
* <p>
|
|
2488
|
-
* <code>NEW_PASSWORD_REQUIRED
|
|
2489
|
-
*
|
|
2490
|
-
*
|
|
2491
|
-
*
|
|
2492
|
-
*
|
|
2493
|
-
*
|
|
2494
|
-
*
|
|
2495
|
-
*
|
|
2540
|
+
* <code>"ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses":
|
|
2541
|
+
* \{"NEW_PASSWORD": "[new_password]", "USERNAME":
|
|
2542
|
+
* "[username]"\}</code>
|
|
2543
|
+
* </p>
|
|
2544
|
+
* <p>To set any required attributes that <code>InitiateAuth</code> returned in
|
|
2545
|
+
* an <code>requiredAttributes</code> parameter, add
|
|
2546
|
+
* <code>"userAttributes.[attribute_name]": "[attribute_value]"</code>.
|
|
2547
|
+
* This parameter can also set values for writable attributes that aren't
|
|
2548
|
+
* required by your user pool.</p>
|
|
2496
2549
|
* <note>
|
|
2497
2550
|
* <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value.
|
|
2498
|
-
* In <code>
|
|
2499
|
-
* then use the <code>
|
|
2551
|
+
* In <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the <code>requiredAttributes</code> parameter,
|
|
2552
|
+
* then use the <code>UpdateUserAttributes</code> API operation to modify the value of any additional attributes.</p>
|
|
2500
2553
|
* </note>
|
|
2501
|
-
* </
|
|
2502
|
-
* <
|
|
2554
|
+
* </dd>
|
|
2555
|
+
* <dt>SOFTWARE_TOKEN_MFA</dt>
|
|
2556
|
+
* <dd>
|
|
2503
2557
|
* <p>
|
|
2504
|
-
* <code>
|
|
2505
|
-
*
|
|
2506
|
-
*
|
|
2507
|
-
*
|
|
2508
|
-
*
|
|
2509
|
-
*
|
|
2510
|
-
*
|
|
2511
|
-
*
|
|
2512
|
-
*
|
|
2513
|
-
*
|
|
2558
|
+
* <code>"ChallengeName": "SOFTWARE_TOKEN_MFA", "ChallengeResponses":
|
|
2559
|
+
* \{"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE":
|
|
2560
|
+
* [authenticator_code]\}</code>
|
|
2561
|
+
* </p>
|
|
2562
|
+
* </dd>
|
|
2563
|
+
* <dt>DEVICE_SRP_AUTH</dt>
|
|
2564
|
+
* <dd>
|
|
2565
|
+
* <p>
|
|
2566
|
+
* <code>"ChallengeName": "DEVICE_SRP_AUTH", "ChallengeResponses": \{"USERNAME":
|
|
2567
|
+
* "[username]", "DEVICE_KEY": "[device_key]", "SRP_A":
|
|
2568
|
+
* "[srp_a]"\}</code>
|
|
2569
|
+
* </p>
|
|
2570
|
+
* </dd>
|
|
2571
|
+
* <dt>DEVICE_PASSWORD_VERIFIER</dt>
|
|
2572
|
+
* <dd>
|
|
2573
|
+
* <p>
|
|
2574
|
+
* <code>"ChallengeName": "DEVICE_PASSWORD_VERIFIER", "ChallengeResponses":
|
|
2575
|
+
* \{"DEVICE_KEY": "[device_key]", "PASSWORD_CLAIM_SIGNATURE":
|
|
2576
|
+
* "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]",
|
|
2577
|
+
* "TIMESTAMP": [timestamp], "USERNAME": "[username]"\}</code>
|
|
2578
|
+
* </p>
|
|
2579
|
+
* </dd>
|
|
2580
|
+
* <dt>MFA_SETUP</dt>
|
|
2581
|
+
* <dd>
|
|
2582
|
+
* <p>
|
|
2583
|
+
* <code>"ChallengeName": "MFA_SETUP", "ChallengeResponses": \{"USERNAME":
|
|
2584
|
+
* "[username]"\}, "SESSION": "[Session ID from
|
|
2585
|
+
* VerifySoftwareToken]"</code>
|
|
2586
|
+
* </p>
|
|
2587
|
+
* </dd>
|
|
2588
|
+
* <dt>SELECT_MFA_TYPE</dt>
|
|
2589
|
+
* <dd>
|
|
2590
|
+
* <p>
|
|
2591
|
+
* <code>"ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses": \{"USERNAME":
|
|
2592
|
+
* "[username]", "ANSWER": "[SMS_MFA or SOFTWARE_TOKEN_MFA]"\}</code>
|
|
2593
|
+
* </p>
|
|
2594
|
+
* </dd>
|
|
2595
|
+
* </dl>
|
|
2514
2596
|
* <p>For more information about <code>SECRET_HASH</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash">Computing secret hash values</a>. For information about
|
|
2515
2597
|
* <code>DEVICE_KEY</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>
|
|
2516
2598
|
*/
|
|
@@ -2728,7 +2810,9 @@ export interface AdminSetUserMFAPreferenceRequest {
|
|
|
2728
2810
|
SoftwareTokenMfaSettings?: SoftwareTokenMfaSettingsType;
|
|
2729
2811
|
/**
|
|
2730
2812
|
* @public
|
|
2731
|
-
* <p>The user
|
|
2813
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
2814
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
2815
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
2732
2816
|
*/
|
|
2733
2817
|
Username: string | undefined;
|
|
2734
2818
|
/**
|
|
@@ -2753,7 +2837,9 @@ export interface AdminSetUserPasswordRequest {
|
|
|
2753
2837
|
UserPoolId: string | undefined;
|
|
2754
2838
|
/**
|
|
2755
2839
|
* @public
|
|
2756
|
-
* <p>The
|
|
2840
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
2841
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
2842
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
2757
2843
|
*/
|
|
2758
2844
|
Username: string | undefined;
|
|
2759
2845
|
/**
|
|
@@ -2787,7 +2873,9 @@ export interface AdminSetUserSettingsRequest {
|
|
|
2787
2873
|
UserPoolId: string | undefined;
|
|
2788
2874
|
/**
|
|
2789
2875
|
* @public
|
|
2790
|
-
* <p>The
|
|
2876
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
2877
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
2878
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
2791
2879
|
*/
|
|
2792
2880
|
Username: string | undefined;
|
|
2793
2881
|
/**
|
|
@@ -2815,7 +2903,9 @@ export interface AdminUpdateAuthEventFeedbackRequest {
|
|
|
2815
2903
|
UserPoolId: string | undefined;
|
|
2816
2904
|
/**
|
|
2817
2905
|
* @public
|
|
2818
|
-
* <p>The user
|
|
2906
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
2907
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
2908
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
2819
2909
|
*/
|
|
2820
2910
|
Username: string | undefined;
|
|
2821
2911
|
/**
|
|
@@ -2862,7 +2952,9 @@ export interface AdminUpdateDeviceStatusRequest {
|
|
|
2862
2952
|
UserPoolId: string | undefined;
|
|
2863
2953
|
/**
|
|
2864
2954
|
* @public
|
|
2865
|
-
* <p>The user
|
|
2955
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
2956
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
2957
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
2866
2958
|
*/
|
|
2867
2959
|
Username: string | undefined;
|
|
2868
2960
|
/**
|
|
@@ -2894,7 +2986,9 @@ export interface AdminUpdateUserAttributesRequest {
|
|
|
2894
2986
|
UserPoolId: string | undefined;
|
|
2895
2987
|
/**
|
|
2896
2988
|
* @public
|
|
2897
|
-
* <p>The
|
|
2989
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
2990
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
2991
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
2898
2992
|
*/
|
|
2899
2993
|
Username: string | undefined;
|
|
2900
2994
|
/**
|
|
@@ -2971,7 +3065,9 @@ export interface AdminUserGlobalSignOutRequest {
|
|
|
2971
3065
|
UserPoolId: string | undefined;
|
|
2972
3066
|
/**
|
|
2973
3067
|
* @public
|
|
2974
|
-
* <p>The user
|
|
3068
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
3069
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
3070
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
2975
3071
|
*/
|
|
2976
3072
|
Username: string | undefined;
|
|
2977
3073
|
}
|
|
@@ -3240,8 +3336,9 @@ export interface ConfirmForgotPasswordRequest {
|
|
|
3240
3336
|
SecretHash?: string;
|
|
3241
3337
|
/**
|
|
3242
3338
|
* @public
|
|
3243
|
-
* <p>The
|
|
3244
|
-
*
|
|
3339
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
3340
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
3341
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
3245
3342
|
*/
|
|
3246
3343
|
Username: string | undefined;
|
|
3247
3344
|
/**
|
|
@@ -3329,7 +3426,9 @@ export interface ConfirmSignUpRequest {
|
|
|
3329
3426
|
SecretHash?: string;
|
|
3330
3427
|
/**
|
|
3331
3428
|
* @public
|
|
3332
|
-
* <p>The
|
|
3429
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
3430
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
3431
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
3333
3432
|
*/
|
|
3334
3433
|
Username: string | undefined;
|
|
3335
3434
|
/**
|
|
@@ -4262,19 +4361,19 @@ export declare const CustomEmailSenderLambdaVersionType: {
|
|
|
4262
4361
|
export type CustomEmailSenderLambdaVersionType = (typeof CustomEmailSenderLambdaVersionType)[keyof typeof CustomEmailSenderLambdaVersionType];
|
|
4263
4362
|
/**
|
|
4264
4363
|
* @public
|
|
4265
|
-
* <p>
|
|
4364
|
+
* <p>The properties of a custom email sender Lambda trigger.</p>
|
|
4266
4365
|
*/
|
|
4267
4366
|
export interface CustomEmailLambdaVersionConfigType {
|
|
4268
4367
|
/**
|
|
4269
4368
|
* @public
|
|
4270
|
-
* <p>
|
|
4271
|
-
*
|
|
4369
|
+
* <p>The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.</p>
|
|
4370
|
+
* <p>You must use a <code>LambdaVersion</code> of <code>V1_0</code> with a custom sender
|
|
4371
|
+
* function.</p>
|
|
4272
4372
|
*/
|
|
4273
4373
|
LambdaVersion: CustomEmailSenderLambdaVersionType | undefined;
|
|
4274
4374
|
/**
|
|
4275
4375
|
* @public
|
|
4276
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
4277
|
-
* email notifications to users.</p>
|
|
4376
|
+
* <p>The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.</p>
|
|
4278
4377
|
*/
|
|
4279
4378
|
LambdaArn: string | undefined;
|
|
4280
4379
|
}
|
|
@@ -4291,19 +4390,50 @@ export declare const CustomSMSSenderLambdaVersionType: {
|
|
|
4291
4390
|
export type CustomSMSSenderLambdaVersionType = (typeof CustomSMSSenderLambdaVersionType)[keyof typeof CustomSMSSenderLambdaVersionType];
|
|
4292
4391
|
/**
|
|
4293
4392
|
* @public
|
|
4294
|
-
* <p>
|
|
4393
|
+
* <p>The properties of a custom SMS sender Lambda trigger.</p>
|
|
4295
4394
|
*/
|
|
4296
4395
|
export interface CustomSMSLambdaVersionConfigType {
|
|
4297
4396
|
/**
|
|
4298
4397
|
* @public
|
|
4299
|
-
* <p>
|
|
4300
|
-
*
|
|
4398
|
+
* <p>The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.</p>
|
|
4399
|
+
* <p>You must use a <code>LambdaVersion</code> of <code>V1_0</code> with a custom sender
|
|
4400
|
+
* function.</p>
|
|
4301
4401
|
*/
|
|
4302
4402
|
LambdaVersion: CustomSMSSenderLambdaVersionType | undefined;
|
|
4303
4403
|
/**
|
|
4304
4404
|
* @public
|
|
4305
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
4306
|
-
|
|
4405
|
+
* <p>The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.</p>
|
|
4406
|
+
*/
|
|
4407
|
+
LambdaArn: string | undefined;
|
|
4408
|
+
}
|
|
4409
|
+
/**
|
|
4410
|
+
* @public
|
|
4411
|
+
* @enum
|
|
4412
|
+
*/
|
|
4413
|
+
export declare const PreTokenGenerationLambdaVersionType: {
|
|
4414
|
+
readonly V1_0: "V1_0";
|
|
4415
|
+
readonly V2_0: "V2_0";
|
|
4416
|
+
};
|
|
4417
|
+
/**
|
|
4418
|
+
* @public
|
|
4419
|
+
*/
|
|
4420
|
+
export type PreTokenGenerationLambdaVersionType = (typeof PreTokenGenerationLambdaVersionType)[keyof typeof PreTokenGenerationLambdaVersionType];
|
|
4421
|
+
/**
|
|
4422
|
+
* @public
|
|
4423
|
+
* <p>The properties of a pre token generation Lambda trigger.</p>
|
|
4424
|
+
*/
|
|
4425
|
+
export interface PreTokenGenerationVersionConfigType {
|
|
4426
|
+
/**
|
|
4427
|
+
* @public
|
|
4428
|
+
* <p>The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.</p>
|
|
4429
|
+
*/
|
|
4430
|
+
LambdaVersion: PreTokenGenerationLambdaVersionType | undefined;
|
|
4431
|
+
/**
|
|
4432
|
+
* @public
|
|
4433
|
+
* <p>The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.</p>
|
|
4434
|
+
* <p>This parameter and the <code>PreTokenGeneration</code> property of
|
|
4435
|
+
* <code>LambdaConfig</code> have the same value. For new instances of pre token
|
|
4436
|
+
* generation triggers, set <code>LambdaArn</code>.</p>
|
|
4307
4437
|
*/
|
|
4308
4438
|
LambdaArn: string | undefined;
|
|
4309
4439
|
}
|
|
@@ -4354,9 +4484,18 @@ export interface LambdaConfigType {
|
|
|
4354
4484
|
VerifyAuthChallengeResponse?: string;
|
|
4355
4485
|
/**
|
|
4356
4486
|
* @public
|
|
4357
|
-
* <p>
|
|
4487
|
+
* <p>The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.</p>
|
|
4488
|
+
* <p>Set this parameter for legacy purposes. If you also set an ARN in <code>PreTokenGenerationConfig</code>, its value must be identical to <code>PreTokenGeneration</code>. For new instances
|
|
4489
|
+
* of pre token generation triggers, set the <code>LambdaArn</code> of <code>PreTokenGenerationConfig</code>.</p>
|
|
4490
|
+
* <p>You can set <code></code>
|
|
4491
|
+
* </p>
|
|
4358
4492
|
*/
|
|
4359
4493
|
PreTokenGeneration?: string;
|
|
4494
|
+
/**
|
|
4495
|
+
* @public
|
|
4496
|
+
* <p>The detailed configuration of a pre token generation trigger. If you also set an ARN in <code>PreTokenGeneration</code>, its value must be identical to <code>PreTokenGenerationConfig</code>.</p>
|
|
4497
|
+
*/
|
|
4498
|
+
PreTokenGenerationConfig?: PreTokenGenerationVersionConfigType;
|
|
4360
4499
|
/**
|
|
4361
4500
|
* @public
|
|
4362
4501
|
* <p>The user migration Lambda config type.</p>
|
|
@@ -4431,7 +4570,9 @@ export interface PasswordPolicyType {
|
|
|
4431
4570
|
/**
|
|
4432
4571
|
* @public
|
|
4433
4572
|
* <p>The number of days a temporary password is valid in the password policy. If the user
|
|
4434
|
-
* doesn't sign in during this time, an administrator must reset their password
|
|
4573
|
+
* doesn't sign in during this time, an administrator must reset their password. Defaults
|
|
4574
|
+
* to <code>7</code>. If you submit a value of <code>0</code>, Amazon Cognito treats it as a null
|
|
4575
|
+
* value and sets <code>TemporaryPasswordValidityDays</code> to its default value.</p>
|
|
4435
4576
|
* <note>
|
|
4436
4577
|
* <p>When you set <code>TemporaryPasswordValidityDays</code> for a user pool, you can
|
|
4437
4578
|
* no longer set a value for the legacy <code>UnusedAccountValidityDays</code>
|
|
@@ -4862,7 +5003,7 @@ export interface UserPoolType {
|
|
|
4862
5003
|
* @public
|
|
4863
5004
|
* @deprecated
|
|
4864
5005
|
*
|
|
4865
|
-
* <p>
|
|
5006
|
+
* <p>This parameter is no longer used.</p>
|
|
4866
5007
|
*/
|
|
4867
5008
|
Status?: StatusType;
|
|
4868
5009
|
/**
|
|
@@ -5266,12 +5407,35 @@ export interface CreateUserPoolClientRequest {
|
|
|
5266
5407
|
TokenValidityUnits?: TokenValidityUnitsType;
|
|
5267
5408
|
/**
|
|
5268
5409
|
* @public
|
|
5269
|
-
* <p>The read
|
|
5410
|
+
* <p>The list of user attributes that you want your app client to have read-only access to.
|
|
5411
|
+
* After your user authenticates in your app, their access token authorizes them to read
|
|
5412
|
+
* their own attribute value for any attribute in this list. An example of this kind of
|
|
5413
|
+
* activity is when your user selects a link to view their profile information. Your app
|
|
5414
|
+
* makes a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUser.html">GetUser</a> API request to retrieve and display your user's profile
|
|
5415
|
+
* data.</p>
|
|
5416
|
+
* <p>When you don't specify the <code>ReadAttributes</code> for your app client, your
|
|
5417
|
+
* app can read the values of <code>email_verified</code>,
|
|
5418
|
+
* <code>phone_number_verified</code>, and the Standard attributes of your user pool.
|
|
5419
|
+
* When your user pool has read access to these default attributes,
|
|
5420
|
+
* <code>ReadAttributes</code> doesn't return any information. Amazon Cognito only
|
|
5421
|
+
* populates <code>ReadAttributes</code> in the API response if you have specified your own
|
|
5422
|
+
* custom set of read attributes.</p>
|
|
5270
5423
|
*/
|
|
5271
5424
|
ReadAttributes?: string[];
|
|
5272
5425
|
/**
|
|
5273
5426
|
* @public
|
|
5274
|
-
* <p>The user
|
|
5427
|
+
* <p>The list of user attributes that you want your app client to have write access to.
|
|
5428
|
+
* After your user authenticates in your app, their access token authorizes them to set or
|
|
5429
|
+
* modify their own attribute value for any attribute in this list. An example of this kind
|
|
5430
|
+
* of activity is when you present your user with a form to update their profile
|
|
5431
|
+
* information and they change their last name. Your app then makes an <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html">UpdateUserAttributes</a> API request and sets <code>family_name</code> to the
|
|
5432
|
+
* new value. </p>
|
|
5433
|
+
* <p>When you don't specify the <code>WriteAttributes</code> for your app client, your
|
|
5434
|
+
* app can write the values of the Standard attributes of your user pool. When your user
|
|
5435
|
+
* pool has write access to these default attributes, <code>WriteAttributes</code>
|
|
5436
|
+
* doesn't return any information. Amazon Cognito only populates
|
|
5437
|
+
* <code>WriteAttributes</code> in the API response if you have specified your own
|
|
5438
|
+
* custom set of write attributes.</p>
|
|
5275
5439
|
* <p>If your app client allows users to sign in through an IdP, this array must include all
|
|
5276
5440
|
* attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when
|
|
5277
5441
|
* users sign in to your application through an IdP. If your app client does not have write
|
|
@@ -5596,12 +5760,41 @@ export interface UserPoolClientType {
|
|
|
5596
5760
|
TokenValidityUnits?: TokenValidityUnitsType;
|
|
5597
5761
|
/**
|
|
5598
5762
|
* @public
|
|
5599
|
-
* <p>The
|
|
5763
|
+
* <p>The list of user attributes that you want your app client to have read-only access to.
|
|
5764
|
+
* After your user authenticates in your app, their access token authorizes them to read
|
|
5765
|
+
* their own attribute value for any attribute in this list. An example of this kind of
|
|
5766
|
+
* activity is when your user selects a link to view their profile information. Your app
|
|
5767
|
+
* makes a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUser.html">GetUser</a> API request to retrieve and display your user's profile
|
|
5768
|
+
* data.</p>
|
|
5769
|
+
* <p>When you don't specify the <code>ReadAttributes</code> for your app client, your
|
|
5770
|
+
* app can read the values of <code>email_verified</code>,
|
|
5771
|
+
* <code>phone_number_verified</code>, and the Standard attributes of your user pool.
|
|
5772
|
+
* When your user pool has read access to these default attributes,
|
|
5773
|
+
* <code>ReadAttributes</code> doesn't return any information. Amazon Cognito only
|
|
5774
|
+
* populates <code>ReadAttributes</code> in the API response if you have specified your own
|
|
5775
|
+
* custom set of read attributes.</p>
|
|
5600
5776
|
*/
|
|
5601
5777
|
ReadAttributes?: string[];
|
|
5602
5778
|
/**
|
|
5603
5779
|
* @public
|
|
5604
|
-
* <p>The
|
|
5780
|
+
* <p>The list of user attributes that you want your app client to have write access to.
|
|
5781
|
+
* After your user authenticates in your app, their access token authorizes them to set or
|
|
5782
|
+
* modify their own attribute value for any attribute in this list. An example of this kind
|
|
5783
|
+
* of activity is when you present your user with a form to update their profile
|
|
5784
|
+
* information and they change their last name. Your app then makes an <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html">UpdateUserAttributes</a> API request and sets <code>family_name</code> to the
|
|
5785
|
+
* new value. </p>
|
|
5786
|
+
* <p>When you don't specify the <code>WriteAttributes</code> for your app client, your
|
|
5787
|
+
* app can write the values of the Standard attributes of your user pool. When your user
|
|
5788
|
+
* pool has write access to these default attributes, <code>WriteAttributes</code>
|
|
5789
|
+
* doesn't return any information. Amazon Cognito only populates
|
|
5790
|
+
* <code>WriteAttributes</code> in the API response if you have specified your own
|
|
5791
|
+
* custom set of write attributes.</p>
|
|
5792
|
+
* <p>If your app client allows users to sign in through an IdP, this array must include all
|
|
5793
|
+
* attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when
|
|
5794
|
+
* users sign in to your application through an IdP. If your app client does not have write
|
|
5795
|
+
* access to a mapped attribute, Amazon Cognito throws an error when it tries to update the
|
|
5796
|
+
* attribute. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html">Specifying IdP Attribute Mappings for Your user
|
|
5797
|
+
* pool</a>.</p>
|
|
5605
5798
|
*/
|
|
5606
5799
|
WriteAttributes?: string[];
|
|
5607
5800
|
/**
|
|
@@ -6458,8 +6651,9 @@ export interface ForgotPasswordRequest {
|
|
|
6458
6651
|
UserContextData?: UserContextDataType;
|
|
6459
6652
|
/**
|
|
6460
6653
|
* @public
|
|
6461
|
-
* <p>The
|
|
6462
|
-
*
|
|
6654
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
6655
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
6656
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
6463
6657
|
*/
|
|
6464
6658
|
Username: string | undefined;
|
|
6465
6659
|
/**
|
|
@@ -7178,9 +7372,6 @@ export interface InitiateAuthRequest {
|
|
|
7178
7372
|
* <li>
|
|
7179
7373
|
* <p>Define auth challenge</p>
|
|
7180
7374
|
* </li>
|
|
7181
|
-
* <li>
|
|
7182
|
-
* <p>Verify auth challenge</p>
|
|
7183
|
-
* </li>
|
|
7184
7375
|
* </ul>
|
|
7185
7376
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">
|
|
7186
7377
|
* Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
@@ -7232,7 +7423,7 @@ export interface InitiateAuthResponse {
|
|
|
7232
7423
|
/**
|
|
7233
7424
|
* @public
|
|
7234
7425
|
* <p>The name of the challenge that you're responding to with this call. This name is
|
|
7235
|
-
* returned in the <code>
|
|
7426
|
+
* returned in the <code>InitiateAuth</code> response if you must pass another
|
|
7236
7427
|
* challenge.</p>
|
|
7237
7428
|
* <p>Valid values include the following:</p>
|
|
7238
7429
|
* <note>
|
|
@@ -7287,7 +7478,7 @@ export interface InitiateAuthResponse {
|
|
|
7287
7478
|
* <p>
|
|
7288
7479
|
* <code>MFA_SETUP</code>: For users who are required to setup an MFA factor
|
|
7289
7480
|
* before they can sign in. The MFA types activated for the user pool will be
|
|
7290
|
-
* listed in the challenge parameters <code>
|
|
7481
|
+
* listed in the challenge parameters <code>MFAS_CAN_SETUP</code> value. </p>
|
|
7291
7482
|
* <p> To set up software token MFA, use the session returned here from
|
|
7292
7483
|
* <code>InitiateAuth</code> as an input to
|
|
7293
7484
|
* <code>AssociateSoftwareToken</code>. Use the session returned by
|
|
@@ -7345,7 +7536,11 @@ export interface ListDevicesRequest {
|
|
|
7345
7536
|
Limit?: number;
|
|
7346
7537
|
/**
|
|
7347
7538
|
* @public
|
|
7348
|
-
* <p>The pagination token
|
|
7539
|
+
* <p>This API operation returns a limited number of results. The pagination token is
|
|
7540
|
+
* an identifier that you can present in an additional API request with the same parameters. When
|
|
7541
|
+
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
7542
|
+
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
7543
|
+
* through the full list of items.</p>
|
|
7349
7544
|
*/
|
|
7350
7545
|
PaginationToken?: string;
|
|
7351
7546
|
}
|
|
@@ -7361,7 +7556,9 @@ export interface ListDevicesResponse {
|
|
|
7361
7556
|
Devices?: DeviceType[];
|
|
7362
7557
|
/**
|
|
7363
7558
|
* @public
|
|
7364
|
-
* <p>The
|
|
7559
|
+
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
7560
|
+
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
7561
|
+
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
7365
7562
|
*/
|
|
7366
7563
|
PaginationToken?: string;
|
|
7367
7564
|
}
|
|
@@ -7535,9 +7732,11 @@ export interface ListUserImportJobsRequest {
|
|
|
7535
7732
|
MaxResults: number | undefined;
|
|
7536
7733
|
/**
|
|
7537
7734
|
* @public
|
|
7538
|
-
* <p>
|
|
7539
|
-
*
|
|
7540
|
-
*
|
|
7735
|
+
* <p>This API operation returns a limited number of results. The pagination token is
|
|
7736
|
+
* an identifier that you can present in an additional API request with the same parameters. When
|
|
7737
|
+
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
7738
|
+
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
7739
|
+
* through the full list of items.</p>
|
|
7541
7740
|
*/
|
|
7542
7741
|
PaginationToken?: string;
|
|
7543
7742
|
}
|
|
@@ -7554,8 +7753,9 @@ export interface ListUserImportJobsResponse {
|
|
|
7554
7753
|
UserImportJobs?: UserImportJobType[];
|
|
7555
7754
|
/**
|
|
7556
7755
|
* @public
|
|
7557
|
-
* <p>
|
|
7558
|
-
*
|
|
7756
|
+
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
7757
|
+
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
7758
|
+
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
7559
7759
|
*/
|
|
7560
7760
|
PaginationToken?: string;
|
|
7561
7761
|
}
|
|
@@ -7710,6 +7910,11 @@ export interface ListUsersRequest {
|
|
|
7710
7910
|
* want Amazon Cognito to include in the response for each user. When you don't provide an
|
|
7711
7911
|
* <code>AttributesToGet</code> parameter, Amazon Cognito returns all attributes for each
|
|
7712
7912
|
* user.</p>
|
|
7913
|
+
* <p>Use <code>AttributesToGet</code> with required attributes in your user pool, or in
|
|
7914
|
+
* conjunction with <code>Filter</code>. Amazon Cognito returns an error if not all users in the
|
|
7915
|
+
* results have set a value for the attribute you request. Attributes that you can't
|
|
7916
|
+
* filter on, including custom attributes, must have a value set in every user profile
|
|
7917
|
+
* before an <code>AttributesToGet</code> parameter returns results.</p>
|
|
7713
7918
|
*/
|
|
7714
7919
|
AttributesToGet?: string[];
|
|
7715
7920
|
/**
|
|
@@ -7719,8 +7924,11 @@ export interface ListUsersRequest {
|
|
|
7719
7924
|
Limit?: number;
|
|
7720
7925
|
/**
|
|
7721
7926
|
* @public
|
|
7722
|
-
* <p>
|
|
7723
|
-
*
|
|
7927
|
+
* <p>This API operation returns a limited number of results. The pagination token is
|
|
7928
|
+
* an identifier that you can present in an additional API request with the same parameters. When
|
|
7929
|
+
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
7930
|
+
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
7931
|
+
* through the full list of items.</p>
|
|
7724
7932
|
*/
|
|
7725
7933
|
PaginationToken?: string;
|
|
7726
7934
|
/**
|
|
@@ -7838,8 +8046,9 @@ export interface ListUsersResponse {
|
|
|
7838
8046
|
Users?: UserType[];
|
|
7839
8047
|
/**
|
|
7840
8048
|
* @public
|
|
7841
|
-
* <p>
|
|
7842
|
-
*
|
|
8049
|
+
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
8050
|
+
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
8051
|
+
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
7843
8052
|
*/
|
|
7844
8053
|
PaginationToken?: string;
|
|
7845
8054
|
}
|
|
@@ -7859,7 +8068,7 @@ export interface ListUsersInGroupRequest {
|
|
|
7859
8068
|
GroupName: string | undefined;
|
|
7860
8069
|
/**
|
|
7861
8070
|
* @public
|
|
7862
|
-
* <p>The
|
|
8071
|
+
* <p>The maximum number of users that you want to retrieve before pagination.</p>
|
|
7863
8072
|
*/
|
|
7864
8073
|
Limit?: number;
|
|
7865
8074
|
/**
|
|
@@ -7875,7 +8084,7 @@ export interface ListUsersInGroupRequest {
|
|
|
7875
8084
|
export interface ListUsersInGroupResponse {
|
|
7876
8085
|
/**
|
|
7877
8086
|
* @public
|
|
7878
|
-
* <p>
|
|
8087
|
+
* <p>A list of users in the group, and their attributes.</p>
|
|
7879
8088
|
*/
|
|
7880
8089
|
Users?: UserType[];
|
|
7881
8090
|
/**
|
|
@@ -7910,8 +8119,9 @@ export interface ResendConfirmationCodeRequest {
|
|
|
7910
8119
|
UserContextData?: UserContextDataType;
|
|
7911
8120
|
/**
|
|
7912
8121
|
* @public
|
|
7913
|
-
* <p>The
|
|
7914
|
-
*
|
|
8122
|
+
* <p>The username of the user that you want to query or modify. The value of this parameter is typically your user's
|
|
8123
|
+
* username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in
|
|
8124
|
+
* your user pool, you can also use their <code>sub</code> in this request.</p>
|
|
7915
8125
|
*/
|
|
7916
8126
|
Username: string | undefined;
|
|
7917
8127
|
/**
|
|
@@ -7997,69 +8207,100 @@ export interface RespondToAuthChallengeRequest {
|
|
|
7997
8207
|
Session?: string;
|
|
7998
8208
|
/**
|
|
7999
8209
|
* @public
|
|
8000
|
-
* <p>The
|
|
8001
|
-
*
|
|
8002
|
-
*
|
|
8003
|
-
*
|
|
8004
|
-
*
|
|
8005
|
-
*
|
|
8006
|
-
* </
|
|
8007
|
-
* <
|
|
8008
|
-
* <
|
|
8210
|
+
* <p>The responses to the challenge that you received in the previous request. Each
|
|
8211
|
+
* challenge has its own required response parameters. The following examples are partial
|
|
8212
|
+
* JSON request bodies that highlight challenge-response parameters.</p>
|
|
8213
|
+
* <important>
|
|
8214
|
+
* <p>You must provide a SECRET_HASH parameter in all challenge responses to an app
|
|
8215
|
+
* client that has a client secret.</p>
|
|
8216
|
+
* </important>
|
|
8217
|
+
* <dl>
|
|
8218
|
+
* <dt>SMS_MFA</dt>
|
|
8219
|
+
* <dd>
|
|
8009
8220
|
* <p>
|
|
8010
|
-
* <code>SMS_MFA
|
|
8011
|
-
*
|
|
8012
|
-
*
|
|
8221
|
+
* <code>"ChallengeName": "SMS_MFA", "ChallengeResponses": \{"SMS_MFA_CODE":
|
|
8222
|
+
* "[SMS_code]", "USERNAME": "[username]"\}</code>
|
|
8223
|
+
* </p>
|
|
8224
|
+
* </dd>
|
|
8225
|
+
* <dt>PASSWORD_VERIFIER</dt>
|
|
8226
|
+
* <dd>
|
|
8013
8227
|
* <p>
|
|
8014
|
-
* <code>PASSWORD_VERIFIER
|
|
8015
|
-
*
|
|
8016
|
-
*
|
|
8017
|
-
*
|
|
8018
|
-
*
|
|
8019
|
-
*
|
|
8020
|
-
*
|
|
8021
|
-
*
|
|
8022
|
-
* </
|
|
8023
|
-
* <
|
|
8228
|
+
* <code>"ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses":
|
|
8229
|
+
* \{"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]",
|
|
8230
|
+
* "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP":
|
|
8231
|
+
* [timestamp], "USERNAME": "[username]"\}</code>
|
|
8232
|
+
* </p>
|
|
8233
|
+
* <p>Add <code>"DEVICE_KEY"</code> when you sign in with a remembered
|
|
8234
|
+
* device.</p>
|
|
8235
|
+
* </dd>
|
|
8236
|
+
* <dt>CUSTOM_CHALLENGE</dt>
|
|
8237
|
+
* <dd>
|
|
8238
|
+
* <p>
|
|
8239
|
+
* <code>"ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses":
|
|
8240
|
+
* \{"USERNAME": "[username]", "ANSWER": "[challenge_answer]"\}</code>
|
|
8241
|
+
* </p>
|
|
8242
|
+
* <p>Add <code>"DEVICE_KEY"</code> when you sign in with a remembered
|
|
8243
|
+
* device.</p>
|
|
8244
|
+
* </dd>
|
|
8245
|
+
* <dt>NEW_PASSWORD_REQUIRED</dt>
|
|
8246
|
+
* <dd>
|
|
8024
8247
|
* <p>
|
|
8025
|
-
* <code>NEW_PASSWORD_REQUIRED
|
|
8026
|
-
*
|
|
8027
|
-
*
|
|
8028
|
-
*
|
|
8029
|
-
*
|
|
8030
|
-
*
|
|
8031
|
-
*
|
|
8032
|
-
*
|
|
8248
|
+
* <code>"ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses":
|
|
8249
|
+
* \{"NEW_PASSWORD": "[new_password]", "USERNAME":
|
|
8250
|
+
* "[username]"\}</code>
|
|
8251
|
+
* </p>
|
|
8252
|
+
* <p>To set any required attributes that <code>InitiateAuth</code> returned in
|
|
8253
|
+
* an <code>requiredAttributes</code> parameter, add
|
|
8254
|
+
* <code>"userAttributes.[attribute_name]": "[attribute_value]"</code>.
|
|
8255
|
+
* This parameter can also set values for writable attributes that aren't
|
|
8256
|
+
* required by your user pool.</p>
|
|
8033
8257
|
* <note>
|
|
8034
8258
|
* <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value.
|
|
8035
8259
|
* In <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the <code>requiredAttributes</code> parameter,
|
|
8036
8260
|
* then use the <code>UpdateUserAttributes</code> API operation to modify the value of any additional attributes.</p>
|
|
8037
8261
|
* </note>
|
|
8038
|
-
* </
|
|
8039
|
-
* <
|
|
8262
|
+
* </dd>
|
|
8263
|
+
* <dt>SOFTWARE_TOKEN_MFA</dt>
|
|
8264
|
+
* <dd>
|
|
8040
8265
|
* <p>
|
|
8041
|
-
* <code>SOFTWARE_TOKEN_MFA
|
|
8042
|
-
*
|
|
8043
|
-
*
|
|
8044
|
-
*
|
|
8266
|
+
* <code>"ChallengeName": "SOFTWARE_TOKEN_MFA", "ChallengeResponses":
|
|
8267
|
+
* \{"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE":
|
|
8268
|
+
* [authenticator_code]\}</code>
|
|
8269
|
+
* </p>
|
|
8270
|
+
* </dd>
|
|
8271
|
+
* <dt>DEVICE_SRP_AUTH</dt>
|
|
8272
|
+
* <dd>
|
|
8045
8273
|
* <p>
|
|
8046
|
-
* <code>DEVICE_SRP_AUTH
|
|
8047
|
-
*
|
|
8048
|
-
*
|
|
8049
|
-
*
|
|
8050
|
-
*
|
|
8274
|
+
* <code>"ChallengeName": "DEVICE_SRP_AUTH", "ChallengeResponses": \{"USERNAME":
|
|
8275
|
+
* "[username]", "DEVICE_KEY": "[device_key]", "SRP_A":
|
|
8276
|
+
* "[srp_a]"\}</code>
|
|
8277
|
+
* </p>
|
|
8278
|
+
* </dd>
|
|
8279
|
+
* <dt>DEVICE_PASSWORD_VERIFIER</dt>
|
|
8280
|
+
* <dd>
|
|
8051
8281
|
* <p>
|
|
8052
|
-
* <code>DEVICE_PASSWORD_VERIFIER
|
|
8053
|
-
*
|
|
8054
|
-
*
|
|
8055
|
-
*
|
|
8056
|
-
*
|
|
8282
|
+
* <code>"ChallengeName": "DEVICE_PASSWORD_VERIFIER", "ChallengeResponses":
|
|
8283
|
+
* \{"DEVICE_KEY": "[device_key]", "PASSWORD_CLAIM_SIGNATURE":
|
|
8284
|
+
* "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]",
|
|
8285
|
+
* "TIMESTAMP": [timestamp], "USERNAME": "[username]"\}</code>
|
|
8286
|
+
* </p>
|
|
8287
|
+
* </dd>
|
|
8288
|
+
* <dt>MFA_SETUP</dt>
|
|
8289
|
+
* <dd>
|
|
8057
8290
|
* <p>
|
|
8058
|
-
* <code>MFA_SETUP
|
|
8059
|
-
*
|
|
8060
|
-
*
|
|
8061
|
-
*
|
|
8062
|
-
*
|
|
8291
|
+
* <code>"ChallengeName": "MFA_SETUP", "ChallengeResponses": \{"USERNAME":
|
|
8292
|
+
* "[username]"\}, "SESSION": "[Session ID from
|
|
8293
|
+
* VerifySoftwareToken]"</code>
|
|
8294
|
+
* </p>
|
|
8295
|
+
* </dd>
|
|
8296
|
+
* <dt>SELECT_MFA_TYPE</dt>
|
|
8297
|
+
* <dd>
|
|
8298
|
+
* <p>
|
|
8299
|
+
* <code>"ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses": \{"USERNAME":
|
|
8300
|
+
* "[username]", "ANSWER": "[SMS_MFA or SOFTWARE_TOKEN_MFA]"\}</code>
|
|
8301
|
+
* </p>
|
|
8302
|
+
* </dd>
|
|
8303
|
+
* </dl>
|
|
8063
8304
|
* <p>For more information about <code>SECRET_HASH</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash">Computing secret hash values</a>. For information about
|
|
8064
8305
|
* <code>DEVICE_KEY</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>
|
|
8065
8306
|
*/
|
|
@@ -8227,52 +8468,6 @@ export interface SetLogDeliveryConfigurationRequest {
|
|
|
8227
8468
|
*/
|
|
8228
8469
|
LogConfigurations: LogConfigurationType[] | undefined;
|
|
8229
8470
|
}
|
|
8230
|
-
/**
|
|
8231
|
-
* @public
|
|
8232
|
-
*/
|
|
8233
|
-
export interface SetLogDeliveryConfigurationResponse {
|
|
8234
|
-
/**
|
|
8235
|
-
* @public
|
|
8236
|
-
* <p>The detailed activity logging configuration that you applied to the requested user
|
|
8237
|
-
* pool.</p>
|
|
8238
|
-
*/
|
|
8239
|
-
LogDeliveryConfiguration?: LogDeliveryConfigurationType;
|
|
8240
|
-
}
|
|
8241
|
-
/**
|
|
8242
|
-
* @public
|
|
8243
|
-
*/
|
|
8244
|
-
export interface SetRiskConfigurationRequest {
|
|
8245
|
-
/**
|
|
8246
|
-
* @public
|
|
8247
|
-
* <p>The user pool ID. </p>
|
|
8248
|
-
*/
|
|
8249
|
-
UserPoolId: string | undefined;
|
|
8250
|
-
/**
|
|
8251
|
-
* @public
|
|
8252
|
-
* <p>The app client ID. If <code>ClientId</code> is null, then the risk configuration is
|
|
8253
|
-
* mapped to <code>userPoolId</code>. When the client ID is null, the same risk
|
|
8254
|
-
* configuration is applied to all the clients in the userPool.</p>
|
|
8255
|
-
* <p>Otherwise, <code>ClientId</code> is mapped to the client. When the client ID isn't
|
|
8256
|
-
* null, the user pool configuration is overridden and the risk configuration for the
|
|
8257
|
-
* client is used instead.</p>
|
|
8258
|
-
*/
|
|
8259
|
-
ClientId?: string;
|
|
8260
|
-
/**
|
|
8261
|
-
* @public
|
|
8262
|
-
* <p>The compromised credentials risk configuration.</p>
|
|
8263
|
-
*/
|
|
8264
|
-
CompromisedCredentialsRiskConfiguration?: CompromisedCredentialsRiskConfigurationType;
|
|
8265
|
-
/**
|
|
8266
|
-
* @public
|
|
8267
|
-
* <p>The account takeover risk configuration.</p>
|
|
8268
|
-
*/
|
|
8269
|
-
AccountTakeoverRiskConfiguration?: AccountTakeoverRiskConfigurationType;
|
|
8270
|
-
/**
|
|
8271
|
-
* @public
|
|
8272
|
-
* <p>The configuration to override the risk decision.</p>
|
|
8273
|
-
*/
|
|
8274
|
-
RiskExceptionConfiguration?: RiskExceptionConfigurationType;
|
|
8275
|
-
}
|
|
8276
8471
|
/**
|
|
8277
8472
|
* @internal
|
|
8278
8473
|
*/
|
|
@@ -8569,7 +8764,3 @@ export declare const RespondToAuthChallengeResponseFilterSensitiveLog: (obj: Res
|
|
|
8569
8764
|
* @internal
|
|
8570
8765
|
*/
|
|
8571
8766
|
export declare const RevokeTokenRequestFilterSensitiveLog: (obj: RevokeTokenRequest) => any;
|
|
8572
|
-
/**
|
|
8573
|
-
* @internal
|
|
8574
|
-
*/
|
|
8575
|
-
export declare const SetRiskConfigurationRequestFilterSensitiveLog: (obj: SetRiskConfigurationRequest) => any;
|