@aws-sdk/client-cognito-identity-provider 3.709.0 → 3.710.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 +5 -0
- package/dist-types/CognitoIdentityProvider.d.ts +5 -0
- package/dist-types/CognitoIdentityProviderClient.d.ts +5 -0
- package/dist-types/commands/AddCustomAttributesCommand.d.ts +6 -1
- package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +4 -2
- package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +3 -2
- package/dist-types/commands/AdminDeleteUserCommand.d.ts +1 -1
- package/dist-types/commands/AdminDisableUserCommand.d.ts +3 -3
- package/dist-types/commands/AdminEnableUserCommand.d.ts +2 -1
- package/dist-types/commands/AdminForgetDeviceCommand.d.ts +3 -1
- package/dist-types/commands/AdminGetDeviceCommand.d.ts +2 -1
- package/dist-types/commands/AdminGetUserCommand.d.ts +3 -3
- package/dist-types/commands/AdminInitiateAuthCommand.d.ts +5 -1
- package/dist-types/commands/AdminListDevicesCommand.d.ts +4 -1
- package/dist-types/commands/AdminListGroupsForUserCommand.d.ts +3 -1
- package/dist-types/commands/AdminListUserAuthEventsCommand.d.ts +2 -2
- package/dist-types/commands/AdminRemoveUserFromGroupCommand.d.ts +3 -1
- package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +12 -10
- package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +3 -0
- package/dist-types/commands/AdminSetUserPasswordCommand.d.ts +15 -10
- package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts +5 -1
- package/dist-types/commands/AdminUpdateDeviceStatusCommand.d.ts +6 -1
- package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +6 -5
- package/dist-types/commands/AdminUserGlobalSignOutCommand.d.ts +5 -2
- package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +1 -0
- package/dist-types/commands/ConfirmDeviceCommand.d.ts +4 -2
- package/dist-types/commands/ConfirmForgotPasswordCommand.d.ts +2 -1
- package/dist-types/commands/ConfirmSignUpCommand.d.ts +2 -2
- package/dist-types/commands/CreateGroupCommand.d.ts +2 -1
- package/dist-types/commands/CreateIdentityProviderCommand.d.ts +2 -1
- package/dist-types/commands/CreateManagedLoginBrandingCommand.d.ts +6 -3
- package/dist-types/commands/CreateResourceServerCommand.d.ts +3 -1
- package/dist-types/commands/CreateUserImportJobCommand.d.ts +4 -1
- package/dist-types/commands/CreateUserPoolClientCommand.d.ts +6 -3
- package/dist-types/commands/CreateUserPoolCommand.d.ts +4 -2
- package/dist-types/commands/CreateUserPoolDomainCommand.d.ts +10 -2
- package/dist-types/commands/DeleteGroupCommand.d.ts +25 -2
- package/dist-types/commands/DeleteIdentityProviderCommand.d.ts +23 -1
- package/dist-types/commands/DeleteManagedLoginBrandingCommand.d.ts +3 -1
- package/dist-types/commands/DeleteResourceServerCommand.d.ts +24 -1
- package/dist-types/commands/DeleteUserAttributesCommand.d.ts +3 -1
- package/dist-types/commands/DeleteUserCommand.d.ts +2 -1
- package/dist-types/commands/DeleteUserPoolClientCommand.d.ts +2 -1
- package/dist-types/commands/DeleteUserPoolCommand.d.ts +3 -1
- package/dist-types/commands/DeleteUserPoolDomainCommand.d.ts +3 -1
- package/dist-types/commands/DeleteWebAuthnCredentialCommand.d.ts +7 -1
- package/dist-types/commands/DescribeIdentityProviderCommand.d.ts +2 -1
- package/dist-types/commands/DescribeManagedLoginBrandingByClientCommand.d.ts +2 -2
- package/dist-types/commands/DescribeManagedLoginBrandingCommand.d.ts +2 -2
- package/dist-types/commands/DescribeResourceServerCommand.d.ts +1 -1
- package/dist-types/commands/DescribeRiskConfigurationCommand.d.ts +4 -1
- package/dist-types/commands/DescribeUserImportJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeUserPoolClientCommand.d.ts +3 -2
- package/dist-types/commands/DescribeUserPoolCommand.d.ts +3 -1
- package/dist-types/commands/DescribeUserPoolDomainCommand.d.ts +22 -1
- package/dist-types/commands/GlobalSignOutCommand.d.ts +4 -1
- package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +3 -0
- package/dist-types/commands/UpdateManagedLoginBrandingCommand.d.ts +4 -1
- package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts +17 -19
- package/dist-types/index.d.ts +5 -0
- package/dist-types/models/models_0.d.ts +512 -360
- package/dist-types/models/models_1.d.ts +79 -67
- package/package.json +1 -1
|
@@ -379,12 +379,52 @@ export interface SchemaAttributeType {
|
|
|
379
379
|
*/
|
|
380
380
|
export interface AddCustomAttributesRequest {
|
|
381
381
|
/**
|
|
382
|
-
* <p>The
|
|
382
|
+
* <p>The ID of the user pool where you want to add custom attributes.</p>
|
|
383
383
|
* @public
|
|
384
384
|
*/
|
|
385
385
|
UserPoolId: string | undefined;
|
|
386
386
|
/**
|
|
387
|
-
* <p>An array of custom
|
|
387
|
+
* <p>An array of custom attribute names and other properties. Sets the following
|
|
388
|
+
* characteristics:</p>
|
|
389
|
+
* <dl>
|
|
390
|
+
* <dt>AttributeDataType</dt>
|
|
391
|
+
* <dd>
|
|
392
|
+
* <p>The expected data type. Can be a string, a number, a date and time, or a
|
|
393
|
+
* boolean.</p>
|
|
394
|
+
* </dd>
|
|
395
|
+
* <dt>Mutable</dt>
|
|
396
|
+
* <dd>
|
|
397
|
+
* <p>If true, you can grant app clients write access to the attribute value. If
|
|
398
|
+
* false, the attribute value can only be set up on sign-up or administrator
|
|
399
|
+
* creation of users.</p>
|
|
400
|
+
* </dd>
|
|
401
|
+
* <dt>Name</dt>
|
|
402
|
+
* <dd>
|
|
403
|
+
* <p>The attribute name. For an attribute like <code>custom:myAttribute</code>,
|
|
404
|
+
* enter <code>myAttribute</code> for this field.</p>
|
|
405
|
+
* </dd>
|
|
406
|
+
* <dt>Required</dt>
|
|
407
|
+
* <dd>
|
|
408
|
+
* <p>When true, users who sign up or are created must set a value for the
|
|
409
|
+
* attribute.</p>
|
|
410
|
+
* </dd>
|
|
411
|
+
* <dt>NumberAttributeConstraints</dt>
|
|
412
|
+
* <dd>
|
|
413
|
+
* <p>The minimum and maximum length of accepted values for a
|
|
414
|
+
* <code>Number</code>-type attribute.</p>
|
|
415
|
+
* </dd>
|
|
416
|
+
* <dt>StringAttributeConstraints</dt>
|
|
417
|
+
* <dd>
|
|
418
|
+
* <p>The minimum and maximum length of accepted values for a
|
|
419
|
+
* <code>String</code>-type attribute.</p>
|
|
420
|
+
* </dd>
|
|
421
|
+
* <dt>DeveloperOnlyAttribute</dt>
|
|
422
|
+
* <dd>
|
|
423
|
+
* <p>This legacy option creates an attribute with a <code>dev:</code> prefix.
|
|
424
|
+
* You can only set the value of a developer-only attribute with administrative
|
|
425
|
+
* IAM credentials.</p>
|
|
426
|
+
* </dd>
|
|
427
|
+
* </dl>
|
|
388
428
|
* @public
|
|
389
429
|
*/
|
|
390
430
|
CustomAttributes: SchemaAttributeType[] | undefined;
|
|
@@ -482,7 +522,8 @@ export declare class UserImportInProgressException extends __BaseException {
|
|
|
482
522
|
*/
|
|
483
523
|
export interface AdminAddUserToGroupRequest {
|
|
484
524
|
/**
|
|
485
|
-
* <p>The user pool
|
|
525
|
+
* <p>The ID of the user pool that contains the group that you want to add the user
|
|
526
|
+
* to.</p>
|
|
486
527
|
* @public
|
|
487
528
|
*/
|
|
488
529
|
UserPoolId: string | undefined;
|
|
@@ -519,7 +560,8 @@ export declare class UserNotFoundException extends __BaseException {
|
|
|
519
560
|
*/
|
|
520
561
|
export interface AdminConfirmSignUpRequest {
|
|
521
562
|
/**
|
|
522
|
-
* <p>The user pool
|
|
563
|
+
* <p>The ID of the user pool where you want to confirm a user's sign-up
|
|
564
|
+
* request.</p>
|
|
523
565
|
* @public
|
|
524
566
|
*/
|
|
525
567
|
UserPoolId: string | undefined;
|
|
@@ -546,21 +588,21 @@ export interface AdminConfirmSignUpRequest {
|
|
|
546
588
|
* <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">
|
|
547
589
|
* Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
548
590
|
* <note>
|
|
549
|
-
* <p>When you use the ClientMetadata parameter,
|
|
591
|
+
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
550
592
|
* following:</p>
|
|
551
593
|
* <ul>
|
|
552
594
|
* <li>
|
|
553
|
-
* <p>Store the ClientMetadata value. This data is available only
|
|
554
|
-
* triggers that are assigned to a user pool to support custom
|
|
555
|
-
* your user pool configuration doesn't include triggers, the
|
|
556
|
-
* parameter serves no purpose.</p>
|
|
595
|
+
* <p>Store the <code>ClientMetadata</code> value. This data is available only
|
|
596
|
+
* to Lambda triggers that are assigned to a user pool to support custom
|
|
597
|
+
* workflows. If your user pool configuration doesn't include triggers, the
|
|
598
|
+
* <code>ClientMetadata</code> parameter serves no purpose.</p>
|
|
557
599
|
* </li>
|
|
558
600
|
* <li>
|
|
559
|
-
* <p>Validate the ClientMetadata value.</p>
|
|
601
|
+
* <p>Validate the <code>ClientMetadata</code> value.</p>
|
|
560
602
|
* </li>
|
|
561
603
|
* <li>
|
|
562
|
-
* <p>Encrypt the ClientMetadata value. Don't
|
|
563
|
-
* information.</p>
|
|
604
|
+
* <p>Encrypt the <code>ClientMetadata</code> value. Don't send sensitive
|
|
605
|
+
* information in this parameter.</p>
|
|
564
606
|
* </li>
|
|
565
607
|
* </ul>
|
|
566
608
|
* </note>
|
|
@@ -686,7 +728,7 @@ export interface AttributeType {
|
|
|
686
728
|
*/
|
|
687
729
|
export interface AdminCreateUserRequest {
|
|
688
730
|
/**
|
|
689
|
-
* <p>The
|
|
731
|
+
* <p>The ID of the user pool where you want to create a user.</p>
|
|
690
732
|
* @public
|
|
691
733
|
*/
|
|
692
734
|
UserPoolId: string | undefined;
|
|
@@ -790,9 +832,10 @@ export interface AdminCreateUserRequest {
|
|
|
790
832
|
* <code>email_verified</code> attribute is set to <code>True</code>. Otherwise, it is
|
|
791
833
|
* ignored.</p>
|
|
792
834
|
* <p>If this parameter is set to <code>True</code> and the phone number or email address
|
|
793
|
-
* specified in the UserAttributes parameter already exists as an alias with a
|
|
794
|
-
* user,
|
|
795
|
-
* user. The previous user will no longer be able to log in using that
|
|
835
|
+
* specified in the <code>UserAttributes</code> parameter already exists as an alias with a
|
|
836
|
+
* different user, this request migrates the alias from the previous user to the
|
|
837
|
+
* newly-created user. The previous user will no longer be able to log in using that
|
|
838
|
+
* alias.</p>
|
|
796
839
|
* <p>If this parameter is set to <code>False</code>, the API throws an
|
|
797
840
|
* <code>AliasExistsException</code> error if the alias already exists. The default
|
|
798
841
|
* value is <code>False</code>.</p>
|
|
@@ -801,16 +844,16 @@ export interface AdminCreateUserRequest {
|
|
|
801
844
|
ForceAliasCreation?: boolean | undefined;
|
|
802
845
|
/**
|
|
803
846
|
* <p>Set to <code>RESEND</code> to resend the invitation message to a user that already
|
|
804
|
-
* exists and reset the
|
|
805
|
-
*
|
|
847
|
+
* exists, and to reset the temporary-password duration with a new temporary password. Set
|
|
848
|
+
* to <code>SUPPRESS</code> to suppress sending the message. You can specify only one
|
|
806
849
|
* value.</p>
|
|
807
850
|
* @public
|
|
808
851
|
*/
|
|
809
852
|
MessageAction?: MessageActionType | undefined;
|
|
810
853
|
/**
|
|
811
|
-
* <p>Specify <code>
|
|
812
|
-
*
|
|
813
|
-
* <code>
|
|
854
|
+
* <p>Specify <code>EMAIL</code> if email will be used to send the welcome message. Specify
|
|
855
|
+
* <code>SMS</code> if the phone number will be used. The default value is
|
|
856
|
+
* <code>SMS</code>. You can specify more than one value.</p>
|
|
814
857
|
* @public
|
|
815
858
|
*/
|
|
816
859
|
DesiredDeliveryMediums?: DeliveryMediumType[] | undefined;
|
|
@@ -821,28 +864,28 @@ export interface AdminCreateUserRequest {
|
|
|
821
864
|
* When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned
|
|
822
865
|
* to the <i>pre sign-up</i> trigger. When Amazon Cognito invokes this function, it
|
|
823
866
|
* passes a JSON payload, which the function receives as input. This payload contains a
|
|
824
|
-
* <code>
|
|
867
|
+
* <code>ClientMetadata</code> attribute, which provides the data that you assigned to
|
|
825
868
|
* the ClientMetadata parameter in your AdminCreateUser request. In your function code in
|
|
826
869
|
* Lambda, you can process the <code>clientMetadata</code> value to enhance your
|
|
827
870
|
* workflow for your specific needs.</p>
|
|
828
871
|
* <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">
|
|
829
872
|
* Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
830
873
|
* <note>
|
|
831
|
-
* <p>When you use the ClientMetadata parameter,
|
|
874
|
+
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
832
875
|
* following:</p>
|
|
833
876
|
* <ul>
|
|
834
877
|
* <li>
|
|
835
|
-
* <p>Store the ClientMetadata value. This data is available only
|
|
836
|
-
* triggers that are assigned to a user pool to support custom
|
|
837
|
-
* your user pool configuration doesn't include triggers, the
|
|
838
|
-
* parameter serves no purpose.</p>
|
|
878
|
+
* <p>Store the <code>ClientMetadata</code> value. This data is available only
|
|
879
|
+
* to Lambda triggers that are assigned to a user pool to support custom
|
|
880
|
+
* workflows. If your user pool configuration doesn't include triggers, the
|
|
881
|
+
* <code>ClientMetadata</code> parameter serves no purpose.</p>
|
|
839
882
|
* </li>
|
|
840
883
|
* <li>
|
|
841
|
-
* <p>Validate the ClientMetadata value.</p>
|
|
884
|
+
* <p>Validate the <code>ClientMetadata</code> value.</p>
|
|
842
885
|
* </li>
|
|
843
886
|
* <li>
|
|
844
|
-
* <p>Encrypt the ClientMetadata value. Don't
|
|
845
|
-
* information.</p>
|
|
887
|
+
* <p>Encrypt the <code>ClientMetadata</code> value. Don't send sensitive
|
|
888
|
+
* information in this parameter.</p>
|
|
846
889
|
* </li>
|
|
847
890
|
* </ul>
|
|
848
891
|
* </note>
|
|
@@ -962,7 +1005,7 @@ export interface UserType {
|
|
|
962
1005
|
*/
|
|
963
1006
|
export interface AdminCreateUserResponse {
|
|
964
1007
|
/**
|
|
965
|
-
* <p>The
|
|
1008
|
+
* <p>The new user's profile details.</p>
|
|
966
1009
|
* @public
|
|
967
1010
|
*/
|
|
968
1011
|
User?: UserType | undefined;
|
|
@@ -1121,7 +1164,7 @@ export interface AdminCreateUserConfigType {
|
|
|
1121
1164
|
*/
|
|
1122
1165
|
export interface AdminDeleteUserRequest {
|
|
1123
1166
|
/**
|
|
1124
|
-
* <p>The
|
|
1167
|
+
* <p>The ID of the user pool where you want to delete the user.</p>
|
|
1125
1168
|
* @public
|
|
1126
1169
|
*/
|
|
1127
1170
|
UserPoolId: string | undefined;
|
|
@@ -1141,7 +1184,7 @@ export interface AdminDeleteUserRequest {
|
|
|
1141
1184
|
*/
|
|
1142
1185
|
export interface AdminDeleteUserAttributesRequest {
|
|
1143
1186
|
/**
|
|
1144
|
-
* <p>The
|
|
1187
|
+
* <p>The ID of the user pool where you want to delete user attributes.</p>
|
|
1145
1188
|
* @public
|
|
1146
1189
|
*/
|
|
1147
1190
|
UserPoolId: string | undefined;
|
|
@@ -1198,12 +1241,13 @@ export interface ProviderUserIdentifierType {
|
|
|
1198
1241
|
*/
|
|
1199
1242
|
export interface AdminDisableProviderForUserRequest {
|
|
1200
1243
|
/**
|
|
1201
|
-
* <p>The user pool
|
|
1244
|
+
* <p>The ID of the user pool where you want to delete the user's linked
|
|
1245
|
+
* identities.</p>
|
|
1202
1246
|
* @public
|
|
1203
1247
|
*/
|
|
1204
1248
|
UserPoolId: string | undefined;
|
|
1205
1249
|
/**
|
|
1206
|
-
* <p>The user to
|
|
1250
|
+
* <p>The user profile that you want to delete a linked identity from.</p>
|
|
1207
1251
|
* @public
|
|
1208
1252
|
*/
|
|
1209
1253
|
User: ProviderUserIdentifierType | undefined;
|
|
@@ -1235,7 +1279,7 @@ export declare class AliasExistsException extends __BaseException {
|
|
|
1235
1279
|
*/
|
|
1236
1280
|
export interface AdminDisableUserRequest {
|
|
1237
1281
|
/**
|
|
1238
|
-
* <p>The
|
|
1282
|
+
* <p>The ID of the user pool where you want to disable the user.</p>
|
|
1239
1283
|
* @public
|
|
1240
1284
|
*/
|
|
1241
1285
|
UserPoolId: string | undefined;
|
|
@@ -1262,7 +1306,7 @@ export interface AdminDisableUserResponse {
|
|
|
1262
1306
|
*/
|
|
1263
1307
|
export interface AdminEnableUserRequest {
|
|
1264
1308
|
/**
|
|
1265
|
-
* <p>The
|
|
1309
|
+
* <p>The ID of the user pool where you want to activate sign-in for the user.</p>
|
|
1266
1310
|
* @public
|
|
1267
1311
|
*/
|
|
1268
1312
|
UserPoolId: string | undefined;
|
|
@@ -1289,7 +1333,7 @@ export interface AdminEnableUserResponse {
|
|
|
1289
1333
|
*/
|
|
1290
1334
|
export interface AdminForgetDeviceRequest {
|
|
1291
1335
|
/**
|
|
1292
|
-
* <p>The user pool
|
|
1336
|
+
* <p>The ID of the user pool where the device owner is a user.</p>
|
|
1293
1337
|
* @public
|
|
1294
1338
|
*/
|
|
1295
1339
|
UserPoolId: string | undefined;
|
|
@@ -1303,7 +1347,8 @@ export interface AdminForgetDeviceRequest {
|
|
|
1303
1347
|
*/
|
|
1304
1348
|
Username: string | undefined;
|
|
1305
1349
|
/**
|
|
1306
|
-
* <p>The device
|
|
1350
|
+
* <p>The key ID of the device that you want to delete. You can get device keys in the
|
|
1351
|
+
* response to an <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminListDevices.html">AdminListDevices</a> request.</p>
|
|
1307
1352
|
* @public
|
|
1308
1353
|
*/
|
|
1309
1354
|
DeviceKey: string | undefined;
|
|
@@ -1326,12 +1371,13 @@ export declare class InvalidUserPoolConfigurationException extends __BaseExcepti
|
|
|
1326
1371
|
*/
|
|
1327
1372
|
export interface AdminGetDeviceRequest {
|
|
1328
1373
|
/**
|
|
1329
|
-
* <p>The device
|
|
1374
|
+
* <p>The key of the device that you want to delete. You can get device IDs in the response
|
|
1375
|
+
* to an <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminListDevices.html">AdminListDevices</a> request.</p>
|
|
1330
1376
|
* @public
|
|
1331
1377
|
*/
|
|
1332
1378
|
DeviceKey: string | undefined;
|
|
1333
1379
|
/**
|
|
1334
|
-
* <p>The user pool
|
|
1380
|
+
* <p>The ID of the user pool where the device owner is a user.</p>
|
|
1335
1381
|
* @public
|
|
1336
1382
|
*/
|
|
1337
1383
|
UserPoolId: string | undefined;
|
|
@@ -1387,7 +1433,8 @@ export interface DeviceType {
|
|
|
1387
1433
|
*/
|
|
1388
1434
|
export interface AdminGetDeviceResponse {
|
|
1389
1435
|
/**
|
|
1390
|
-
* <p>
|
|
1436
|
+
* <p>Details of the requested device. Includes device information, last-accessed and
|
|
1437
|
+
* created dates, and the device key.</p>
|
|
1391
1438
|
* @public
|
|
1392
1439
|
*/
|
|
1393
1440
|
Device: DeviceType | undefined;
|
|
@@ -1398,8 +1445,7 @@ export interface AdminGetDeviceResponse {
|
|
|
1398
1445
|
*/
|
|
1399
1446
|
export interface AdminGetUserRequest {
|
|
1400
1447
|
/**
|
|
1401
|
-
* <p>The
|
|
1402
|
-
* user.</p>
|
|
1448
|
+
* <p>The ID of the user pool where you want to get information about the user.</p>
|
|
1403
1449
|
* @public
|
|
1404
1450
|
*/
|
|
1405
1451
|
UserPoolId: string | undefined;
|
|
@@ -1425,12 +1471,14 @@ export interface AdminGetUserResponse {
|
|
|
1425
1471
|
*/
|
|
1426
1472
|
Username: string | undefined;
|
|
1427
1473
|
/**
|
|
1428
|
-
* <p>An array of name-value pairs
|
|
1474
|
+
* <p>An array of name-value pairs of user attributes and their values, for example
|
|
1475
|
+
* <code>"email": "testuser@example.com"</code>.</p>
|
|
1429
1476
|
* @public
|
|
1430
1477
|
*/
|
|
1431
1478
|
UserAttributes?: AttributeType[] | undefined;
|
|
1432
1479
|
/**
|
|
1433
|
-
* <p>The date the
|
|
1480
|
+
* <p>The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
|
|
1481
|
+
* human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
|
|
1434
1482
|
* @public
|
|
1435
1483
|
*/
|
|
1436
1484
|
UserCreateDate?: Date | undefined;
|
|
@@ -1441,12 +1489,13 @@ export interface AdminGetUserResponse {
|
|
|
1441
1489
|
*/
|
|
1442
1490
|
UserLastModifiedDate?: Date | undefined;
|
|
1443
1491
|
/**
|
|
1444
|
-
* <p>Indicates
|
|
1492
|
+
* <p>Indicates whether the user is activated for sign-in. The <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminDisableUser.html">AdminDisableUser</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminEnableUser.html">AdminEnableUser</a> API operations deactivate and activate
|
|
1493
|
+
* user sign-in, respectively.</p>
|
|
1445
1494
|
* @public
|
|
1446
1495
|
*/
|
|
1447
1496
|
Enabled?: boolean | undefined;
|
|
1448
1497
|
/**
|
|
1449
|
-
* <p>The user status. Can be one of the following:</p>
|
|
1498
|
+
* <p>The user's status. Can be one of the following:</p>
|
|
1450
1499
|
* <ul>
|
|
1451
1500
|
* <li>
|
|
1452
1501
|
* <p>UNCONFIRMED - User has been created but not confirmed.</p>
|
|
@@ -1466,6 +1515,10 @@ export interface AdminGetUserResponse {
|
|
|
1466
1515
|
* temporary password, but on first sign-in, the user must change their password to
|
|
1467
1516
|
* a new value before doing anything else. </p>
|
|
1468
1517
|
* </li>
|
|
1518
|
+
* <li>
|
|
1519
|
+
* <p>EXTERNAL_PROVIDER - The user signed in with a third-party identity
|
|
1520
|
+
* provider.</p>
|
|
1521
|
+
* </li>
|
|
1469
1522
|
* </ul>
|
|
1470
1523
|
* @public
|
|
1471
1524
|
*/
|
|
@@ -1481,14 +1534,16 @@ export interface AdminGetUserResponse {
|
|
|
1481
1534
|
*/
|
|
1482
1535
|
MFAOptions?: MFAOptionType[] | undefined;
|
|
1483
1536
|
/**
|
|
1484
|
-
* <p>The user's preferred MFA
|
|
1537
|
+
* <p>The user's preferred MFA. Users can prefer SMS message, email message, or TOTP
|
|
1538
|
+
* MFA.</p>
|
|
1485
1539
|
* @public
|
|
1486
1540
|
*/
|
|
1487
1541
|
PreferredMfaSetting?: string | undefined;
|
|
1488
1542
|
/**
|
|
1489
1543
|
* <p>The MFA options that are activated for the user. The possible values in this list are
|
|
1490
|
-
* <code>SMS_MFA</code>, <code>EMAIL_OTP</code>, and
|
|
1491
|
-
*
|
|
1544
|
+
* <code>SMS_MFA</code>, <code>EMAIL_OTP</code>, and <code>SOFTWARE_TOKEN_MFA</code>.
|
|
1545
|
+
* You can change the MFA preference for users who have more than one available MFA factor
|
|
1546
|
+
* with <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserMFAPreference.html">AdminSetUserMFAPreference</a> or <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserMFAPreference.html">SetUserMFAPreference</a>.</p>
|
|
1492
1547
|
* @public
|
|
1493
1548
|
*/
|
|
1494
1549
|
UserMFASettingList?: string[] | undefined;
|
|
@@ -1587,18 +1642,19 @@ export interface ContextDataType {
|
|
|
1587
1642
|
*/
|
|
1588
1643
|
export interface AdminInitiateAuthRequest {
|
|
1589
1644
|
/**
|
|
1590
|
-
* <p>The ID of the
|
|
1645
|
+
* <p>The ID of the user pool where the user wants to sign in.</p>
|
|
1591
1646
|
* @public
|
|
1592
1647
|
*/
|
|
1593
1648
|
UserPoolId: string | undefined;
|
|
1594
1649
|
/**
|
|
1595
|
-
* <p>The app client
|
|
1650
|
+
* <p>The ID of the app client where the user wants to sign in.</p>
|
|
1596
1651
|
* @public
|
|
1597
1652
|
*/
|
|
1598
1653
|
ClientId: string | undefined;
|
|
1599
1654
|
/**
|
|
1600
|
-
* <p>The authentication flow that you want to initiate.
|
|
1601
|
-
* that you must submit
|
|
1655
|
+
* <p>The authentication flow that you want to initiate. Each <code>AuthFlow</code> has
|
|
1656
|
+
* linked <code>AuthParameters</code> that you must submit. The following are some example
|
|
1657
|
+
* flows and their parameters.</p>
|
|
1602
1658
|
* <ul>
|
|
1603
1659
|
* <li>
|
|
1604
1660
|
* <p>
|
|
@@ -1626,12 +1682,14 @@ export interface AdminInitiateAuthRequest {
|
|
|
1626
1682
|
* <code>USERNAME</code> and <code>PASSWORD</code> parameters.</p>
|
|
1627
1683
|
* </li>
|
|
1628
1684
|
* </ul>
|
|
1629
|
-
* <p>
|
|
1685
|
+
* <p>
|
|
1686
|
+
* <i>All flows</i>
|
|
1687
|
+
* </p>
|
|
1630
1688
|
* <dl>
|
|
1631
1689
|
* <dt>USER_AUTH</dt>
|
|
1632
1690
|
* <dd>
|
|
1633
|
-
* <p>The entry point for sign-in with passwords, one-time passwords,
|
|
1634
|
-
*
|
|
1691
|
+
* <p>The entry point for sign-in with passwords, one-time passwords, and
|
|
1692
|
+
* WebAuthN authenticators.</p>
|
|
1635
1693
|
* </dd>
|
|
1636
1694
|
* <dt>USER_SRP_AUTH</dt>
|
|
1637
1695
|
* <dd>
|
|
@@ -1754,21 +1812,21 @@ export interface AdminInitiateAuthRequest {
|
|
|
1754
1812
|
* <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">
|
|
1755
1813
|
* Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
1756
1814
|
* <note>
|
|
1757
|
-
* <p>When you use the ClientMetadata parameter,
|
|
1815
|
+
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
1758
1816
|
* following:</p>
|
|
1759
1817
|
* <ul>
|
|
1760
1818
|
* <li>
|
|
1761
|
-
* <p>Store the ClientMetadata value. This data is available only
|
|
1762
|
-
* triggers that are assigned to a user pool to support custom
|
|
1763
|
-
* your user pool configuration doesn't include triggers, the
|
|
1764
|
-
* parameter serves no purpose.</p>
|
|
1819
|
+
* <p>Store the <code>ClientMetadata</code> value. This data is available only
|
|
1820
|
+
* to Lambda triggers that are assigned to a user pool to support custom
|
|
1821
|
+
* workflows. If your user pool configuration doesn't include triggers, the
|
|
1822
|
+
* <code>ClientMetadata</code> parameter serves no purpose.</p>
|
|
1765
1823
|
* </li>
|
|
1766
1824
|
* <li>
|
|
1767
|
-
* <p>Validate the ClientMetadata value.</p>
|
|
1825
|
+
* <p>Validate the <code>ClientMetadata</code> value.</p>
|
|
1768
1826
|
* </li>
|
|
1769
1827
|
* <li>
|
|
1770
|
-
* <p>Encrypt the ClientMetadata value. Don't
|
|
1771
|
-
* information.</p>
|
|
1828
|
+
* <p>Encrypt the <code>ClientMetadata</code> value. Don't send sensitive
|
|
1829
|
+
* information in this parameter.</p>
|
|
1772
1830
|
* </li>
|
|
1773
1831
|
* </ul>
|
|
1774
1832
|
* </note>
|
|
@@ -1776,8 +1834,7 @@ export interface AdminInitiateAuthRequest {
|
|
|
1776
1834
|
*/
|
|
1777
1835
|
ClientMetadata?: Record<string, string> | undefined;
|
|
1778
1836
|
/**
|
|
1779
|
-
* <p>The analytics metadata for collecting Amazon Pinpoint metrics
|
|
1780
|
-
* <code>AdminInitiateAuth</code> calls.</p>
|
|
1837
|
+
* <p>The analytics metadata for collecting Amazon Pinpoint metrics.</p>
|
|
1781
1838
|
* @public
|
|
1782
1839
|
*/
|
|
1783
1840
|
AnalyticsMetadata?: AnalyticsMetadataType | undefined;
|
|
@@ -1785,13 +1842,17 @@ export interface AdminInitiateAuthRequest {
|
|
|
1785
1842
|
* <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
|
|
1786
1843
|
* security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
|
|
1787
1844
|
* when it makes API requests.</p>
|
|
1845
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html">Collecting data for threat protection in
|
|
1846
|
+
* applications</a>.</p>
|
|
1788
1847
|
* @public
|
|
1789
1848
|
*/
|
|
1790
1849
|
ContextData?: ContextDataType | undefined;
|
|
1791
1850
|
/**
|
|
1792
1851
|
* <p>The optional session ID from a <code>ConfirmSignUp</code> API request. You can sign in
|
|
1793
|
-
* a user directly from the sign-up process with
|
|
1794
|
-
*
|
|
1852
|
+
* a user directly from the sign-up process with an <code>AuthFlow</code> of
|
|
1853
|
+
* <code>USER_AUTH</code> and <code>AuthParameters</code> of <code>EMAIL_OTP</code> or
|
|
1854
|
+
* <code>SMS_OTP</code>, depending on how your user pool sent the confirmation-code
|
|
1855
|
+
* message.</p>
|
|
1795
1856
|
* @public
|
|
1796
1857
|
*/
|
|
1797
1858
|
Session?: string | undefined;
|
|
@@ -2014,11 +2075,11 @@ export interface AdminInitiateAuthResponse {
|
|
|
2014
2075
|
*/
|
|
2015
2076
|
ChallengeName?: ChallengeNameType | undefined;
|
|
2016
2077
|
/**
|
|
2017
|
-
* <p>The session that
|
|
2018
|
-
*
|
|
2019
|
-
*
|
|
2020
|
-
*
|
|
2021
|
-
* <code>
|
|
2078
|
+
* <p>The session that must be passed to challenge-response requests. If an
|
|
2079
|
+
* <code>AdminInitiateAuth</code> or <code>AdminRespondToAuthChallenge</code> API
|
|
2080
|
+
* request determines that the caller must pass another challenge, Amazon Cognito returns a session
|
|
2081
|
+
* ID and the parameters of the next challenge. Pass this session Id in the
|
|
2082
|
+
* <code>Session</code> parameter of <code>AdminRespondToAuthChallenge</code>.</p>
|
|
2022
2083
|
* @public
|
|
2023
2084
|
*/
|
|
2024
2085
|
Session?: string | undefined;
|
|
@@ -2038,10 +2099,10 @@ export interface AdminInitiateAuthResponse {
|
|
|
2038
2099
|
*/
|
|
2039
2100
|
ChallengeParameters?: Record<string, string> | undefined;
|
|
2040
2101
|
/**
|
|
2041
|
-
* <p>The
|
|
2042
|
-
*
|
|
2043
|
-
*
|
|
2044
|
-
* <code>Session</code>
|
|
2102
|
+
* <p>The outcome of successful authentication. This is only returned if the user pool has
|
|
2103
|
+
* no additional challenges to return. If Amazon Cognito returns another challenge, the response
|
|
2104
|
+
* includes <code>ChallengeName</code>, <code>ChallengeParameters</code>, and
|
|
2105
|
+
* <code>Session</code> so that your user can answer the challenge.</p>
|
|
2045
2106
|
* @public
|
|
2046
2107
|
*/
|
|
2047
2108
|
AuthenticationResult?: AuthenticationResultType | undefined;
|
|
@@ -2101,7 +2162,7 @@ export declare class UserNotConfirmedException extends __BaseException {
|
|
|
2101
2162
|
*/
|
|
2102
2163
|
export interface AdminLinkProviderForUserRequest {
|
|
2103
2164
|
/**
|
|
2104
|
-
* <p>The user pool
|
|
2165
|
+
* <p>The ID of the user pool where you want to link a federated identity.</p>
|
|
2105
2166
|
* @public
|
|
2106
2167
|
*/
|
|
2107
2168
|
UserPoolId: string | undefined;
|
|
@@ -2174,7 +2235,7 @@ export interface AdminLinkProviderForUserResponse {
|
|
|
2174
2235
|
*/
|
|
2175
2236
|
export interface AdminListDevicesRequest {
|
|
2176
2237
|
/**
|
|
2177
|
-
* <p>The user pool
|
|
2238
|
+
* <p>The ID of the user pool where the device owner is a user.</p>
|
|
2178
2239
|
* @public
|
|
2179
2240
|
*/
|
|
2180
2241
|
UserPoolId: string | undefined;
|
|
@@ -2188,7 +2249,7 @@ export interface AdminListDevicesRequest {
|
|
|
2188
2249
|
*/
|
|
2189
2250
|
Username: string | undefined;
|
|
2190
2251
|
/**
|
|
2191
|
-
* <p>The
|
|
2252
|
+
* <p>The maximum number of devices that you want Amazon Cognito to return in the response.</p>
|
|
2192
2253
|
* @public
|
|
2193
2254
|
*/
|
|
2194
2255
|
Limit?: number | undefined;
|
|
@@ -2208,7 +2269,8 @@ export interface AdminListDevicesRequest {
|
|
|
2208
2269
|
*/
|
|
2209
2270
|
export interface AdminListDevicesResponse {
|
|
2210
2271
|
/**
|
|
2211
|
-
* <p>
|
|
2272
|
+
* <p>An array of devices and their information. Each entry that's returned includes
|
|
2273
|
+
* device information, last-accessed and created dates, and the device key.</p>
|
|
2212
2274
|
* @public
|
|
2213
2275
|
*/
|
|
2214
2276
|
Devices?: DeviceType[] | undefined;
|
|
@@ -2234,18 +2296,21 @@ export interface AdminListGroupsForUserRequest {
|
|
|
2234
2296
|
*/
|
|
2235
2297
|
Username: string | undefined;
|
|
2236
2298
|
/**
|
|
2237
|
-
* <p>The user pool
|
|
2299
|
+
* <p>The ID of the user pool where you want to view a user's groups.</p>
|
|
2238
2300
|
* @public
|
|
2239
2301
|
*/
|
|
2240
2302
|
UserPoolId: string | undefined;
|
|
2241
2303
|
/**
|
|
2242
|
-
* <p>The
|
|
2304
|
+
* <p>The maximum number of groups that you want Amazon Cognito to return in the response.</p>
|
|
2243
2305
|
* @public
|
|
2244
2306
|
*/
|
|
2245
2307
|
Limit?: number | undefined;
|
|
2246
2308
|
/**
|
|
2247
|
-
* <p>
|
|
2248
|
-
*
|
|
2309
|
+
* <p>This API operation returns a limited number of results. The pagination token is
|
|
2310
|
+
* an identifier that you can present in an additional API request with the same parameters. When
|
|
2311
|
+
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
2312
|
+
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
2313
|
+
* through the full list of items.</p>
|
|
2249
2314
|
* @public
|
|
2250
2315
|
*/
|
|
2251
2316
|
NextToken?: string | undefined;
|
|
@@ -2317,13 +2382,14 @@ export interface GroupType {
|
|
|
2317
2382
|
*/
|
|
2318
2383
|
export interface AdminListGroupsForUserResponse {
|
|
2319
2384
|
/**
|
|
2320
|
-
* <p>
|
|
2385
|
+
* <p>An array of groups and information about them.</p>
|
|
2321
2386
|
* @public
|
|
2322
2387
|
*/
|
|
2323
2388
|
Groups?: GroupType[] | undefined;
|
|
2324
2389
|
/**
|
|
2325
|
-
* <p>
|
|
2326
|
-
*
|
|
2390
|
+
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
2391
|
+
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
2392
|
+
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
2327
2393
|
* @public
|
|
2328
2394
|
*/
|
|
2329
2395
|
NextToken?: string | undefined;
|
|
@@ -2333,7 +2399,7 @@ export interface AdminListGroupsForUserResponse {
|
|
|
2333
2399
|
*/
|
|
2334
2400
|
export interface AdminListUserAuthEventsRequest {
|
|
2335
2401
|
/**
|
|
2336
|
-
* <p>The user pool
|
|
2402
|
+
* <p>The Id of the user pool that contains the user profile with the logged events.</p>
|
|
2337
2403
|
* @public
|
|
2338
2404
|
*/
|
|
2339
2405
|
UserPoolId: string | undefined;
|
|
@@ -2354,7 +2420,11 @@ export interface AdminListUserAuthEventsRequest {
|
|
|
2354
2420
|
*/
|
|
2355
2421
|
MaxResults?: number | undefined;
|
|
2356
2422
|
/**
|
|
2357
|
-
* <p>
|
|
2423
|
+
* <p>This API operation returns a limited number of results. The pagination token is
|
|
2424
|
+
* an identifier that you can present in an additional API request with the same parameters. When
|
|
2425
|
+
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
2426
|
+
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
2427
|
+
* through the full list of items.</p>
|
|
2358
2428
|
* @public
|
|
2359
2429
|
*/
|
|
2360
2430
|
NextToken?: string | undefined;
|
|
@@ -2798,7 +2868,9 @@ export interface AdminListUserAuthEventsResponse {
|
|
|
2798
2868
|
*/
|
|
2799
2869
|
AuthEvents?: AuthEventType[] | undefined;
|
|
2800
2870
|
/**
|
|
2801
|
-
* <p>
|
|
2871
|
+
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
2872
|
+
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
2873
|
+
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
2802
2874
|
* @public
|
|
2803
2875
|
*/
|
|
2804
2876
|
NextToken?: string | undefined;
|
|
@@ -2820,7 +2892,8 @@ export declare class UserPoolAddOnNotEnabledException extends __BaseException {
|
|
|
2820
2892
|
*/
|
|
2821
2893
|
export interface AdminRemoveUserFromGroupRequest {
|
|
2822
2894
|
/**
|
|
2823
|
-
* <p>The user pool
|
|
2895
|
+
* <p>The ID of the user pool that contains the group and the user that you want to
|
|
2896
|
+
* remove.</p>
|
|
2824
2897
|
* @public
|
|
2825
2898
|
*/
|
|
2826
2899
|
UserPoolId: string | undefined;
|
|
@@ -2834,7 +2907,8 @@ export interface AdminRemoveUserFromGroupRequest {
|
|
|
2834
2907
|
*/
|
|
2835
2908
|
Username: string | undefined;
|
|
2836
2909
|
/**
|
|
2837
|
-
* <p>The group
|
|
2910
|
+
* <p>The name of the group that you want to remove the user from, for example
|
|
2911
|
+
* <code>MyTestGroup</code>.</p>
|
|
2838
2912
|
* @public
|
|
2839
2913
|
*/
|
|
2840
2914
|
GroupName: string | undefined;
|
|
@@ -2845,7 +2919,7 @@ export interface AdminRemoveUserFromGroupRequest {
|
|
|
2845
2919
|
*/
|
|
2846
2920
|
export interface AdminResetUserPasswordRequest {
|
|
2847
2921
|
/**
|
|
2848
|
-
* <p>The
|
|
2922
|
+
* <p>The ID of the user pool where you want to reset the user's password.</p>
|
|
2849
2923
|
* @public
|
|
2850
2924
|
*/
|
|
2851
2925
|
UserPoolId: string | undefined;
|
|
@@ -2862,7 +2936,7 @@ export interface AdminResetUserPasswordRequest {
|
|
|
2862
2936
|
* <p>A map of custom key-value pairs that you can provide as input for any custom workflows
|
|
2863
2937
|
* that this action triggers.</p>
|
|
2864
2938
|
* <p>You create custom workflows by assigning Lambda functions to user pool
|
|
2865
|
-
* triggers.
|
|
2939
|
+
* triggers. The <code>AdminResetUserPassword</code> API operation invokes the function
|
|
2866
2940
|
* that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes
|
|
2867
2941
|
* this function, it passes a JSON payload, which the function receives as input. This
|
|
2868
2942
|
* payload contains a <code>clientMetadata</code> attribute, which provides the data that
|
|
@@ -2872,21 +2946,21 @@ export interface AdminResetUserPasswordRequest {
|
|
|
2872
2946
|
* <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">
|
|
2873
2947
|
* Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
2874
2948
|
* <note>
|
|
2875
|
-
* <p>When you use the ClientMetadata parameter,
|
|
2949
|
+
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
2876
2950
|
* following:</p>
|
|
2877
2951
|
* <ul>
|
|
2878
2952
|
* <li>
|
|
2879
|
-
* <p>Store the ClientMetadata value. This data is available only
|
|
2880
|
-
* triggers that are assigned to a user pool to support custom
|
|
2881
|
-
* your user pool configuration doesn't include triggers, the
|
|
2882
|
-
* parameter serves no purpose.</p>
|
|
2953
|
+
* <p>Store the <code>ClientMetadata</code> value. This data is available only
|
|
2954
|
+
* to Lambda triggers that are assigned to a user pool to support custom
|
|
2955
|
+
* workflows. If your user pool configuration doesn't include triggers, the
|
|
2956
|
+
* <code>ClientMetadata</code> parameter serves no purpose.</p>
|
|
2883
2957
|
* </li>
|
|
2884
2958
|
* <li>
|
|
2885
|
-
* <p>Validate the ClientMetadata value.</p>
|
|
2959
|
+
* <p>Validate the <code>ClientMetadata</code> value.</p>
|
|
2886
2960
|
* </li>
|
|
2887
2961
|
* <li>
|
|
2888
|
-
* <p>Encrypt the ClientMetadata value. Don't
|
|
2889
|
-
* information.</p>
|
|
2962
|
+
* <p>Encrypt the <code>ClientMetadata</code> value. Don't send sensitive
|
|
2963
|
+
* information in this parameter.</p>
|
|
2890
2964
|
* </li>
|
|
2891
2965
|
* </ul>
|
|
2892
2966
|
* </note>
|
|
@@ -2907,17 +2981,19 @@ export interface AdminResetUserPasswordResponse {
|
|
|
2907
2981
|
*/
|
|
2908
2982
|
export interface AdminRespondToAuthChallengeRequest {
|
|
2909
2983
|
/**
|
|
2910
|
-
* <p>The ID of the
|
|
2984
|
+
* <p>The ID of the user pool where you want to respond to an authentication
|
|
2985
|
+
* challenge.</p>
|
|
2911
2986
|
* @public
|
|
2912
2987
|
*/
|
|
2913
2988
|
UserPoolId: string | undefined;
|
|
2914
2989
|
/**
|
|
2915
|
-
* <p>The app client
|
|
2990
|
+
* <p>The ID of the app client where you initiated sign-in.</p>
|
|
2916
2991
|
* @public
|
|
2917
2992
|
*/
|
|
2918
2993
|
ClientId: string | undefined;
|
|
2919
2994
|
/**
|
|
2920
|
-
* <p>The challenge
|
|
2995
|
+
* <p>The name of the challenge that you are responding to. You can find more information
|
|
2996
|
+
* about values for <code>ChallengeName</code> in the response parameters of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html#CognitoUserPools-AdminInitiateAuth-response-ChallengeName">AdminInitiateAuth</a>.</p>
|
|
2921
2997
|
* @public
|
|
2922
2998
|
*/
|
|
2923
2999
|
ChallengeName: ChallengeNameType | undefined;
|
|
@@ -3100,11 +3176,12 @@ export interface AdminRespondToAuthChallengeRequest {
|
|
|
3100
3176
|
*/
|
|
3101
3177
|
ChallengeResponses?: Record<string, string> | undefined;
|
|
3102
3178
|
/**
|
|
3103
|
-
* <p>The session that
|
|
3104
|
-
*
|
|
3105
|
-
*
|
|
3106
|
-
*
|
|
3107
|
-
*
|
|
3179
|
+
* <p>The session identifier that maintains the state of authentication requests and
|
|
3180
|
+
* challenge responses. If an <code>AdminInitiateAuth</code> or
|
|
3181
|
+
* <code>AdminRespondToAuthChallenge</code> API request results in a determination that
|
|
3182
|
+
* your application must pass another challenge, Amazon Cognito returns a session with other
|
|
3183
|
+
* challenge parameters. Send this session identifier, unmodified, to the next
|
|
3184
|
+
* <code>AdminRespondToAuthChallenge</code> request.</p>
|
|
3108
3185
|
* @public
|
|
3109
3186
|
*/
|
|
3110
3187
|
Session?: string | undefined;
|
|
@@ -3118,6 +3195,8 @@ export interface AdminRespondToAuthChallengeRequest {
|
|
|
3118
3195
|
* <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
|
|
3119
3196
|
* security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
|
|
3120
3197
|
* when it makes API requests.</p>
|
|
3198
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html">Collecting data for threat protection in
|
|
3199
|
+
* applications</a>.</p>
|
|
3121
3200
|
* @public
|
|
3122
3201
|
*/
|
|
3123
3202
|
ContextData?: ContextDataType | undefined;
|
|
@@ -3129,28 +3208,28 @@ export interface AdminRespondToAuthChallengeRequest {
|
|
|
3129
3208
|
* that you have assigned to the following triggers: </p>
|
|
3130
3209
|
* <ul>
|
|
3131
3210
|
* <li>
|
|
3132
|
-
* <p>
|
|
3211
|
+
* <p>Pre sign-up</p>
|
|
3133
3212
|
* </li>
|
|
3134
3213
|
* <li>
|
|
3135
3214
|
* <p>custom message</p>
|
|
3136
3215
|
* </li>
|
|
3137
3216
|
* <li>
|
|
3138
|
-
* <p>
|
|
3217
|
+
* <p>Post authentication</p>
|
|
3139
3218
|
* </li>
|
|
3140
3219
|
* <li>
|
|
3141
|
-
* <p>
|
|
3220
|
+
* <p>User migration</p>
|
|
3142
3221
|
* </li>
|
|
3143
3222
|
* <li>
|
|
3144
|
-
* <p>
|
|
3223
|
+
* <p>Pre token generation</p>
|
|
3145
3224
|
* </li>
|
|
3146
3225
|
* <li>
|
|
3147
|
-
* <p>
|
|
3226
|
+
* <p>Define auth challenge</p>
|
|
3148
3227
|
* </li>
|
|
3149
3228
|
* <li>
|
|
3150
|
-
* <p>
|
|
3229
|
+
* <p>Create auth challenge</p>
|
|
3151
3230
|
* </li>
|
|
3152
3231
|
* <li>
|
|
3153
|
-
* <p>
|
|
3232
|
+
* <p>Verify auth challenge response</p>
|
|
3154
3233
|
* </li>
|
|
3155
3234
|
* </ul>
|
|
3156
3235
|
* <p>When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the
|
|
@@ -3162,21 +3241,21 @@ export interface AdminRespondToAuthChallengeRequest {
|
|
|
3162
3241
|
* <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">
|
|
3163
3242
|
* Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
3164
3243
|
* <note>
|
|
3165
|
-
* <p>When you use the ClientMetadata parameter,
|
|
3244
|
+
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
3166
3245
|
* following:</p>
|
|
3167
3246
|
* <ul>
|
|
3168
3247
|
* <li>
|
|
3169
|
-
* <p>Store the ClientMetadata value. This data is available only
|
|
3170
|
-
* triggers that are assigned to a user pool to support custom
|
|
3171
|
-
* your user pool configuration doesn't include triggers, the
|
|
3172
|
-
* parameter serves no purpose.</p>
|
|
3248
|
+
* <p>Store the <code>ClientMetadata</code> value. This data is available only
|
|
3249
|
+
* to Lambda triggers that are assigned to a user pool to support custom
|
|
3250
|
+
* workflows. If your user pool configuration doesn't include triggers, the
|
|
3251
|
+
* <code>ClientMetadata</code> parameter serves no purpose.</p>
|
|
3173
3252
|
* </li>
|
|
3174
3253
|
* <li>
|
|
3175
|
-
* <p>Validate the ClientMetadata value.</p>
|
|
3254
|
+
* <p>Validate the <code>ClientMetadata</code> value.</p>
|
|
3176
3255
|
* </li>
|
|
3177
3256
|
* <li>
|
|
3178
|
-
* <p>Encrypt the ClientMetadata value. Don't
|
|
3179
|
-
* information.</p>
|
|
3257
|
+
* <p>Encrypt the <code>ClientMetadata</code> value. Don't send sensitive
|
|
3258
|
+
* information in this parameter.</p>
|
|
3180
3259
|
* </li>
|
|
3181
3260
|
* </ul>
|
|
3182
3261
|
* </note>
|
|
@@ -3190,25 +3269,32 @@ export interface AdminRespondToAuthChallengeRequest {
|
|
|
3190
3269
|
*/
|
|
3191
3270
|
export interface AdminRespondToAuthChallengeResponse {
|
|
3192
3271
|
/**
|
|
3193
|
-
* <p>The name of the challenge
|
|
3272
|
+
* <p>The name of the challenge that you must next respond to. You can find more information
|
|
3273
|
+
* about values for <code>ChallengeName</code> in the response parameters of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html#CognitoUserPools-AdminInitiateAuth-response-ChallengeName">AdminInitiateAuth</a>.</p>
|
|
3194
3274
|
* @public
|
|
3195
3275
|
*/
|
|
3196
3276
|
ChallengeName?: ChallengeNameType | undefined;
|
|
3197
3277
|
/**
|
|
3198
|
-
* <p>The session that
|
|
3199
|
-
*
|
|
3200
|
-
*
|
|
3201
|
-
*
|
|
3278
|
+
* <p>The session identifier that maintains the state of authentication requests and
|
|
3279
|
+
* challenge responses. If an <code>AdminInitiateAuth</code> or
|
|
3280
|
+
* <code>AdminRespondToAuthChallenge</code> API request results in a determination that
|
|
3281
|
+
* your application must pass another challenge, Amazon Cognito returns a session with other
|
|
3282
|
+
* challenge parameters. Send this session identifier, unmodified, to the next
|
|
3283
|
+
* <code>AdminRespondToAuthChallenge</code> request.</p>
|
|
3202
3284
|
* @public
|
|
3203
3285
|
*/
|
|
3204
3286
|
Session?: string | undefined;
|
|
3205
3287
|
/**
|
|
3206
|
-
* <p>The
|
|
3288
|
+
* <p>The parameters that define your response to the next challenge. Take the values in
|
|
3289
|
+
* <code>ChallengeParameters</code> and provide values for them in the <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRespondToAuthChallenge.html#CognitoUserPools-AdminRespondToAuthChallenge-request-ChallengeResponses">ChallengeResponses</a> of the next <code>AdminRespondToAuthChallenge</code>
|
|
3290
|
+
* request.</p>
|
|
3207
3291
|
* @public
|
|
3208
3292
|
*/
|
|
3209
3293
|
ChallengeParameters?: Record<string, string> | undefined;
|
|
3210
3294
|
/**
|
|
3211
|
-
* <p>The
|
|
3295
|
+
* <p>The outcome of a successful authentication process. After your application has passed
|
|
3296
|
+
* all challenges, Amazon Cognito returns an <code>AuthenticationResult</code> with the JSON web
|
|
3297
|
+
* tokens (JWTs) that indicate successful sign-in.</p>
|
|
3212
3298
|
* @public
|
|
3213
3299
|
*/
|
|
3214
3300
|
AuthenticationResult?: AuthenticationResultType | undefined;
|
|
@@ -3381,7 +3467,7 @@ export interface AdminSetUserMFAPreferenceResponse {
|
|
|
3381
3467
|
*/
|
|
3382
3468
|
export interface AdminSetUserPasswordRequest {
|
|
3383
3469
|
/**
|
|
3384
|
-
* <p>The
|
|
3470
|
+
* <p>The ID of the user pool where you want to set the user's password.</p>
|
|
3385
3471
|
* @public
|
|
3386
3472
|
*/
|
|
3387
3473
|
UserPoolId: string | undefined;
|
|
@@ -3395,14 +3481,17 @@ export interface AdminSetUserPasswordRequest {
|
|
|
3395
3481
|
*/
|
|
3396
3482
|
Username: string | undefined;
|
|
3397
3483
|
/**
|
|
3398
|
-
* <p>The password for the user
|
|
3484
|
+
* <p>The new temporary or permanent password that you want to set for the user. You
|
|
3485
|
+
* can't remove the password for a user who already has a password so that they can
|
|
3486
|
+
* only sign in with passwordless methods. In this scenario, you must create a new user
|
|
3487
|
+
* without a password.</p>
|
|
3399
3488
|
* @public
|
|
3400
3489
|
*/
|
|
3401
3490
|
Password: string | undefined;
|
|
3402
3491
|
/**
|
|
3403
|
-
* <p>
|
|
3404
|
-
* <code>
|
|
3405
|
-
*
|
|
3492
|
+
* <p>Set to <code>true</code> to set a password that the user can immediately sign in with.
|
|
3493
|
+
* Set to <code>false</code> to set a temporary password that the user must change on their
|
|
3494
|
+
* next sign-in.</p>
|
|
3406
3495
|
* @public
|
|
3407
3496
|
*/
|
|
3408
3497
|
Permanent?: boolean | undefined;
|
|
@@ -3451,7 +3540,7 @@ export interface AdminSetUserSettingsResponse {
|
|
|
3451
3540
|
*/
|
|
3452
3541
|
export interface AdminUpdateAuthEventFeedbackRequest {
|
|
3453
3542
|
/**
|
|
3454
|
-
* <p>The user pool
|
|
3543
|
+
* <p>The ID of the user pool where you want to submit authentication-event feedback.</p>
|
|
3455
3544
|
* @public
|
|
3456
3545
|
*/
|
|
3457
3546
|
UserPoolId: string | undefined;
|
|
@@ -3465,7 +3554,7 @@ export interface AdminUpdateAuthEventFeedbackRequest {
|
|
|
3465
3554
|
*/
|
|
3466
3555
|
Username: string | undefined;
|
|
3467
3556
|
/**
|
|
3468
|
-
* <p>The authentication event ID
|
|
3557
|
+
* <p>The authentication event ID. To query authentication events for a user, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminListUserAuthEvents.html">AdminListUserAuthEvents</a>.</p>
|
|
3469
3558
|
* @public
|
|
3470
3559
|
*/
|
|
3471
3560
|
EventId: string | undefined;
|
|
@@ -3502,7 +3591,7 @@ export type DeviceRememberedStatusType = (typeof DeviceRememberedStatusType)[key
|
|
|
3502
3591
|
*/
|
|
3503
3592
|
export interface AdminUpdateDeviceStatusRequest {
|
|
3504
3593
|
/**
|
|
3505
|
-
* <p>The user pool
|
|
3594
|
+
* <p>The ID of the user pool where you want to change a user's device status.</p>
|
|
3506
3595
|
* @public
|
|
3507
3596
|
*/
|
|
3508
3597
|
UserPoolId: string | undefined;
|
|
@@ -3516,12 +3605,14 @@ export interface AdminUpdateDeviceStatusRequest {
|
|
|
3516
3605
|
*/
|
|
3517
3606
|
Username: string | undefined;
|
|
3518
3607
|
/**
|
|
3519
|
-
* <p>The device key
|
|
3608
|
+
* <p>The unique identifier, or device key, of the device that you want to update the status
|
|
3609
|
+
* for.</p>
|
|
3520
3610
|
* @public
|
|
3521
3611
|
*/
|
|
3522
3612
|
DeviceKey: string | undefined;
|
|
3523
3613
|
/**
|
|
3524
|
-
* <p>
|
|
3614
|
+
* <p>To enable device authentication with the specified device, set to
|
|
3615
|
+
* <code>remembered</code>.To disable, set to <code>not_remembered</code>.</p>
|
|
3525
3616
|
* @public
|
|
3526
3617
|
*/
|
|
3527
3618
|
DeviceRememberedStatus?: DeviceRememberedStatusType | undefined;
|
|
@@ -3538,7 +3629,7 @@ export interface AdminUpdateDeviceStatusResponse {
|
|
|
3538
3629
|
*/
|
|
3539
3630
|
export interface AdminUpdateUserAttributesRequest {
|
|
3540
3631
|
/**
|
|
3541
|
-
* <p>The
|
|
3632
|
+
* <p>The ID of the user pool where you want to update user attributes.</p>
|
|
3542
3633
|
* @public
|
|
3543
3634
|
*/
|
|
3544
3635
|
UserPoolId: string | undefined;
|
|
@@ -3584,21 +3675,21 @@ export interface AdminUpdateUserAttributesRequest {
|
|
|
3584
3675
|
* <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">
|
|
3585
3676
|
* Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
3586
3677
|
* <note>
|
|
3587
|
-
* <p>When you use the ClientMetadata parameter,
|
|
3678
|
+
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
3588
3679
|
* following:</p>
|
|
3589
3680
|
* <ul>
|
|
3590
3681
|
* <li>
|
|
3591
|
-
* <p>Store the ClientMetadata value. This data is available only
|
|
3592
|
-
* triggers that are assigned to a user pool to support custom
|
|
3593
|
-
* your user pool configuration doesn't include triggers, the
|
|
3594
|
-
* parameter serves no purpose.</p>
|
|
3682
|
+
* <p>Store the <code>ClientMetadata</code> value. This data is available only
|
|
3683
|
+
* to Lambda triggers that are assigned to a user pool to support custom
|
|
3684
|
+
* workflows. If your user pool configuration doesn't include triggers, the
|
|
3685
|
+
* <code>ClientMetadata</code> parameter serves no purpose.</p>
|
|
3595
3686
|
* </li>
|
|
3596
3687
|
* <li>
|
|
3597
|
-
* <p>Validate the ClientMetadata value.</p>
|
|
3688
|
+
* <p>Validate the <code>ClientMetadata</code> value.</p>
|
|
3598
3689
|
* </li>
|
|
3599
3690
|
* <li>
|
|
3600
|
-
* <p>Encrypt the ClientMetadata value. Don't
|
|
3601
|
-
* information.</p>
|
|
3691
|
+
* <p>Encrypt the <code>ClientMetadata</code> value. Don't send sensitive
|
|
3692
|
+
* information in this parameter.</p>
|
|
3602
3693
|
* </li>
|
|
3603
3694
|
* </ul>
|
|
3604
3695
|
* </note>
|
|
@@ -3619,7 +3710,7 @@ export interface AdminUpdateUserAttributesResponse {
|
|
|
3619
3710
|
*/
|
|
3620
3711
|
export interface AdminUserGlobalSignOutRequest {
|
|
3621
3712
|
/**
|
|
3622
|
-
* <p>The user pool
|
|
3713
|
+
* <p>The ID of the user pool where you want to sign out a user.</p>
|
|
3623
3714
|
* @public
|
|
3624
3715
|
*/
|
|
3625
3716
|
UserPoolId: string | undefined;
|
|
@@ -3846,13 +3937,15 @@ export interface AssetType {
|
|
|
3846
3937
|
export interface AssociateSoftwareTokenRequest {
|
|
3847
3938
|
/**
|
|
3848
3939
|
* <p>A valid access token that Amazon Cognito issued to the user whose software token you want to
|
|
3849
|
-
* generate.</p>
|
|
3940
|
+
* generate. You can provide either an access token or a session ID in the request.</p>
|
|
3850
3941
|
* @public
|
|
3851
3942
|
*/
|
|
3852
3943
|
AccessToken?: string | undefined;
|
|
3853
3944
|
/**
|
|
3854
|
-
* <p>The session that
|
|
3855
|
-
*
|
|
3945
|
+
* <p>The session identifier that maintains the state of authentication requests and
|
|
3946
|
+
* challenge responses. In <code>AssociateSoftwareToken</code>, this is the session ID from
|
|
3947
|
+
* a successful sign-in. You can provide either an access token or a session ID in the
|
|
3948
|
+
* request.</p>
|
|
3856
3949
|
* @public
|
|
3857
3950
|
*/
|
|
3858
3951
|
Session?: string | undefined;
|
|
@@ -3862,14 +3955,14 @@ export interface AssociateSoftwareTokenRequest {
|
|
|
3862
3955
|
*/
|
|
3863
3956
|
export interface AssociateSoftwareTokenResponse {
|
|
3864
3957
|
/**
|
|
3865
|
-
* <p>A unique generated shared secret code that is used
|
|
3958
|
+
* <p>A unique generated shared secret code that is used by the TOTP algorithm to generate a
|
|
3866
3959
|
* one-time code.</p>
|
|
3867
3960
|
* @public
|
|
3868
3961
|
*/
|
|
3869
3962
|
SecretCode?: string | undefined;
|
|
3870
3963
|
/**
|
|
3871
|
-
* <p>The session that
|
|
3872
|
-
*
|
|
3964
|
+
* <p>The session identifier that maintains the state of authentication requests and
|
|
3965
|
+
* challenge responses. This session ID is valid for the next request in this flow, <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifySoftwareToken.html">VerifySoftwareToken</a>.</p>
|
|
3873
3966
|
* @public
|
|
3874
3967
|
*/
|
|
3875
3968
|
Session?: string | undefined;
|
|
@@ -3925,7 +4018,7 @@ export interface ChangePasswordRequest {
|
|
|
3925
4018
|
*/
|
|
3926
4019
|
PreviousPassword?: string | undefined;
|
|
3927
4020
|
/**
|
|
3928
|
-
* <p>
|
|
4021
|
+
* <p>A new password that you prompted the user to enter in your application.</p>
|
|
3929
4022
|
* @public
|
|
3930
4023
|
*/
|
|
3931
4024
|
ProposedPassword: string | undefined;
|
|
@@ -3948,7 +4041,7 @@ export interface ChangePasswordResponse {
|
|
|
3948
4041
|
export interface CompleteWebAuthnRegistrationRequest {
|
|
3949
4042
|
/**
|
|
3950
4043
|
* <p>A valid access token that Amazon Cognito issued to the user whose passkey registration you want
|
|
3951
|
-
* to
|
|
4044
|
+
* to complete.</p>
|
|
3952
4045
|
* @public
|
|
3953
4046
|
*/
|
|
3954
4047
|
AccessToken: string | undefined;
|
|
@@ -4061,7 +4154,7 @@ export interface DeviceSecretVerifierConfigType {
|
|
|
4061
4154
|
Salt?: string | undefined;
|
|
4062
4155
|
}
|
|
4063
4156
|
/**
|
|
4064
|
-
* <p>
|
|
4157
|
+
* <p>The confirm-device request.</p>
|
|
4065
4158
|
* @public
|
|
4066
4159
|
*/
|
|
4067
4160
|
export interface ConfirmDeviceRequest {
|
|
@@ -4072,7 +4165,8 @@ export interface ConfirmDeviceRequest {
|
|
|
4072
4165
|
*/
|
|
4073
4166
|
AccessToken: string | undefined;
|
|
4074
4167
|
/**
|
|
4075
|
-
* <p>The device key
|
|
4168
|
+
* <p>The unique identifier, or device key, of the device that you want to update the status
|
|
4169
|
+
* for.</p>
|
|
4076
4170
|
* @public
|
|
4077
4171
|
*/
|
|
4078
4172
|
DeviceKey: string | undefined;
|
|
@@ -4082,18 +4176,27 @@ export interface ConfirmDeviceRequest {
|
|
|
4082
4176
|
*/
|
|
4083
4177
|
DeviceSecretVerifierConfig?: DeviceSecretVerifierConfigType | undefined;
|
|
4084
4178
|
/**
|
|
4085
|
-
* <p>
|
|
4179
|
+
* <p>A friendly name for the device, for example <code>MyMobilePhone</code>.</p>
|
|
4086
4180
|
* @public
|
|
4087
4181
|
*/
|
|
4088
4182
|
DeviceName?: string | undefined;
|
|
4089
4183
|
}
|
|
4090
4184
|
/**
|
|
4091
|
-
* <p>
|
|
4185
|
+
* <p>The confirm-device response.</p>
|
|
4092
4186
|
* @public
|
|
4093
4187
|
*/
|
|
4094
4188
|
export interface ConfirmDeviceResponse {
|
|
4095
4189
|
/**
|
|
4096
|
-
* <p>
|
|
4190
|
+
* <p>When <code>true</code>, your user must confirm that they want to remember the device.
|
|
4191
|
+
* Prompt the user for an answer. You must then make an <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html">UpdateUserDevice</a> request that sets the device to
|
|
4192
|
+
* <code>remembered</code> or <code>not_remembered</code>.</p>
|
|
4193
|
+
* <p>When <code>false</code>, immediately sets the device as remembered and eligible for
|
|
4194
|
+
* device authentication.</p>
|
|
4195
|
+
* <p>You can configure your user pool to always remember devices, in which case this
|
|
4196
|
+
* response is <code>false</code>, or to allow users to opt in, in which case this response
|
|
4197
|
+
* is <code>true</code>. Configure this option under <i>Device tracking</i>
|
|
4198
|
+
* in the <i>Sign-in</i> menu of your user pool. You can also configure this
|
|
4199
|
+
* option with the <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html#CognitoUserPools-CreateUserPool-request-DeviceConfiguration">DeviceConfiguration</a> parameter of a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a> or <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a> request.</p>
|
|
4097
4200
|
* @public
|
|
4098
4201
|
*/
|
|
4099
4202
|
UserConfirmationNecessary?: boolean | undefined;
|
|
@@ -4124,7 +4227,10 @@ export interface UserContextDataType {
|
|
|
4124
4227
|
*/
|
|
4125
4228
|
export interface ConfirmForgotPasswordRequest {
|
|
4126
4229
|
/**
|
|
4127
|
-
* <p>The
|
|
4230
|
+
* <p>The ID of the app client where the user wants to reset their password. This parameter
|
|
4231
|
+
* is an identifier of the client application that users are resetting their password from,
|
|
4232
|
+
* but this operation resets users' passwords for all app clients in the user
|
|
4233
|
+
* pool.</p>
|
|
4128
4234
|
* @public
|
|
4129
4235
|
*/
|
|
4130
4236
|
ClientId: string | undefined;
|
|
@@ -4145,8 +4251,7 @@ export interface ConfirmForgotPasswordRequest {
|
|
|
4145
4251
|
*/
|
|
4146
4252
|
Username: string | undefined;
|
|
4147
4253
|
/**
|
|
4148
|
-
* <p>The confirmation code
|
|
4149
|
-
* information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ForgotPassword.html">ForgotPassword</a>.</p>
|
|
4254
|
+
* <p>The confirmation code that your user pool sent in response to an <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminResetUserPassword.html">AdminResetUserPassword</a> or a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ForgotPassword.html">ForgotPassword</a> request.</p>
|
|
4150
4255
|
* @public
|
|
4151
4256
|
*/
|
|
4152
4257
|
ConfirmationCode: string | undefined;
|
|
@@ -4165,6 +4270,8 @@ export interface ConfirmForgotPasswordRequest {
|
|
|
4165
4270
|
* <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
|
|
4166
4271
|
* security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
|
|
4167
4272
|
* when it makes API requests.</p>
|
|
4273
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html">Collecting data for threat protection in
|
|
4274
|
+
* applications</a>.</p>
|
|
4168
4275
|
* @public
|
|
4169
4276
|
*/
|
|
4170
4277
|
UserContextData?: UserContextDataType | undefined;
|
|
@@ -4182,21 +4289,21 @@ export interface ConfirmForgotPasswordRequest {
|
|
|
4182
4289
|
* <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">
|
|
4183
4290
|
* Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
4184
4291
|
* <note>
|
|
4185
|
-
* <p>When you use the ClientMetadata parameter,
|
|
4292
|
+
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
4186
4293
|
* following:</p>
|
|
4187
4294
|
* <ul>
|
|
4188
4295
|
* <li>
|
|
4189
|
-
* <p>Store the ClientMetadata value. This data is available only
|
|
4190
|
-
* triggers that are assigned to a user pool to support custom
|
|
4191
|
-
* your user pool configuration doesn't include triggers, the
|
|
4192
|
-
* parameter serves no purpose.</p>
|
|
4296
|
+
* <p>Store the <code>ClientMetadata</code> value. This data is available only
|
|
4297
|
+
* to Lambda triggers that are assigned to a user pool to support custom
|
|
4298
|
+
* workflows. If your user pool configuration doesn't include triggers, the
|
|
4299
|
+
* <code>ClientMetadata</code> parameter serves no purpose.</p>
|
|
4193
4300
|
* </li>
|
|
4194
4301
|
* <li>
|
|
4195
|
-
* <p>Validate the ClientMetadata value.</p>
|
|
4302
|
+
* <p>Validate the <code>ClientMetadata</code> value.</p>
|
|
4196
4303
|
* </li>
|
|
4197
4304
|
* <li>
|
|
4198
|
-
* <p>Encrypt the ClientMetadata value. Don't
|
|
4199
|
-
* information.</p>
|
|
4305
|
+
* <p>Encrypt the <code>ClientMetadata</code> value. Don't send sensitive
|
|
4306
|
+
* information in this parameter.</p>
|
|
4200
4307
|
* </li>
|
|
4201
4308
|
* </ul>
|
|
4202
4309
|
* </note>
|
|
@@ -4223,7 +4330,8 @@ export interface ConfirmSignUpRequest {
|
|
|
4223
4330
|
ClientId: string | undefined;
|
|
4224
4331
|
/**
|
|
4225
4332
|
* <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a
|
|
4226
|
-
* user pool client and username plus the client ID in the message
|
|
4333
|
+
* user pool client and username plus the client ID in the message. For more information
|
|
4334
|
+
* about <code>SecretHash</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>.</p>
|
|
4227
4335
|
* @public
|
|
4228
4336
|
*/
|
|
4229
4337
|
SecretHash?: string | undefined;
|
|
@@ -4237,17 +4345,25 @@ export interface ConfirmSignUpRequest {
|
|
|
4237
4345
|
*/
|
|
4238
4346
|
Username: string | undefined;
|
|
4239
4347
|
/**
|
|
4240
|
-
* <p>The confirmation code
|
|
4348
|
+
* <p>The confirmation code that your user pool sent in response to the <code>SignUp</code>
|
|
4349
|
+
* request.</p>
|
|
4241
4350
|
* @public
|
|
4242
4351
|
*/
|
|
4243
4352
|
ConfirmationCode: string | undefined;
|
|
4244
4353
|
/**
|
|
4245
|
-
* <p>
|
|
4246
|
-
*
|
|
4247
|
-
*
|
|
4248
|
-
*
|
|
4249
|
-
*
|
|
4250
|
-
* <
|
|
4354
|
+
* <p>When <code>true</code>, forces user confirmation despite any existing aliases.
|
|
4355
|
+
* Defaults to <code>false</code>. A value of <code>true</code> migrates the alias from an
|
|
4356
|
+
* existing user to the new user if an existing user already has the phone number or email
|
|
4357
|
+
* address as an alias.</p>
|
|
4358
|
+
* <p>Say, for example, that an existing user has an <code>email</code> attribute of
|
|
4359
|
+
* <code>bob@example.com</code> and email is an alias in your user pool. If the new
|
|
4360
|
+
* user also has an email of <code>bob@example.com</code> and your
|
|
4361
|
+
* <code>ConfirmSignUp</code> response sets <code>ForceAliasCreation</code> to
|
|
4362
|
+
* <code>true</code>, the new user can sign in with a username of
|
|
4363
|
+
* <code>bob@example.com</code> and the existing user can no longer do so.</p>
|
|
4364
|
+
* <p>If <code>false</code> and an attribute belongs to an existing alias, this request
|
|
4365
|
+
* returns an <b>AliasExistsException</b> error.</p>
|
|
4366
|
+
* <p>For more information about sign-in aliases, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases">Customizing sign-in attributes</a>.</p>
|
|
4251
4367
|
* @public
|
|
4252
4368
|
*/
|
|
4253
4369
|
ForceAliasCreation?: boolean | undefined;
|
|
@@ -4261,6 +4377,8 @@ export interface ConfirmSignUpRequest {
|
|
|
4261
4377
|
* <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
|
|
4262
4378
|
* security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
|
|
4263
4379
|
* when it makes API requests.</p>
|
|
4380
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html">Collecting data for threat protection in
|
|
4381
|
+
* applications</a>.</p>
|
|
4264
4382
|
* @public
|
|
4265
4383
|
*/
|
|
4266
4384
|
UserContextData?: UserContextDataType | undefined;
|
|
@@ -4278,21 +4396,21 @@ export interface ConfirmSignUpRequest {
|
|
|
4278
4396
|
* <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">
|
|
4279
4397
|
* Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
4280
4398
|
* <note>
|
|
4281
|
-
* <p>When you use the ClientMetadata parameter,
|
|
4399
|
+
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
4282
4400
|
* following:</p>
|
|
4283
4401
|
* <ul>
|
|
4284
4402
|
* <li>
|
|
4285
|
-
* <p>Store the ClientMetadata value. This data is available only
|
|
4286
|
-
* triggers that are assigned to a user pool to support custom
|
|
4287
|
-
* your user pool configuration doesn't include triggers, the
|
|
4288
|
-
* parameter serves no purpose.</p>
|
|
4403
|
+
* <p>Store the <code>ClientMetadata</code> value. This data is available only
|
|
4404
|
+
* to Lambda triggers that are assigned to a user pool to support custom
|
|
4405
|
+
* workflows. If your user pool configuration doesn't include triggers, the
|
|
4406
|
+
* <code>ClientMetadata</code> parameter serves no purpose.</p>
|
|
4289
4407
|
* </li>
|
|
4290
4408
|
* <li>
|
|
4291
|
-
* <p>Validate the ClientMetadata value.</p>
|
|
4409
|
+
* <p>Validate the <code>ClientMetadata</code> value.</p>
|
|
4292
4410
|
* </li>
|
|
4293
4411
|
* <li>
|
|
4294
|
-
* <p>Encrypt the ClientMetadata value. Don't
|
|
4295
|
-
* information.</p>
|
|
4412
|
+
* <p>Encrypt the <code>ClientMetadata</code> value. Don't send sensitive
|
|
4413
|
+
* information in this parameter.</p>
|
|
4296
4414
|
* </li>
|
|
4297
4415
|
* </ul>
|
|
4298
4416
|
* </note>
|
|
@@ -4313,10 +4431,10 @@ export interface ConfirmSignUpRequest {
|
|
|
4313
4431
|
*/
|
|
4314
4432
|
export interface ConfirmSignUpResponse {
|
|
4315
4433
|
/**
|
|
4316
|
-
* <p>
|
|
4434
|
+
* <p>A session identifier that you can use to immediately sign in the confirmed user. You
|
|
4435
|
+
* can automatically sign users in with the one-time password that they provided in a
|
|
4317
4436
|
* successful <code>ConfirmSignUp</code> request. To do this, pass the <code>Session</code>
|
|
4318
|
-
* parameter from the <code>
|
|
4319
|
-
* parameter of an <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a> or <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html">AdminInitiateAuth</a> request.</p>
|
|
4437
|
+
* parameter from this response in the <code>Session</code> parameter of an <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a> or <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html">AdminInitiateAuth</a> request.</p>
|
|
4320
4438
|
* @public
|
|
4321
4439
|
*/
|
|
4322
4440
|
Session?: string | undefined;
|
|
@@ -4326,22 +4444,27 @@ export interface ConfirmSignUpResponse {
|
|
|
4326
4444
|
*/
|
|
4327
4445
|
export interface CreateGroupRequest {
|
|
4328
4446
|
/**
|
|
4329
|
-
* <p>
|
|
4447
|
+
* <p>A name for the group. This name must be unique in your user pool.</p>
|
|
4330
4448
|
* @public
|
|
4331
4449
|
*/
|
|
4332
4450
|
GroupName: string | undefined;
|
|
4333
4451
|
/**
|
|
4334
|
-
* <p>The user pool
|
|
4452
|
+
* <p>The ID of the user pool where you want to create a user group.</p>
|
|
4335
4453
|
* @public
|
|
4336
4454
|
*/
|
|
4337
4455
|
UserPoolId: string | undefined;
|
|
4338
4456
|
/**
|
|
4339
|
-
* <p>A
|
|
4457
|
+
* <p>A description of the group that you're creating.</p>
|
|
4340
4458
|
* @public
|
|
4341
4459
|
*/
|
|
4342
4460
|
Description?: string | undefined;
|
|
4343
4461
|
/**
|
|
4344
|
-
* <p>The
|
|
4462
|
+
* <p>The Amazon Resource Name (ARN) for the IAM role that you want to associate with the
|
|
4463
|
+
* group. A group role primarily declares a preferred role for the credentials that you get
|
|
4464
|
+
* from an identity pool. Amazon Cognito ID tokens have a <code>cognito:preferred_role</code> claim
|
|
4465
|
+
* that presents the highest-precedence group that a user belongs to. Both ID and access
|
|
4466
|
+
* tokens also contain a <code>cognito:groups</code> claim that list all the groups that a
|
|
4467
|
+
* user is a member of.</p>
|
|
4345
4468
|
* @public
|
|
4346
4469
|
*/
|
|
4347
4470
|
RoleArn?: string | undefined;
|
|
@@ -4370,7 +4493,7 @@ export interface CreateGroupRequest {
|
|
|
4370
4493
|
*/
|
|
4371
4494
|
export interface CreateGroupResponse {
|
|
4372
4495
|
/**
|
|
4373
|
-
* <p>The
|
|
4496
|
+
* <p>The response object for a created group.</p>
|
|
4374
4497
|
* @public
|
|
4375
4498
|
*/
|
|
4376
4499
|
Group?: GroupType | undefined;
|
|
@@ -4409,17 +4532,20 @@ export type IdentityProviderTypeType = (typeof IdentityProviderTypeType)[keyof t
|
|
|
4409
4532
|
*/
|
|
4410
4533
|
export interface CreateIdentityProviderRequest {
|
|
4411
4534
|
/**
|
|
4412
|
-
* <p>The user pool
|
|
4535
|
+
* <p>The Id of the user pool where you want to create an IdP.</p>
|
|
4413
4536
|
* @public
|
|
4414
4537
|
*/
|
|
4415
4538
|
UserPoolId: string | undefined;
|
|
4416
4539
|
/**
|
|
4417
|
-
* <p>The IdP name
|
|
4540
|
+
* <p>The name that you want to assign to the IdP. You can pass the identity provider name
|
|
4541
|
+
* in the <code>identity_provider</code> query parameter of requests to the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html">Authorize endpoint</a> to silently redirect to sign-in with the associated
|
|
4542
|
+
* IdP.</p>
|
|
4418
4543
|
* @public
|
|
4419
4544
|
*/
|
|
4420
4545
|
ProviderName: string | undefined;
|
|
4421
4546
|
/**
|
|
4422
|
-
* <p>The IdP
|
|
4547
|
+
* <p>The type of IdP that you want to add. Amazon Cognito supports OIDC, SAML 2.0, Login With
|
|
4548
|
+
* Amazon, Sign In With Apple, Google, and Facebook IdPs.</p>
|
|
4423
4549
|
* @public
|
|
4424
4550
|
*/
|
|
4425
4551
|
ProviderType: IdentityProviderTypeType | undefined;
|
|
@@ -4547,12 +4673,17 @@ export interface CreateIdentityProviderRequest {
|
|
|
4547
4673
|
*/
|
|
4548
4674
|
ProviderDetails: Record<string, string> | undefined;
|
|
4549
4675
|
/**
|
|
4550
|
-
* <p>A mapping of IdP attributes to standard and custom user pool attributes
|
|
4676
|
+
* <p>A mapping of IdP attributes to standard and custom user pool attributes. Specify a
|
|
4677
|
+
* user pool attribute as the key of the key-value pair, and the IdP attribute claim name
|
|
4678
|
+
* as the value.</p>
|
|
4551
4679
|
* @public
|
|
4552
4680
|
*/
|
|
4553
4681
|
AttributeMapping?: Record<string, string> | undefined;
|
|
4554
4682
|
/**
|
|
4555
|
-
* <p>
|
|
4683
|
+
* <p>An array of IdP identifiers, for example <code>"IdPIdentifiers": [ "MyIdP", "MyIdP2"
|
|
4684
|
+
* ]</code>. Identifiers are friendly names that you can pass in the
|
|
4685
|
+
* <code>idp_identifier</code> query parameter of requests to the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html">Authorize endpoint</a> to silently redirect to sign-in with the associated IdP.
|
|
4686
|
+
* Identifiers in a domain format also enable the use of <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html">email-address matching with SAML providers</a>. </p>
|
|
4556
4687
|
* @public
|
|
4557
4688
|
*/
|
|
4558
4689
|
IdpIdentifiers?: string[] | undefined;
|
|
@@ -4735,7 +4866,7 @@ export interface IdentityProviderType {
|
|
|
4735
4866
|
*/
|
|
4736
4867
|
export interface CreateIdentityProviderResponse {
|
|
4737
4868
|
/**
|
|
4738
|
-
* <p>The
|
|
4869
|
+
* <p>The details of the new user pool IdP.</p>
|
|
4739
4870
|
* @public
|
|
4740
4871
|
*/
|
|
4741
4872
|
IdentityProvider: IdentityProviderType | undefined;
|
|
@@ -4770,9 +4901,8 @@ export interface CreateManagedLoginBrandingRequest {
|
|
|
4770
4901
|
*/
|
|
4771
4902
|
ClientId: string | undefined;
|
|
4772
4903
|
/**
|
|
4773
|
-
* <p>When true, applies the default branding style options.
|
|
4774
|
-
*
|
|
4775
|
-
* designer.</p>
|
|
4904
|
+
* <p>When true, applies the default branding style options. These default options are
|
|
4905
|
+
* managed by Amazon Cognito. You can modify them later in the branding designer.</p>
|
|
4776
4906
|
* <p>When you specify <code>true</code> for this option, you must also omit values for
|
|
4777
4907
|
* <code>Settings</code> and <code>Assets</code> in the request.</p>
|
|
4778
4908
|
* @public
|
|
@@ -4809,8 +4939,11 @@ export interface ManagedLoginBrandingType {
|
|
|
4809
4939
|
*/
|
|
4810
4940
|
UserPoolId?: string | undefined;
|
|
4811
4941
|
/**
|
|
4812
|
-
* <p>When true, applies the default branding style options. This option reverts to
|
|
4813
|
-
*
|
|
4942
|
+
* <p>When true, applies the default branding style options. This option reverts to default
|
|
4943
|
+
* style options that are managed by Amazon Cognito. You can modify them later in the branding
|
|
4944
|
+
* designer.</p>
|
|
4945
|
+
* <p>When you specify <code>true</code> for this option, you must also omit values for
|
|
4946
|
+
* <code>Settings</code> and <code>Assets</code> in the request.</p>
|
|
4814
4947
|
* @public
|
|
4815
4948
|
*/
|
|
4816
4949
|
UseCognitoProvidedValues?: boolean | undefined;
|
|
@@ -4891,7 +5024,7 @@ export interface ResourceServerScopeType {
|
|
|
4891
5024
|
*/
|
|
4892
5025
|
export interface CreateResourceServerRequest {
|
|
4893
5026
|
/**
|
|
4894
|
-
* <p>The user pool
|
|
5027
|
+
* <p>The ID of the user pool where you want to create a resource server.</p>
|
|
4895
5028
|
* @public
|
|
4896
5029
|
*/
|
|
4897
5030
|
UserPoolId: string | undefined;
|
|
@@ -4911,8 +5044,10 @@ export interface CreateResourceServerRequest {
|
|
|
4911
5044
|
*/
|
|
4912
5045
|
Name: string | undefined;
|
|
4913
5046
|
/**
|
|
4914
|
-
* <p>A list of scopes. Each scope is a key-value map with the keys
|
|
4915
|
-
* <code>
|
|
5047
|
+
* <p>A list of custom scopes. Each scope is a key-value map with the keys
|
|
5048
|
+
* <code>ScopeName</code> and <code>ScopeDescription</code>. The name of a custom scope
|
|
5049
|
+
* is a combination of <code>ScopeName</code> and the resource server <code>Name</code> in
|
|
5050
|
+
* this request, for example <code>MyResourceServerName/MyScopeName</code>.</p>
|
|
4916
5051
|
* @public
|
|
4917
5052
|
*/
|
|
4918
5053
|
Scopes?: ResourceServerScopeType[] | undefined;
|
|
@@ -4955,7 +5090,7 @@ export interface ResourceServerType {
|
|
|
4955
5090
|
*/
|
|
4956
5091
|
export interface CreateResourceServerResponse {
|
|
4957
5092
|
/**
|
|
4958
|
-
* <p>The
|
|
5093
|
+
* <p>The details of the new resource server.</p>
|
|
4959
5094
|
* @public
|
|
4960
5095
|
*/
|
|
4961
5096
|
ResourceServer: ResourceServerType | undefined;
|
|
@@ -4966,17 +5101,18 @@ export interface CreateResourceServerResponse {
|
|
|
4966
5101
|
*/
|
|
4967
5102
|
export interface CreateUserImportJobRequest {
|
|
4968
5103
|
/**
|
|
4969
|
-
* <p>
|
|
5104
|
+
* <p>A friendly name for the user import job.</p>
|
|
4970
5105
|
* @public
|
|
4971
5106
|
*/
|
|
4972
5107
|
JobName: string | undefined;
|
|
4973
5108
|
/**
|
|
4974
|
-
* <p>The
|
|
5109
|
+
* <p>The ID of the user pool that you want to import users into.</p>
|
|
4975
5110
|
* @public
|
|
4976
5111
|
*/
|
|
4977
5112
|
UserPoolId: string | undefined;
|
|
4978
5113
|
/**
|
|
4979
|
-
* <p>
|
|
5114
|
+
* <p>You must specify an IAM role that has permission to log import-job results to
|
|
5115
|
+
* Amazon CloudWatch Logs. This parameter is the ARN of that role.</p>
|
|
4980
5116
|
* @public
|
|
4981
5117
|
*/
|
|
4982
5118
|
CloudWatchLogsRoleArn: string | undefined;
|
|
@@ -5122,7 +5258,7 @@ export interface UserImportJobType {
|
|
|
5122
5258
|
*/
|
|
5123
5259
|
export interface CreateUserImportJobResponse {
|
|
5124
5260
|
/**
|
|
5125
|
-
* <p>The
|
|
5261
|
+
* <p>The details of the user import job.</p>
|
|
5126
5262
|
* @public
|
|
5127
5263
|
*/
|
|
5128
5264
|
UserImportJob?: UserImportJobType | undefined;
|
|
@@ -5842,12 +5978,14 @@ export interface VerificationMessageTemplateType {
|
|
|
5842
5978
|
*/
|
|
5843
5979
|
export interface CreateUserPoolRequest {
|
|
5844
5980
|
/**
|
|
5845
|
-
* <p>A
|
|
5981
|
+
* <p>A friendlhy name for your user pool.</p>
|
|
5846
5982
|
* @public
|
|
5847
5983
|
*/
|
|
5848
5984
|
PoolName: string | undefined;
|
|
5849
5985
|
/**
|
|
5850
|
-
* <p>The
|
|
5986
|
+
* <p>The password policy and sign-in policy in the user pool. The password policy sets
|
|
5987
|
+
* options like password complexity requirements and password history. The sign-in policy
|
|
5988
|
+
* sets the options available to applications in <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-selection-sdk.html#authentication-flows-selection-choice">choice-based authentication</a>.</p>
|
|
5851
5989
|
* @public
|
|
5852
5990
|
*/
|
|
5853
5991
|
Policies?: UserPoolPolicyType | undefined;
|
|
@@ -5870,19 +6008,21 @@ export interface CreateUserPoolRequest {
|
|
|
5870
6008
|
*/
|
|
5871
6009
|
LambdaConfig?: LambdaConfigType | undefined;
|
|
5872
6010
|
/**
|
|
5873
|
-
* <p>The attributes to
|
|
6011
|
+
* <p>The attributes that you want your user pool to automatically verify. Possible values:
|
|
6012
|
+
* <b>email</b>, <b>phone_number</b>. For more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves">Verifying contact information at sign-up</a>.</p>
|
|
5874
6013
|
* @public
|
|
5875
6014
|
*/
|
|
5876
6015
|
AutoVerifiedAttributes?: VerifiedAttributeType[] | undefined;
|
|
5877
6016
|
/**
|
|
5878
6017
|
* <p>Attributes supported as an alias for this user pool. Possible values: <b>phone_number</b>, <b>email</b>, or
|
|
5879
|
-
* <b>preferred_username</b
|
|
6018
|
+
* <b>preferred_username</b>. For more information about
|
|
6019
|
+
* alias attributes, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases">Customizing sign-in attributes</a>.</p>
|
|
5880
6020
|
* @public
|
|
5881
6021
|
*/
|
|
5882
6022
|
AliasAttributes?: AliasAttributeType[] | undefined;
|
|
5883
6023
|
/**
|
|
5884
6024
|
* <p>Specifies whether a user can use an email address or phone number as a username when
|
|
5885
|
-
* they sign up
|
|
6025
|
+
* they sign up. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases">Customizing sign-in attributes</a>.</p>
|
|
5886
6026
|
* @public
|
|
5887
6027
|
*/
|
|
5888
6028
|
UsernameAttributes?: UsernameAttributeType[] | undefined;
|
|
@@ -5919,7 +6059,11 @@ export interface CreateUserPoolRequest {
|
|
|
5919
6059
|
*/
|
|
5920
6060
|
SmsAuthenticationMessage?: string | undefined;
|
|
5921
6061
|
/**
|
|
5922
|
-
* <p>
|
|
6062
|
+
* <p>Sets multi-factor authentication (MFA) to be on, off, or optional. When
|
|
6063
|
+
* <code>ON</code>, all users must set up MFA before they can sign in. When
|
|
6064
|
+
* <code>OPTIONAL</code>, your application must make a client-side determination of
|
|
6065
|
+
* whether a user wants to register an MFA device. For user pools with adaptive
|
|
6066
|
+
* authentication with threat protection, choose <code>OPTIONAL</code>.</p>
|
|
5923
6067
|
* @public
|
|
5924
6068
|
*/
|
|
5925
6069
|
MfaConfiguration?: UserPoolMfaType | undefined;
|
|
@@ -5932,11 +6076,14 @@ export interface CreateUserPoolRequest {
|
|
|
5932
6076
|
*/
|
|
5933
6077
|
UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType | undefined;
|
|
5934
6078
|
/**
|
|
5935
|
-
* <p>The device-remembering configuration for a user pool.
|
|
5936
|
-
*
|
|
6079
|
+
* <p>The device-remembering configuration for a user pool. Device remembering or device
|
|
6080
|
+
* tracking is a "Remember me on this device" option for user pools that perform
|
|
6081
|
+
* authentication with the device key of a trusted device in the back end, instead of a
|
|
6082
|
+
* user-provided MFA code. For more information about device authentication, 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>. A null value indicates that
|
|
6083
|
+
* you have deactivated device remembering in your user pool.</p>
|
|
5937
6084
|
* <note>
|
|
5938
6085
|
* <p>When you provide a value for any <code>DeviceConfiguration</code> field, you
|
|
5939
|
-
* activate the Amazon Cognito device-remembering feature
|
|
6086
|
+
* activate the Amazon Cognito device-remembering feature. For more infor</p>
|
|
5940
6087
|
* </note>
|
|
5941
6088
|
* @public
|
|
5942
6089
|
*/
|
|
@@ -5952,7 +6099,7 @@ export interface CreateUserPoolRequest {
|
|
|
5952
6099
|
* <p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an
|
|
5953
6100
|
* SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages
|
|
5954
6101
|
* with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management
|
|
5955
|
-
* (IAM) role in your Amazon Web Services account
|
|
6102
|
+
* (IAM) role in your Amazon Web Services account. For more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html">SMS message settings</a>.</p>
|
|
5956
6103
|
* @public
|
|
5957
6104
|
*/
|
|
5958
6105
|
SmsConfiguration?: SmsConfigurationType | undefined;
|
|
@@ -5964,13 +6111,16 @@ export interface CreateUserPoolRequest {
|
|
|
5964
6111
|
*/
|
|
5965
6112
|
UserPoolTags?: Record<string, string> | undefined;
|
|
5966
6113
|
/**
|
|
5967
|
-
* <p>The configuration for <
|
|
6114
|
+
* <p>The configuration for <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminCreateUser.html">AdminCreateUser</a> requests. Includes the template for the
|
|
6115
|
+
* invitation message for new users, the duration of temporary passwords, and permitting
|
|
6116
|
+
* self-service sign-up.</p>
|
|
5968
6117
|
* @public
|
|
5969
6118
|
*/
|
|
5970
6119
|
AdminCreateUserConfig?: AdminCreateUserConfigType | undefined;
|
|
5971
6120
|
/**
|
|
5972
|
-
* <p>An array of
|
|
5973
|
-
*
|
|
6121
|
+
* <p>An array of attributes for the new user pool. You can add custom attributes and modify
|
|
6122
|
+
* the properties of default attributes. The specifications in this parameter set the
|
|
6123
|
+
* required attributes in your user pool. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html">Working with user attributes</a>.</p>
|
|
5974
6124
|
* @public
|
|
5975
6125
|
*/
|
|
5976
6126
|
Schema?: SchemaAttributeType[] | undefined;
|
|
@@ -5984,16 +6134,18 @@ export interface CreateUserPoolRequest {
|
|
|
5984
6134
|
*/
|
|
5985
6135
|
UserPoolAddOns?: UserPoolAddOnsType | undefined;
|
|
5986
6136
|
/**
|
|
5987
|
-
* <p>
|
|
5988
|
-
*
|
|
5989
|
-
* combination of capital and lowercase letters. For example,
|
|
5990
|
-
* <code>USERNAME</code>, or <code>UserName</code>, or for
|
|
5991
|
-
*
|
|
5992
|
-
* cases, set case sensitivity to <code>
|
|
5993
|
-
*
|
|
5994
|
-
*
|
|
5995
|
-
*
|
|
5996
|
-
* <p>
|
|
6137
|
+
* <p>Sets the case sensitivity option for sign-in usernames. When
|
|
6138
|
+
* <code>CaseSensitive</code> is <code>false</code> (case insensitive), users can sign
|
|
6139
|
+
* in with any combination of capital and lowercase letters. For example,
|
|
6140
|
+
* <code>username</code>, <code>USERNAME</code>, or <code>UserName</code>, or for
|
|
6141
|
+
* email, <code>email@example.com</code> or <code>EMaiL@eXamplE.Com</code>. For most use
|
|
6142
|
+
* cases, set case sensitivity to <code>false</code> as a best practice. When usernames and
|
|
6143
|
+
* email addresses are case insensitive, Amazon Cognito treats any variation in case as the same
|
|
6144
|
+
* user, and prevents a case variation from being assigned to the same attribute for a
|
|
6145
|
+
* different user.</p>
|
|
6146
|
+
* <p>When <code>CaseSensitive</code> is <code>true</code> (case sensitive), Amazon Cognito
|
|
6147
|
+
* interprets <code>USERNAME</code> and <code>UserName</code> as distinct users.</p>
|
|
6148
|
+
* <p>This configuration is immutable after you set it.</p>
|
|
5997
6149
|
* @public
|
|
5998
6150
|
*/
|
|
5999
6151
|
UsernameConfiguration?: UsernameConfigurationType | undefined;
|
|
@@ -6307,7 +6459,7 @@ export interface UserPoolType {
|
|
|
6307
6459
|
*/
|
|
6308
6460
|
export interface CreateUserPoolResponse {
|
|
6309
6461
|
/**
|
|
6310
|
-
* <p>
|
|
6462
|
+
* <p>The details of the created user pool.</p>
|
|
6311
6463
|
* @public
|
|
6312
6464
|
*/
|
|
6313
6465
|
UserPool?: UserPoolType | undefined;
|
|
@@ -6448,18 +6600,19 @@ export interface TokenValidityUnitsType {
|
|
|
6448
6600
|
*/
|
|
6449
6601
|
export interface CreateUserPoolClientRequest {
|
|
6450
6602
|
/**
|
|
6451
|
-
* <p>The
|
|
6603
|
+
* <p>The ID of the user pool where you want to create an app client.</p>
|
|
6452
6604
|
* @public
|
|
6453
6605
|
*/
|
|
6454
6606
|
UserPoolId: string | undefined;
|
|
6455
6607
|
/**
|
|
6456
|
-
* <p>
|
|
6608
|
+
* <p>A friendly name for the app client that you want to create.</p>
|
|
6457
6609
|
* @public
|
|
6458
6610
|
*/
|
|
6459
6611
|
ClientName: string | undefined;
|
|
6460
6612
|
/**
|
|
6461
|
-
* <p>
|
|
6462
|
-
*
|
|
6613
|
+
* <p>When <code>true</code>, generates a client secret for the app client. Client secrets
|
|
6614
|
+
* are used with server-side and machine-to-machine applications. For more information, see
|
|
6615
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#user-pool-settings-client-app-client-types">App client types</a>.</p>
|
|
6463
6616
|
* @public
|
|
6464
6617
|
*/
|
|
6465
6618
|
GenerateSecret?: boolean | undefined;
|
|
@@ -6511,8 +6664,8 @@ export interface CreateUserPoolClientRequest {
|
|
|
6511
6664
|
*/
|
|
6512
6665
|
IdTokenValidity?: number | undefined;
|
|
6513
6666
|
/**
|
|
6514
|
-
* <p>The units
|
|
6515
|
-
*
|
|
6667
|
+
* <p>The units that validity times are represented in. The default unit for refresh tokens
|
|
6668
|
+
* is days, and the default for ID and access tokens are hours.</p>
|
|
6516
6669
|
* @public
|
|
6517
6670
|
*/
|
|
6518
6671
|
TokenValidityUnits?: TokenValidityUnitsType | undefined;
|
|
@@ -6617,8 +6770,8 @@ export interface CreateUserPoolClientRequest {
|
|
|
6617
6770
|
* <code>Google</code>, <code>SignInWithApple</code>, and <code>LoginWithAmazon</code>.
|
|
6618
6771
|
* You can also specify the names that you configured for the SAML and OIDC IdPs in your
|
|
6619
6772
|
* user pool, for example <code>MySAMLIdP</code> or <code>MyOIDCIdP</code>.</p>
|
|
6620
|
-
* <p>This setting applies to providers that you can access with
|
|
6621
|
-
*
|
|
6773
|
+
* <p>This setting applies to providers that you can access with <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html">managed
|
|
6774
|
+
* login</a>. The removal of <code>COGNITO</code>
|
|
6622
6775
|
* from this list doesn't prevent authentication operations for local users with the
|
|
6623
6776
|
* user pools API in an Amazon Web Services SDK. The only way to prevent API-based authentication is to
|
|
6624
6777
|
* block access with a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html">WAF rule</a>.</p>
|
|
@@ -6633,7 +6786,9 @@ export interface CreateUserPoolClientRequest {
|
|
|
6633
6786
|
* <p>Be an absolute URI.</p>
|
|
6634
6787
|
* </li>
|
|
6635
6788
|
* <li>
|
|
6636
|
-
* <p>Be registered with the authorization server
|
|
6789
|
+
* <p>Be registered with the authorization server. Amazon Cognito doesn't accept
|
|
6790
|
+
* authorization requests with <code>redirect_uri</code> values that aren't in
|
|
6791
|
+
* the list of <code>CallbackURLs</code> that you provide in this parameter.</p>
|
|
6637
6792
|
* </li>
|
|
6638
6793
|
* <li>
|
|
6639
6794
|
* <p>Not include a fragment component.</p>
|
|
@@ -6648,7 +6803,8 @@ export interface CreateUserPoolClientRequest {
|
|
|
6648
6803
|
*/
|
|
6649
6804
|
CallbackURLs?: string[] | undefined;
|
|
6650
6805
|
/**
|
|
6651
|
-
* <p>A list of allowed logout URLs for
|
|
6806
|
+
* <p>A list of allowed logout URLs for managed login authentication. For more information,
|
|
6807
|
+
* see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html">Logout endpoint</a>.</p>
|
|
6652
6808
|
* @public
|
|
6653
6809
|
*/
|
|
6654
6810
|
LogoutURLs?: string[] | undefined;
|
|
@@ -6656,22 +6812,6 @@ export interface CreateUserPoolClientRequest {
|
|
|
6656
6812
|
* <p>The default redirect URI. In app clients with one assigned IdP, replaces
|
|
6657
6813
|
* <code>redirect_uri</code> in authentication requests. Must be in the
|
|
6658
6814
|
* <code>CallbackURLs</code> list.</p>
|
|
6659
|
-
* <p>A redirect URI must:</p>
|
|
6660
|
-
* <ul>
|
|
6661
|
-
* <li>
|
|
6662
|
-
* <p>Be an absolute URI.</p>
|
|
6663
|
-
* </li>
|
|
6664
|
-
* <li>
|
|
6665
|
-
* <p>Be registered with the authorization server.</p>
|
|
6666
|
-
* </li>
|
|
6667
|
-
* <li>
|
|
6668
|
-
* <p>Not include a fragment component.</p>
|
|
6669
|
-
* </li>
|
|
6670
|
-
* </ul>
|
|
6671
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about">Default redirect URI</a>.</p>
|
|
6672
|
-
* <p>Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes
|
|
6673
|
-
* only.</p>
|
|
6674
|
-
* <p>App callback URLs such as myapp://example are also supported.</p>
|
|
6675
6815
|
* @public
|
|
6676
6816
|
*/
|
|
6677
6817
|
DefaultRedirectURI?: string | undefined;
|
|
@@ -6702,10 +6842,13 @@ export interface CreateUserPoolClientRequest {
|
|
|
6702
6842
|
*/
|
|
6703
6843
|
AllowedOAuthFlows?: OAuthFlowType[] | undefined;
|
|
6704
6844
|
/**
|
|
6705
|
-
* <p>The
|
|
6706
|
-
*
|
|
6707
|
-
*
|
|
6708
|
-
*
|
|
6845
|
+
* <p>The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes
|
|
6846
|
+
* govern access control to user pool self-service API operations, user data from the
|
|
6847
|
+
* <code>userInfo</code> endpoint, and third-party APIs. Possible values provided by
|
|
6848
|
+
* OAuth are <code>phone</code>, <code>email</code>, <code>openid</code>, and
|
|
6849
|
+
* <code>profile</code>. Possible values provided by Amazon Web Services are
|
|
6850
|
+
* <code>aws.cognito.signin.user.admin</code>. Custom scopes created in Resource
|
|
6851
|
+
* Servers are also supported.</p>
|
|
6709
6852
|
* @public
|
|
6710
6853
|
*/
|
|
6711
6854
|
AllowedOAuthScopes?: string[] | undefined;
|
|
@@ -6743,12 +6886,9 @@ export interface CreateUserPoolClientRequest {
|
|
|
6743
6886
|
/**
|
|
6744
6887
|
* <p>The user pool analytics configuration for collecting metrics and sending them to your
|
|
6745
6888
|
* Amazon Pinpoint campaign.</p>
|
|
6746
|
-
* <
|
|
6747
|
-
*
|
|
6748
|
-
*
|
|
6749
|
-
* available, user pools support sending events to Amazon Pinpoint projects within that same
|
|
6750
|
-
* Region.</p>
|
|
6751
|
-
* </note>
|
|
6889
|
+
* <p>In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools might not have access to
|
|
6890
|
+
* analytics or might be configurable with campaigns in the US East (N. Virginia) Region.
|
|
6891
|
+
* For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html">Using Amazon Pinpoint analytics</a>.</p>
|
|
6752
6892
|
* @public
|
|
6753
6893
|
*/
|
|
6754
6894
|
AnalyticsConfiguration?: AnalyticsConfigurationType | undefined;
|
|
@@ -6997,8 +7137,8 @@ export interface UserPoolClientType {
|
|
|
6997
7137
|
* <code>Google</code>, <code>SignInWithApple</code>, and <code>LoginWithAmazon</code>.
|
|
6998
7138
|
* You can also specify the names that you configured for the SAML and OIDC IdPs in your
|
|
6999
7139
|
* user pool, for example <code>MySAMLIdP</code> or <code>MyOIDCIdP</code>.</p>
|
|
7000
|
-
* <p>This setting applies to providers that you can access with
|
|
7001
|
-
*
|
|
7140
|
+
* <p>This setting applies to providers that you can access with <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html">managed
|
|
7141
|
+
* login</a>. The removal of <code>COGNITO</code>
|
|
7002
7142
|
* from this list doesn't prevent authentication operations for local users with the
|
|
7003
7143
|
* user pools API in an Amazon Web Services SDK. The only way to prevent API-based authentication is to
|
|
7004
7144
|
* block access with a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html">WAF rule</a>.</p>
|
|
@@ -7196,7 +7336,7 @@ export interface UserPoolClientType {
|
|
|
7196
7336
|
*/
|
|
7197
7337
|
export interface CreateUserPoolClientResponse {
|
|
7198
7338
|
/**
|
|
7199
|
-
* <p>The
|
|
7339
|
+
* <p>The details of the new app client.</p>
|
|
7200
7340
|
* @public
|
|
7201
7341
|
*/
|
|
7202
7342
|
UserPoolClient?: UserPoolClientType | undefined;
|
|
@@ -7244,8 +7384,10 @@ export interface CustomDomainConfigType {
|
|
|
7244
7384
|
export interface CreateUserPoolDomainRequest {
|
|
7245
7385
|
/**
|
|
7246
7386
|
* <p>The domain string. For custom domains, this is the fully-qualified domain name, such
|
|
7247
|
-
* as <code>auth.example.com</code>. For
|
|
7248
|
-
*
|
|
7387
|
+
* as <code>auth.example.com</code>. For prefix domains, this is the prefix alone, such as
|
|
7388
|
+
* <code>myprefix</code>. A prefix value of <code>myprefix</code> for a user pool in
|
|
7389
|
+
* the us-east-1 Region results in a domain of
|
|
7390
|
+
* <code>myprefix.auth.us-east-1.amazoncognito.com</code>.</p>
|
|
7249
7391
|
* @public
|
|
7250
7392
|
*/
|
|
7251
7393
|
Domain: string | undefined;
|
|
@@ -7256,18 +7398,17 @@ export interface CreateUserPoolDomainRequest {
|
|
|
7256
7398
|
UserPoolId: string | undefined;
|
|
7257
7399
|
/**
|
|
7258
7400
|
* <p>The version of managed login branding that you want to apply to your domain. A value
|
|
7259
|
-
* of <code>1</code> indicates hosted UI (classic)
|
|
7260
|
-
* indicates managed login
|
|
7401
|
+
* of <code>1</code> indicates hosted UI (classic) and a version of <code>2</code>
|
|
7402
|
+
* indicates managed login.</p>
|
|
7261
7403
|
* <p>Managed login requires that your user pool be configured for any <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html">feature plan</a> other than <code>Lite</code>.</p>
|
|
7262
7404
|
* @public
|
|
7263
7405
|
*/
|
|
7264
7406
|
ManagedLoginVersion?: number | undefined;
|
|
7265
7407
|
/**
|
|
7266
|
-
* <p>The configuration for a custom domain
|
|
7267
|
-
*
|
|
7408
|
+
* <p>The configuration for a custom domain. Configures your domain with an Certificate Manager
|
|
7409
|
+
* certificate in the <code>us-east-1</code> Region.</p>
|
|
7268
7410
|
* <p>Provide this parameter only if you want to use a custom domain for your user pool.
|
|
7269
|
-
* Otherwise, you can exclude this parameter and use
|
|
7270
|
-
* instead.</p>
|
|
7411
|
+
* Otherwise, you can exclude this parameter and use a prefix domain instead.</p>
|
|
7271
7412
|
* <p>For more information about the hosted domain and custom domains, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html">Configuring a User Pool Domain</a>.</p>
|
|
7272
7413
|
* @public
|
|
7273
7414
|
*/
|
|
@@ -7279,8 +7420,8 @@ export interface CreateUserPoolDomainRequest {
|
|
|
7279
7420
|
export interface CreateUserPoolDomainResponse {
|
|
7280
7421
|
/**
|
|
7281
7422
|
* <p>The version of managed login branding applied your domain. A value of <code>1</code>
|
|
7282
|
-
* indicates hosted UI (classic)
|
|
7283
|
-
* login
|
|
7423
|
+
* indicates hosted UI (classic) and a version of <code>2</code> indicates managed
|
|
7424
|
+
* login.</p>
|
|
7284
7425
|
* @public
|
|
7285
7426
|
*/
|
|
7286
7427
|
ManagedLoginVersion?: number | undefined;
|
|
@@ -7298,12 +7439,12 @@ export interface CreateUserPoolDomainResponse {
|
|
|
7298
7439
|
*/
|
|
7299
7440
|
export interface DeleteGroupRequest {
|
|
7300
7441
|
/**
|
|
7301
|
-
* <p>The name of the group.</p>
|
|
7442
|
+
* <p>The name of the group that you want to delete.</p>
|
|
7302
7443
|
* @public
|
|
7303
7444
|
*/
|
|
7304
7445
|
GroupName: string | undefined;
|
|
7305
7446
|
/**
|
|
7306
|
-
* <p>The user pool
|
|
7447
|
+
* <p>The ID of the user pool where you want to delete the group.</p>
|
|
7307
7448
|
* @public
|
|
7308
7449
|
*/
|
|
7309
7450
|
UserPoolId: string | undefined;
|
|
@@ -7313,12 +7454,12 @@ export interface DeleteGroupRequest {
|
|
|
7313
7454
|
*/
|
|
7314
7455
|
export interface DeleteIdentityProviderRequest {
|
|
7315
7456
|
/**
|
|
7316
|
-
* <p>The user pool
|
|
7457
|
+
* <p>The ID of the user pool where you want to delete the identity provider.</p>
|
|
7317
7458
|
* @public
|
|
7318
7459
|
*/
|
|
7319
7460
|
UserPoolId: string | undefined;
|
|
7320
7461
|
/**
|
|
7321
|
-
* <p>The IdP
|
|
7462
|
+
* <p>The name of the IdP that you want to delete.</p>
|
|
7322
7463
|
* @public
|
|
7323
7464
|
*/
|
|
7324
7465
|
ProviderName: string | undefined;
|
|
@@ -7356,12 +7497,12 @@ export interface DeleteManagedLoginBrandingRequest {
|
|
|
7356
7497
|
*/
|
|
7357
7498
|
export interface DeleteResourceServerRequest {
|
|
7358
7499
|
/**
|
|
7359
|
-
* <p>The
|
|
7500
|
+
* <p>The ID of the user pool where you want to delete the resource server.</p>
|
|
7360
7501
|
* @public
|
|
7361
7502
|
*/
|
|
7362
7503
|
UserPoolId: string | undefined;
|
|
7363
7504
|
/**
|
|
7364
|
-
* <p>The identifier
|
|
7505
|
+
* <p>The identifier of the resource server that you want to delete.</p>
|
|
7365
7506
|
* @public
|
|
7366
7507
|
*/
|
|
7367
7508
|
Identifier: string | undefined;
|
|
@@ -7385,8 +7526,8 @@ export interface DeleteUserRequest {
|
|
|
7385
7526
|
export interface DeleteUserAttributesRequest {
|
|
7386
7527
|
/**
|
|
7387
7528
|
* <p>An array of strings representing the user attribute names you want to delete.</p>
|
|
7388
|
-
* <p>For custom attributes, you must
|
|
7389
|
-
*
|
|
7529
|
+
* <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the
|
|
7530
|
+
* attribute name, for example <code>custom:department</code>.</p>
|
|
7390
7531
|
* @public
|
|
7391
7532
|
*/
|
|
7392
7533
|
UserAttributeNames: string[] | undefined;
|
|
@@ -7409,7 +7550,7 @@ export interface DeleteUserAttributesResponse {
|
|
|
7409
7550
|
*/
|
|
7410
7551
|
export interface DeleteUserPoolRequest {
|
|
7411
7552
|
/**
|
|
7412
|
-
* <p>The
|
|
7553
|
+
* <p>The ID of the user pool that you want to delete.</p>
|
|
7413
7554
|
* @public
|
|
7414
7555
|
*/
|
|
7415
7556
|
UserPoolId: string | undefined;
|
|
@@ -7420,12 +7561,12 @@ export interface DeleteUserPoolRequest {
|
|
|
7420
7561
|
*/
|
|
7421
7562
|
export interface DeleteUserPoolClientRequest {
|
|
7422
7563
|
/**
|
|
7423
|
-
* <p>The
|
|
7564
|
+
* <p>The ID of the user pool where you want to delete the client.</p>
|
|
7424
7565
|
* @public
|
|
7425
7566
|
*/
|
|
7426
7567
|
UserPoolId: string | undefined;
|
|
7427
7568
|
/**
|
|
7428
|
-
* <p>The
|
|
7569
|
+
* <p>The ID of the user pool app client that you want to delete.</p>
|
|
7429
7570
|
* @public
|
|
7430
7571
|
*/
|
|
7431
7572
|
ClientId: string | undefined;
|
|
@@ -7435,14 +7576,14 @@ export interface DeleteUserPoolClientRequest {
|
|
|
7435
7576
|
*/
|
|
7436
7577
|
export interface DeleteUserPoolDomainRequest {
|
|
7437
7578
|
/**
|
|
7438
|
-
* <p>The domain
|
|
7439
|
-
* as <code>auth.example.com</code>. For Amazon Cognito prefix domains, this is
|
|
7440
|
-
* such as <code>auth</code>.</p>
|
|
7579
|
+
* <p>The domain that you want to delete. For custom domains, this is the fully-qualified
|
|
7580
|
+
* domain name, such as <code>auth.example.com</code>. For Amazon Cognito prefix domains, this is
|
|
7581
|
+
* the prefix alone, such as <code>auth</code>.</p>
|
|
7441
7582
|
* @public
|
|
7442
7583
|
*/
|
|
7443
7584
|
Domain: string | undefined;
|
|
7444
7585
|
/**
|
|
7445
|
-
* <p>The user pool
|
|
7586
|
+
* <p>The ID of the user pool where you want to delete the domain.</p>
|
|
7446
7587
|
* @public
|
|
7447
7588
|
*/
|
|
7448
7589
|
UserPoolId: string | undefined;
|
|
@@ -7457,14 +7598,14 @@ export interface DeleteUserPoolDomainResponse {
|
|
|
7457
7598
|
*/
|
|
7458
7599
|
export interface DeleteWebAuthnCredentialRequest {
|
|
7459
7600
|
/**
|
|
7460
|
-
* <p>A valid access token that Amazon Cognito issued to the user whose passkey you want
|
|
7461
|
-
* delete.</p>
|
|
7601
|
+
* <p>A valid access token that Amazon Cognito issued to the user whose passkey credential you want
|
|
7602
|
+
* to delete.</p>
|
|
7462
7603
|
* @public
|
|
7463
7604
|
*/
|
|
7464
7605
|
AccessToken: string | undefined;
|
|
7465
7606
|
/**
|
|
7466
7607
|
* <p>The unique identifier of the passkey that you want to delete. Look up registered
|
|
7467
|
-
* devices with <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListWebAuthnCredentials.html">
|
|
7608
|
+
* devices with <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListWebAuthnCredentials.html">ListWebAuthnCredentials</a>.</p>
|
|
7468
7609
|
* @public
|
|
7469
7610
|
*/
|
|
7470
7611
|
CredentialId: string | undefined;
|
|
@@ -7479,12 +7620,12 @@ export interface DeleteWebAuthnCredentialResponse {
|
|
|
7479
7620
|
*/
|
|
7480
7621
|
export interface DescribeIdentityProviderRequest {
|
|
7481
7622
|
/**
|
|
7482
|
-
* <p>The user pool
|
|
7623
|
+
* <p>The ID of the user pool that has the IdP that you want to describe..</p>
|
|
7483
7624
|
* @public
|
|
7484
7625
|
*/
|
|
7485
7626
|
UserPoolId: string | undefined;
|
|
7486
7627
|
/**
|
|
7487
|
-
* <p>The IdP
|
|
7628
|
+
* <p>The name of the IdP that you want to describe.</p>
|
|
7488
7629
|
* @public
|
|
7489
7630
|
*/
|
|
7490
7631
|
ProviderName: string | undefined;
|
|
@@ -7494,7 +7635,7 @@ export interface DescribeIdentityProviderRequest {
|
|
|
7494
7635
|
*/
|
|
7495
7636
|
export interface DescribeIdentityProviderResponse {
|
|
7496
7637
|
/**
|
|
7497
|
-
* <p>The
|
|
7638
|
+
* <p>The details of the requested IdP.</p>
|
|
7498
7639
|
* @public
|
|
7499
7640
|
*/
|
|
7500
7641
|
IdentityProvider: IdentityProviderType | undefined;
|
|
@@ -7572,7 +7713,7 @@ export interface DescribeManagedLoginBrandingByClientResponse {
|
|
|
7572
7713
|
*/
|
|
7573
7714
|
export interface DescribeResourceServerRequest {
|
|
7574
7715
|
/**
|
|
7575
|
-
* <p>The
|
|
7716
|
+
* <p>The ID of the user pool that hosts the resource server.</p>
|
|
7576
7717
|
* @public
|
|
7577
7718
|
*/
|
|
7578
7719
|
UserPoolId: string | undefined;
|
|
@@ -7592,7 +7733,7 @@ export interface DescribeResourceServerRequest {
|
|
|
7592
7733
|
*/
|
|
7593
7734
|
export interface DescribeResourceServerResponse {
|
|
7594
7735
|
/**
|
|
7595
|
-
* <p>The resource server.</p>
|
|
7736
|
+
* <p>The details of the requested resource server.</p>
|
|
7596
7737
|
* @public
|
|
7597
7738
|
*/
|
|
7598
7739
|
ResourceServer: ResourceServerType | undefined;
|
|
@@ -7602,12 +7743,20 @@ export interface DescribeResourceServerResponse {
|
|
|
7602
7743
|
*/
|
|
7603
7744
|
export interface DescribeRiskConfigurationRequest {
|
|
7604
7745
|
/**
|
|
7605
|
-
* <p>The user pool
|
|
7746
|
+
* <p>The ID of the user pool with the risk configuration that you want to inspect. You can
|
|
7747
|
+
* apply default risk configuration at the user pool level and further customize it from
|
|
7748
|
+
* user pool defaults at the app-client level. Specify <code>ClientId</code> to inspect
|
|
7749
|
+
* client-level configuration, or <code>UserPoolId</code> to inspect pool-level
|
|
7750
|
+
* configuration.</p>
|
|
7606
7751
|
* @public
|
|
7607
7752
|
*/
|
|
7608
7753
|
UserPoolId: string | undefined;
|
|
7609
7754
|
/**
|
|
7610
|
-
* <p>The app client
|
|
7755
|
+
* <p>The ID of the app client with the risk configuration that you want to inspect. You can
|
|
7756
|
+
* apply default risk configuration at the user pool level and further customize it from
|
|
7757
|
+
* user pool defaults at the app-client level. Specify <code>ClientId</code> to inspect
|
|
7758
|
+
* client-level configuration, or <code>UserPoolId</code> to inspect pool-level
|
|
7759
|
+
* configuration.</p>
|
|
7611
7760
|
* @public
|
|
7612
7761
|
*/
|
|
7613
7762
|
ClientId?: string | undefined;
|
|
@@ -7739,7 +7888,7 @@ export interface RiskConfigurationType {
|
|
|
7739
7888
|
*/
|
|
7740
7889
|
export interface DescribeRiskConfigurationResponse {
|
|
7741
7890
|
/**
|
|
7742
|
-
* <p>The risk configuration.</p>
|
|
7891
|
+
* <p>The details of the requested risk configuration.</p>
|
|
7743
7892
|
* @public
|
|
7744
7893
|
*/
|
|
7745
7894
|
RiskConfiguration: RiskConfigurationType | undefined;
|
|
@@ -7750,12 +7899,12 @@ export interface DescribeRiskConfigurationResponse {
|
|
|
7750
7899
|
*/
|
|
7751
7900
|
export interface DescribeUserImportJobRequest {
|
|
7752
7901
|
/**
|
|
7753
|
-
* <p>The
|
|
7902
|
+
* <p>The ID of the user pool that's associated with the import job.</p>
|
|
7754
7903
|
* @public
|
|
7755
7904
|
*/
|
|
7756
7905
|
UserPoolId: string | undefined;
|
|
7757
7906
|
/**
|
|
7758
|
-
* <p>The
|
|
7907
|
+
* <p>The Id of the user import job that you want to describe.</p>
|
|
7759
7908
|
* @public
|
|
7760
7909
|
*/
|
|
7761
7910
|
JobId: string | undefined;
|
|
@@ -7767,7 +7916,7 @@ export interface DescribeUserImportJobRequest {
|
|
|
7767
7916
|
*/
|
|
7768
7917
|
export interface DescribeUserImportJobResponse {
|
|
7769
7918
|
/**
|
|
7770
|
-
* <p>The
|
|
7919
|
+
* <p>The details of the user import job.</p>
|
|
7771
7920
|
* @public
|
|
7772
7921
|
*/
|
|
7773
7922
|
UserImportJob?: UserImportJobType | undefined;
|
|
@@ -7778,7 +7927,7 @@ export interface DescribeUserImportJobResponse {
|
|
|
7778
7927
|
*/
|
|
7779
7928
|
export interface DescribeUserPoolRequest {
|
|
7780
7929
|
/**
|
|
7781
|
-
* <p>The
|
|
7930
|
+
* <p>The ID of the user pool you want to describe.</p>
|
|
7782
7931
|
* @public
|
|
7783
7932
|
*/
|
|
7784
7933
|
UserPoolId: string | undefined;
|
|
@@ -7789,7 +7938,7 @@ export interface DescribeUserPoolRequest {
|
|
|
7789
7938
|
*/
|
|
7790
7939
|
export interface DescribeUserPoolResponse {
|
|
7791
7940
|
/**
|
|
7792
|
-
* <p>The
|
|
7941
|
+
* <p>The details of the requested user pool.</p>
|
|
7793
7942
|
* @public
|
|
7794
7943
|
*/
|
|
7795
7944
|
UserPool?: UserPoolType | undefined;
|
|
@@ -7800,12 +7949,12 @@ export interface DescribeUserPoolResponse {
|
|
|
7800
7949
|
*/
|
|
7801
7950
|
export interface DescribeUserPoolClientRequest {
|
|
7802
7951
|
/**
|
|
7803
|
-
* <p>The user pool
|
|
7952
|
+
* <p>The ID of the user pool that contains the app client you want to describe.</p>
|
|
7804
7953
|
* @public
|
|
7805
7954
|
*/
|
|
7806
7955
|
UserPoolId: string | undefined;
|
|
7807
7956
|
/**
|
|
7808
|
-
* <p>The
|
|
7957
|
+
* <p>The ID of the app client that you want to describe.</p>
|
|
7809
7958
|
* @public
|
|
7810
7959
|
*/
|
|
7811
7960
|
ClientId: string | undefined;
|
|
@@ -7817,7 +7966,7 @@ export interface DescribeUserPoolClientRequest {
|
|
|
7817
7966
|
*/
|
|
7818
7967
|
export interface DescribeUserPoolClientResponse {
|
|
7819
7968
|
/**
|
|
7820
|
-
* <p>The
|
|
7969
|
+
* <p>The details of the request app client.</p>
|
|
7821
7970
|
* @public
|
|
7822
7971
|
*/
|
|
7823
7972
|
UserPoolClient?: UserPoolClientType | undefined;
|
|
@@ -7827,9 +7976,9 @@ export interface DescribeUserPoolClientResponse {
|
|
|
7827
7976
|
*/
|
|
7828
7977
|
export interface DescribeUserPoolDomainRequest {
|
|
7829
7978
|
/**
|
|
7830
|
-
* <p>The domain
|
|
7831
|
-
* as <code>auth.example.com</code>. For Amazon Cognito prefix domains, this is
|
|
7832
|
-
* such as <code>auth</code>.</p>
|
|
7979
|
+
* <p>The domain that you want to describe. For custom domains, this is the fully-qualified
|
|
7980
|
+
* domain name, such as <code>auth.example.com</code>. For Amazon Cognito prefix domains, this is
|
|
7981
|
+
* the prefix alone, such as <code>auth</code>.</p>
|
|
7833
7982
|
* @public
|
|
7834
7983
|
*/
|
|
7835
7984
|
Domain: string | undefined;
|
|
@@ -7913,7 +8062,7 @@ export interface DomainDescriptionType {
|
|
|
7913
8062
|
*/
|
|
7914
8063
|
export interface DescribeUserPoolDomainResponse {
|
|
7915
8064
|
/**
|
|
7916
|
-
* <p>
|
|
8065
|
+
* <p>The details of the requested user pool domain.</p>
|
|
7917
8066
|
* @public
|
|
7918
8067
|
*/
|
|
7919
8068
|
DomainDescription?: DomainDescriptionType | undefined;
|
|
@@ -7947,7 +8096,8 @@ export interface ForgotPasswordRequest {
|
|
|
7947
8096
|
ClientId: string | undefined;
|
|
7948
8097
|
/**
|
|
7949
8098
|
* <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a
|
|
7950
|
-
* user pool client and username plus the client ID in the message
|
|
8099
|
+
* user pool client and username plus the client ID in the message. For more information
|
|
8100
|
+
* about <code>SecretHash</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>.</p>
|
|
7951
8101
|
* @public
|
|
7952
8102
|
*/
|
|
7953
8103
|
SecretHash?: string | undefined;
|
|
@@ -7955,6 +8105,8 @@ export interface ForgotPasswordRequest {
|
|
|
7955
8105
|
* <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
|
|
7956
8106
|
* security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
|
|
7957
8107
|
* when it makes API requests.</p>
|
|
8108
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html">Collecting data for threat protection in
|
|
8109
|
+
* applications</a>.</p>
|
|
7958
8110
|
* @public
|
|
7959
8111
|
*/
|
|
7960
8112
|
UserContextData?: UserContextDataType | undefined;
|
|
@@ -7989,21 +8141,21 @@ export interface ForgotPasswordRequest {
|
|
|
7989
8141
|
* <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">
|
|
7990
8142
|
* Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
7991
8143
|
* <note>
|
|
7992
|
-
* <p>When you use the ClientMetadata parameter,
|
|
8144
|
+
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
7993
8145
|
* following:</p>
|
|
7994
8146
|
* <ul>
|
|
7995
8147
|
* <li>
|
|
7996
|
-
* <p>Store the ClientMetadata value. This data is available only
|
|
7997
|
-
* triggers that are assigned to a user pool to support custom
|
|
7998
|
-
* your user pool configuration doesn't include triggers, the
|
|
7999
|
-
* parameter serves no purpose.</p>
|
|
8148
|
+
* <p>Store the <code>ClientMetadata</code> value. This data is available only
|
|
8149
|
+
* to Lambda triggers that are assigned to a user pool to support custom
|
|
8150
|
+
* workflows. If your user pool configuration doesn't include triggers, the
|
|
8151
|
+
* <code>ClientMetadata</code> parameter serves no purpose.</p>
|
|
8000
8152
|
* </li>
|
|
8001
8153
|
* <li>
|
|
8002
|
-
* <p>Validate the ClientMetadata value.</p>
|
|
8154
|
+
* <p>Validate the <code>ClientMetadata</code> value.</p>
|
|
8003
8155
|
* </li>
|
|
8004
8156
|
* <li>
|
|
8005
|
-
* <p>Encrypt the ClientMetadata value. Don't
|
|
8006
|
-
* information.</p>
|
|
8157
|
+
* <p>Encrypt the <code>ClientMetadata</code> value. Don't send sensitive
|
|
8158
|
+
* information in this parameter.</p>
|
|
8007
8159
|
* </li>
|
|
8008
8160
|
* </ul>
|
|
8009
8161
|
* </note>
|
|
@@ -8054,7 +8206,7 @@ export interface ForgotPasswordResponse {
|
|
|
8054
8206
|
*/
|
|
8055
8207
|
export interface GetCSVHeaderRequest {
|
|
8056
8208
|
/**
|
|
8057
|
-
* <p>The
|
|
8209
|
+
* <p>The ID of the user pool that the users are to be imported into.</p>
|
|
8058
8210
|
* @public
|
|
8059
8211
|
*/
|
|
8060
8212
|
UserPoolId: string | undefined;
|
|
@@ -8066,7 +8218,7 @@ export interface GetCSVHeaderRequest {
|
|
|
8066
8218
|
*/
|
|
8067
8219
|
export interface GetCSVHeaderResponse {
|
|
8068
8220
|
/**
|
|
8069
|
-
* <p>The
|
|
8221
|
+
* <p>The ID of the user pool that the users are to be imported into.</p>
|
|
8070
8222
|
* @public
|
|
8071
8223
|
*/
|
|
8072
8224
|
UserPoolId?: string | undefined;
|
|
@@ -8114,7 +8266,7 @@ export interface GetGroupRequest {
|
|
|
8114
8266
|
*/
|
|
8115
8267
|
GroupName: string | undefined;
|
|
8116
8268
|
/**
|
|
8117
|
-
* <p>The
|
|
8269
|
+
* <p>The ID of the user pool.</p>
|
|
8118
8270
|
* @public
|
|
8119
8271
|
*/
|
|
8120
8272
|
UserPoolId: string | undefined;
|
|
@@ -8336,7 +8488,7 @@ export interface GetSigningCertificateResponse {
|
|
|
8336
8488
|
*/
|
|
8337
8489
|
export interface GetUICustomizationRequest {
|
|
8338
8490
|
/**
|
|
8339
|
-
* <p>The
|
|
8491
|
+
* <p>The ID of the user pool.</p>
|
|
8340
8492
|
* @public
|
|
8341
8493
|
*/
|
|
8342
8494
|
UserPoolId: string | undefined;
|
|
@@ -8487,21 +8639,21 @@ export interface GetUserAttributeVerificationCodeRequest {
|
|
|
8487
8639
|
* <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">
|
|
8488
8640
|
* Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
8489
8641
|
* <note>
|
|
8490
|
-
* <p>When you use the ClientMetadata parameter,
|
|
8642
|
+
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
8491
8643
|
* following:</p>
|
|
8492
8644
|
* <ul>
|
|
8493
8645
|
* <li>
|
|
8494
|
-
* <p>Store the ClientMetadata value. This data is available only
|
|
8495
|
-
* triggers that are assigned to a user pool to support custom
|
|
8496
|
-
* your user pool configuration doesn't include triggers, the
|
|
8497
|
-
* parameter serves no purpose.</p>
|
|
8646
|
+
* <p>Store the <code>ClientMetadata</code> value. This data is available only
|
|
8647
|
+
* to Lambda triggers that are assigned to a user pool to support custom
|
|
8648
|
+
* workflows. If your user pool configuration doesn't include triggers, the
|
|
8649
|
+
* <code>ClientMetadata</code> parameter serves no purpose.</p>
|
|
8498
8650
|
* </li>
|
|
8499
8651
|
* <li>
|
|
8500
|
-
* <p>Validate the ClientMetadata value.</p>
|
|
8652
|
+
* <p>Validate the <code>ClientMetadata</code> value.</p>
|
|
8501
8653
|
* </li>
|
|
8502
8654
|
* <li>
|
|
8503
|
-
* <p>Encrypt the ClientMetadata value. Don't
|
|
8504
|
-
* information.</p>
|
|
8655
|
+
* <p>Encrypt the <code>ClientMetadata</code> value. Don't send sensitive
|
|
8656
|
+
* information in this parameter.</p>
|
|
8505
8657
|
* </li>
|
|
8506
8658
|
* </ul>
|
|
8507
8659
|
* </note>
|
|
@@ -8580,16 +8732,16 @@ export interface GetUserPoolMfaConfigRequest {
|
|
|
8580
8732
|
*/
|
|
8581
8733
|
export interface EmailMfaConfigType {
|
|
8582
8734
|
/**
|
|
8583
|
-
* <p>The template for the email message that your user pool sends to users with
|
|
8584
|
-
*
|
|
8585
|
-
* Amazon Cognito replaces this placeholder with the code. If you
|
|
8586
|
-
* Amazon Cognito sends messages in the default format.</p>
|
|
8735
|
+
* <p>The template for the email message that your user pool sends to users with a code for
|
|
8736
|
+
* MFA and sign-in with an email OTP. The message must contain the <code>\{####\}</code>
|
|
8737
|
+
* placeholder. In the message, Amazon Cognito replaces this placeholder with the code. If you
|
|
8738
|
+
* don't provide this parameter, Amazon Cognito sends messages in the default format.</p>
|
|
8587
8739
|
* @public
|
|
8588
8740
|
*/
|
|
8589
8741
|
Message?: string | undefined;
|
|
8590
8742
|
/**
|
|
8591
|
-
* <p>The subject of the email message that your user pool sends to users with
|
|
8592
|
-
*
|
|
8743
|
+
* <p>The subject of the email message that your user pool sends to users with a code for
|
|
8744
|
+
* MFA and email OTP sign-in.</p>
|
|
8593
8745
|
* @public
|
|
8594
8746
|
*/
|
|
8595
8747
|
Subject?: string | undefined;
|