@aws-sdk/client-cognito-identity-provider 3.998.0 → 3.1000.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.
Files changed (46) hide show
  1. package/README.md +21 -0
  2. package/dist-cjs/index.js +42 -0
  3. package/dist-cjs/models/errors.js +41 -15
  4. package/dist-cjs/schemas/schemas_0.js +96 -18
  5. package/dist-es/CognitoIdentityProvider.js +6 -0
  6. package/dist-es/commands/AddUserPoolClientSecretCommand.js +16 -0
  7. package/dist-es/commands/DeleteUserPoolClientSecretCommand.js +16 -0
  8. package/dist-es/commands/ListUserPoolClientSecretsCommand.js +16 -0
  9. package/dist-es/commands/index.js +3 -0
  10. package/dist-es/models/errors.js +36 -12
  11. package/dist-es/schemas/schemas_0.js +87 -9
  12. package/dist-types/CognitoIdentityProvider.d.ts +21 -0
  13. package/dist-types/CognitoIdentityProviderClient.d.ts +5 -2
  14. package/dist-types/commands/AddUserPoolClientSecretCommand.d.ts +102 -0
  15. package/dist-types/commands/CompleteWebAuthnRegistrationCommand.d.ts +3 -0
  16. package/dist-types/commands/CreateUserPoolClientCommand.d.ts +1 -0
  17. package/dist-types/commands/DeleteUserPoolClientSecretCommand.d.ts +93 -0
  18. package/dist-types/commands/DeleteWebAuthnCredentialCommand.d.ts +3 -0
  19. package/dist-types/commands/ListUserPoolClientSecretsCommand.d.ts +102 -0
  20. package/dist-types/commands/ListUsersCommand.d.ts +3 -0
  21. package/dist-types/commands/ListWebAuthnCredentialsCommand.d.ts +3 -0
  22. package/dist-types/commands/StartWebAuthnRegistrationCommand.d.ts +3 -0
  23. package/dist-types/commands/UpdateResourceServerCommand.d.ts +2 -1
  24. package/dist-types/commands/UpdateTermsCommand.d.ts +1 -1
  25. package/dist-types/commands/UpdateUserAttributesCommand.d.ts +1 -1
  26. package/dist-types/commands/UpdateUserPoolCommand.d.ts +2 -2
  27. package/dist-types/commands/index.d.ts +3 -0
  28. package/dist-types/models/errors.d.ts +37 -13
  29. package/dist-types/models/models_0.d.ts +313 -533
  30. package/dist-types/models/models_1.d.ts +313 -2
  31. package/dist-types/schemas/schemas_0.d.ts +12 -0
  32. package/dist-types/ts3.4/CognitoIdentityProvider.d.ts +51 -0
  33. package/dist-types/ts3.4/CognitoIdentityProviderClient.d.ts +18 -0
  34. package/dist-types/ts3.4/commands/AddUserPoolClientSecretCommand.d.ts +51 -0
  35. package/dist-types/ts3.4/commands/DeleteUserPoolClientSecretCommand.d.ts +51 -0
  36. package/dist-types/ts3.4/commands/ListUserPoolClientSecretsCommand.d.ts +51 -0
  37. package/dist-types/ts3.4/commands/UpdateResourceServerCommand.d.ts +2 -4
  38. package/dist-types/ts3.4/commands/UpdateTermsCommand.d.ts +1 -1
  39. package/dist-types/ts3.4/commands/UpdateUserAttributesCommand.d.ts +1 -1
  40. package/dist-types/ts3.4/commands/UpdateUserPoolCommand.d.ts +1 -1
  41. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  42. package/dist-types/ts3.4/models/errors.d.ts +21 -7
  43. package/dist-types/ts3.4/models/models_0.d.ts +29 -46
  44. package/dist-types/ts3.4/models/models_1.d.ts +66 -0
  45. package/dist-types/ts3.4/schemas/schemas_0.d.ts +12 -0
  46. package/package.json +12 -12
@@ -148,7 +148,9 @@ export interface NotifyConfigurationType {
148
148
  */
149
149
  From?: string | undefined;
150
150
  /**
151
- * <p>The reply-to email address of an email template.</p>
151
+ * <p>The reply-to email address of an email template. Can be an email address in the format
152
+ * <code>admin@example.com</code> or <code>Administrator
153
+ * <admin@example.com></code>.</p>
152
154
  * @public
153
155
  */
154
156
  ReplyTo?: string | undefined;
@@ -374,6 +376,59 @@ export interface AddCustomAttributesRequest {
374
376
  */
375
377
  export interface AddCustomAttributesResponse {
376
378
  }
379
+ /**
380
+ * <p>The request to create a new client secret for a user pool app client.</p>
381
+ * @public
382
+ */
383
+ export interface AddUserPoolClientSecretRequest {
384
+ /**
385
+ * <p>The ID of the user pool that contains the app client.</p>
386
+ * @public
387
+ */
388
+ UserPoolId: string | undefined;
389
+ /**
390
+ * <p>The ID of the app client for which you want to create a new secret.</p>
391
+ * @public
392
+ */
393
+ ClientId: string | undefined;
394
+ /**
395
+ * <p>The client secret value you want to use. If you don't provide this parameter, Amazon Cognito generates a secure secret for you.</p>
396
+ * @public
397
+ */
398
+ ClientSecret?: string | undefined;
399
+ }
400
+ /**
401
+ * <p>Contains information about a client secret, including its unique identifier, value, and creation timestamp.</p>
402
+ * @public
403
+ */
404
+ export interface ClientSecretDescriptorType {
405
+ /**
406
+ * <p>The unique identifier for the client secret. This identifier follows the format <client-id>--<epoch-create-time>.</p>
407
+ * @public
408
+ */
409
+ ClientSecretId?: string | undefined;
410
+ /**
411
+ * <p>The actual secret value. This is only returned when creating a new secret and only if Amazon Cognito generated the secret. For custom secrets that you provide, this field is not included in the response.</p>
412
+ * @public
413
+ */
414
+ ClientSecretValue?: string | undefined;
415
+ /**
416
+ * <p>The date and time when the client secret was created.</p>
417
+ * @public
418
+ */
419
+ ClientSecretCreateDate?: Date | undefined;
420
+ }
421
+ /**
422
+ * <p>The response from creating a new client secret.</p>
423
+ * @public
424
+ */
425
+ export interface AddUserPoolClientSecretResponse {
426
+ /**
427
+ * <p>The details of the newly created client secret, including its unique identifier and creation timestamp. The ClientSecretValue is only returned when Amazon Cognito generates the secret. For custom secrets that you provide, the ClientSecretValue is not included in the response.</p>
428
+ * @public
429
+ */
430
+ ClientSecretDescriptor?: ClientSecretDescriptorType | undefined;
431
+ }
377
432
  /**
378
433
  * @public
379
434
  */
@@ -421,17 +476,15 @@ export interface AdminConfirmSignUpRequest {
421
476
  Username: string | undefined;
422
477
  /**
423
478
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
424
- * that this action triggers.</p>
425
- * <p>If your user pool configuration includes triggers, the AdminConfirmSignUp API action
426
- * invokes the Lambda function that is specified for the <i>post
427
- * confirmation</i> trigger. When Amazon Cognito invokes this function, it passes a JSON
428
- * payload, which the function receives as input. In this payload, the
429
- * <code>clientMetadata</code> attribute provides the data that you assigned to the
430
- * ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in
431
- * Lambda, you can process the ClientMetadata value to enhance your workflow for your
432
- * specific needs.</p>
433
- * <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">
434
- * Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
479
+ * that this action triggers. You create custom workflows by assigning Lambda functions
480
+ * to user pool triggers.</p>
481
+ * <p>When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the
482
+ * function receives as input. This payload contains a <code>clientMetadata</code>
483
+ * attribute that provides the data that you assigned to the ClientMetadata parameter in
484
+ * your request. In your function code, you can process the <code>clientMetadata</code>
485
+ * value to enhance your workflow for your specific needs.</p>
486
+ * <p>To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-working-with-lambda-triggers.html#lambda-triggers-by-event">
487
+ * Connecting API actions to Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
435
488
  * <note>
436
489
  * <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
437
490
  * following:</p>
@@ -468,7 +521,16 @@ export interface AdminConfirmSignUpResponse {
468
521
  */
469
522
  export interface AttributeType {
470
523
  /**
471
- * <p>The name of the attribute.</p>
524
+ * <p>The name of the attribute, for example <code>email</code> or
525
+ * <code>custom:department</code>.</p>
526
+ * <p>In some older user pools, the regex pattern for acceptable values of this parameter is
527
+ * <code>[\p\{L\}\p\{M\}\p\{S\}\p\{N\}\p\{P\}]+</code>. Older pools will eventually be updated to
528
+ * use the new pattern. Affected user pools are those created before May 2024 in
529
+ * US East (N. Virginia), US East (Ohio), US West (N. California), US West (Oregon),
530
+ * Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Seoul),
531
+ * Asia Pacific (Singapore), Asia Pacific (Sydney), Canada (Central),
532
+ * Europe (Frankfurt), Europe (Ireland), Europe (London), Europe (Paris),
533
+ * Europe (Stockholm), Middle East (Bahrain), and South America (São Paulo). </p>
472
534
  * @public
473
535
  */
474
536
  Name: string | undefined;
@@ -612,17 +674,15 @@ export interface AdminCreateUserRequest {
612
674
  DesiredDeliveryMediums?: DeliveryMediumType[] | undefined;
613
675
  /**
614
676
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
615
- * that this action triggers.</p>
616
- * <p>You create custom workflows by assigning Lambda functions to user pool triggers.
617
- * When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned
618
- * to the <i>pre sign-up</i> trigger. When Amazon Cognito invokes this function, it
619
- * passes a JSON payload, which the function receives as input. This payload contains a
620
- * <code>ClientMetadata</code> attribute, which provides the data that you assigned to
621
- * the ClientMetadata parameter in your AdminCreateUser request. In your function code in
622
- * Lambda, you can process the <code>clientMetadata</code> value to enhance your
623
- * workflow for your specific needs.</p>
624
- * <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">
625
- * Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
677
+ * that this action triggers. You create custom workflows by assigning Lambda functions
678
+ * to user pool triggers.</p>
679
+ * <p>When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the
680
+ * function receives as input. This payload contains a <code>clientMetadata</code>
681
+ * attribute that provides the data that you assigned to the ClientMetadata parameter in
682
+ * your request. In your function code, you can process the <code>clientMetadata</code>
683
+ * value to enhance your workflow for your specific needs.</p>
684
+ * <p>To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-working-with-lambda-triggers.html#lambda-triggers-by-event">
685
+ * Connecting API actions to Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
626
686
  * <note>
627
687
  * <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
628
688
  * following:</p>
@@ -1366,12 +1426,18 @@ export interface AdminInitiateAuthRequest {
1366
1426
  */
1367
1427
  AuthParameters?: Record<string, string> | undefined;
1368
1428
  /**
1369
- * <p>A map of custom key-value pairs that you can provide as input for certain custom
1370
- * workflows that this action triggers.</p>
1371
- * <p>You create custom workflows by assigning Lambda functions to user pool triggers.
1372
- * When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that
1373
- * are specified for various triggers. The ClientMetadata value is passed as input to the
1374
- * functions for only the following triggers:</p>
1429
+ * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
1430
+ * that this action triggers. You create custom workflows by assigning Lambda functions
1431
+ * to user pool triggers.</p>
1432
+ * <p>When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the
1433
+ * function receives as input. This payload contains a <code>clientMetadata</code>
1434
+ * attribute that provides the data that you assigned to the ClientMetadata parameter in
1435
+ * your request. In your function code, you can process the <code>clientMetadata</code>
1436
+ * value to enhance your workflow for your specific needs.</p>
1437
+ * <p>To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-working-with-lambda-triggers.html#lambda-triggers-by-event">
1438
+ * Connecting API actions to Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
1439
+ * <p>The <code>ClientMetadata</code> value is passed as input to the functions for only the
1440
+ * following triggers:</p>
1375
1441
  * <ul>
1376
1442
  * <li>
1377
1443
  * <p>Pre signup</p>
@@ -1383,14 +1449,8 @@ export interface AdminInitiateAuthRequest {
1383
1449
  * <p>User migration</p>
1384
1450
  * </li>
1385
1451
  * </ul>
1386
- * <p>When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which
1387
- * the function receives as input. This payload contains a <code>validationData</code>
1388
- * attribute, which provides the data that you assigned to the ClientMetadata parameter in
1389
- * your AdminInitiateAuth request. In your function code in Lambda, you can process the
1390
- * <code>validationData</code> value to enhance your workflow for your specific
1391
- * needs.</p>
1392
- * <p>When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for
1393
- * the following triggers, but it doesn't provide the ClientMetadata value as input:</p>
1452
+ * <p>This request also invokes the functions for the following triggers, but doesn't pass
1453
+ * <code>ClientMetadata</code>:</p>
1394
1454
  * <ul>
1395
1455
  * <li>
1396
1456
  * <p>Post authentication</p>
@@ -1414,8 +1474,6 @@ export interface AdminInitiateAuthRequest {
1414
1474
  * <p>Custom SMS sender</p>
1415
1475
  * </li>
1416
1476
  * </ul>
1417
- * <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">
1418
- * Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
1419
1477
  * <note>
1420
1478
  * <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
1421
1479
  * following:</p>
@@ -2385,17 +2443,15 @@ export interface AdminResetUserPasswordRequest {
2385
2443
  Username: string | undefined;
2386
2444
  /**
2387
2445
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
2388
- * that this action triggers.</p>
2389
- * <p>You create custom workflows by assigning Lambda functions to user pool
2390
- * triggers. The <code>AdminResetUserPassword</code> API operation invokes the function
2391
- * that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes
2392
- * this function, it passes a JSON payload, which the function receives as input. This
2393
- * payload contains a <code>clientMetadata</code> attribute, which provides the data that
2394
- * you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In
2395
- * your function code in Lambda, you can process the
2396
- * <code>clientMetadata</code> value to enhance your workflow for your specific needs. </p>
2397
- * <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">
2398
- * Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
2446
+ * that this action triggers. You create custom workflows by assigning Lambda functions
2447
+ * to user pool triggers.</p>
2448
+ * <p>When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the
2449
+ * function receives as input. This payload contains a <code>clientMetadata</code>
2450
+ * attribute that provides the data that you assigned to the ClientMetadata parameter in
2451
+ * your request. In your function code, you can process the <code>clientMetadata</code>
2452
+ * value to enhance your workflow for your specific needs.</p>
2453
+ * <p>To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-working-with-lambda-triggers.html#lambda-triggers-by-event">
2454
+ * Connecting API actions to Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
2399
2455
  * <note>
2400
2456
  * <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
2401
2457
  * following:</p>
@@ -2788,44 +2844,15 @@ export interface AdminRespondToAuthChallengeRequest {
2788
2844
  ContextData?: ContextDataType | undefined;
2789
2845
  /**
2790
2846
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
2791
- * that this action triggers.</p>
2792
- * <p>You create custom workflows by assigning Lambda functions to user pool triggers.
2793
- * When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions
2794
- * that you have assigned to the following triggers: </p>
2795
- * <ul>
2796
- * <li>
2797
- * <p>Pre sign-up</p>
2798
- * </li>
2799
- * <li>
2800
- * <p>custom message</p>
2801
- * </li>
2802
- * <li>
2803
- * <p>Post authentication</p>
2804
- * </li>
2805
- * <li>
2806
- * <p>User migration</p>
2807
- * </li>
2808
- * <li>
2809
- * <p>Pre token generation</p>
2810
- * </li>
2811
- * <li>
2812
- * <p>Define auth challenge</p>
2813
- * </li>
2814
- * <li>
2815
- * <p>Create auth challenge</p>
2816
- * </li>
2817
- * <li>
2818
- * <p>Verify auth challenge response</p>
2819
- * </li>
2820
- * </ul>
2847
+ * that this action triggers. You create custom workflows by assigning Lambda functions
2848
+ * to user pool triggers.</p>
2821
2849
  * <p>When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the
2822
2850
  * function receives as input. This payload contains a <code>clientMetadata</code>
2823
2851
  * attribute that provides the data that you assigned to the ClientMetadata parameter in
2824
- * your AdminRespondToAuthChallenge request. In your function code in Lambda, you can
2825
- * process the <code>clientMetadata</code> value to enhance your workflow for your specific
2826
- * needs.</p>
2827
- * <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">
2828
- * Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
2852
+ * your request. In your function code, you can process the <code>clientMetadata</code>
2853
+ * value to enhance your workflow for your specific needs.</p>
2854
+ * <p>To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-working-with-lambda-triggers.html#lambda-triggers-by-event">
2855
+ * Connecting API actions to Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
2829
2856
  * <note>
2830
2857
  * <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
2831
2858
  * following:</p>
@@ -3071,9 +3098,8 @@ export interface AdminSetUserMFAPreferenceRequest {
3071
3098
  SMSMfaSettings?: SMSMfaSettingsType | undefined;
3072
3099
  /**
3073
3100
  * <p>User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates
3074
- * TOTP MFA and sets it as the preferred MFA method when multiple methods are available.
3075
- * This operation can set TOTP as a user's preferred MFA method before they register a
3076
- * TOTP authenticator.</p>
3101
+ * TOTP MFA and sets it as the preferred MFA method when multiple methods are
3102
+ * available.</p>
3077
3103
  * @public
3078
3104
  */
3079
3105
  SoftwareTokenMfaSettings?: SoftwareTokenMfaSettingsType | undefined;
@@ -3293,18 +3319,15 @@ export interface AdminUpdateUserAttributesRequest {
3293
3319
  UserAttributes: AttributeType[] | undefined;
3294
3320
  /**
3295
3321
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
3296
- * that this action triggers.</p>
3297
- * <p>You create custom workflows by assigning Lambda functions to user pool
3298
- * triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the
3299
- * function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito
3300
- * invokes this function, it passes a JSON payload, which the function receives as input.
3301
- * This payload contains a <code>clientMetadata</code> attribute, which provides the data
3302
- * that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes
3303
- * request. In your function code in Lambda, you can process the
3304
- * <code>clientMetadata</code> value to enhance your workflow for your specific
3305
- * needs.</p>
3306
- * <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">
3307
- * Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
3322
+ * that this action triggers. You create custom workflows by assigning Lambda functions
3323
+ * to user pool triggers.</p>
3324
+ * <p>When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the
3325
+ * function receives as input. This payload contains a <code>clientMetadata</code>
3326
+ * attribute that provides the data that you assigned to the ClientMetadata parameter in
3327
+ * your request. In your function code, you can process the <code>clientMetadata</code>
3328
+ * value to enhance your workflow for your specific needs.</p>
3329
+ * <p>To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-working-with-lambda-triggers.html#lambda-triggers-by-event">
3330
+ * Connecting API actions to Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
3308
3331
  * <note>
3309
3332
  * <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
3310
3333
  * following:</p>
@@ -3681,17 +3704,15 @@ export interface ConfirmForgotPasswordRequest {
3681
3704
  UserContextData?: UserContextDataType | undefined;
3682
3705
  /**
3683
3706
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
3684
- * that this action triggers.</p>
3685
- * <p>You create custom workflows by assigning Lambda functions to user pool triggers.
3686
- * When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is
3687
- * assigned to the <i>post confirmation</i> trigger. When Amazon Cognito invokes this
3688
- * function, it passes a JSON payload, which the function receives as input. This payload
3689
- * contains a <code>clientMetadata</code> attribute, which provides the data that you
3690
- * assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your
3691
- * function code in Lambda, you can process the <code>clientMetadata</code> value to
3692
- * enhance your workflow for your specific needs.</p>
3693
- * <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">
3694
- * Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
3707
+ * that this action triggers. You create custom workflows by assigning Lambda functions
3708
+ * to user pool triggers.</p>
3709
+ * <p>When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the
3710
+ * function receives as input. This payload contains a <code>clientMetadata</code>
3711
+ * attribute that provides the data that you assigned to the ClientMetadata parameter in
3712
+ * your request. In your function code, you can process the <code>clientMetadata</code>
3713
+ * value to enhance your workflow for your specific needs.</p>
3714
+ * <p>To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-working-with-lambda-triggers.html#lambda-triggers-by-event">
3715
+ * Connecting API actions to Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
3695
3716
  * <note>
3696
3717
  * <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
3697
3718
  * following:</p>
@@ -3789,17 +3810,15 @@ export interface ConfirmSignUpRequest {
3789
3810
  UserContextData?: UserContextDataType | undefined;
3790
3811
  /**
3791
3812
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
3792
- * that this action triggers.</p>
3793
- * <p>You create custom workflows by assigning Lambda functions to user pool
3794
- * triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is
3795
- * assigned to the <i>post confirmation</i> trigger. When Amazon Cognito invokes this
3796
- * function, it passes a JSON payload, which the function receives as input. This payload
3797
- * contains a <code>clientMetadata</code> attribute, which provides the data that you
3798
- * assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function
3799
- * code in Lambda, you can process the <code>clientMetadata</code> value to
3800
- * enhance your workflow for your specific needs.</p>
3801
- * <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">
3802
- * Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
3813
+ * that this action triggers. You create custom workflows by assigning Lambda functions
3814
+ * to user pool triggers.</p>
3815
+ * <p>When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the
3816
+ * function receives as input. This payload contains a <code>clientMetadata</code>
3817
+ * attribute that provides the data that you assigned to the ClientMetadata parameter in
3818
+ * your request. In your function code, you can process the <code>clientMetadata</code>
3819
+ * value to enhance your workflow for your specific needs.</p>
3820
+ * <p>To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-working-with-lambda-triggers.html#lambda-triggers-by-event">
3821
+ * Connecting API actions to Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
3803
3822
  * <note>
3804
3823
  * <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
3805
3824
  * following:</p>
@@ -4567,7 +4586,7 @@ export interface TermsType {
4567
4586
  Enforcement: TermsEnforcementType | undefined;
4568
4587
  /**
4569
4588
  * <p>A map of URLs to languages. For each localized language that will view the requested
4570
- * <code>TermsName</code>, assign a URL. A selection of <code>cognito:default</code>
4589
+ * <code>TermsName</code>, assign a URL. A selection of <code>cognito:default</code>
4571
4590
  * displays for all languages that don't have a language-specific URL.</p>
4572
4591
  * <p>For example, <code>"cognito:default": "https://terms.example.com", "cognito:spanish":
4573
4592
  * "https://terms.example.com/es"</code>.</p>
@@ -5907,6 +5926,11 @@ export interface CreateUserPoolClientRequest {
5907
5926
  * @public
5908
5927
  */
5909
5928
  GenerateSecret?: boolean | undefined;
5929
+ /**
5930
+ * <p>A custom client secret that you want to use for the app client. You cannot specify both GenerateSecret as true and provide a ClientSecret value.</p>
5931
+ * @public
5932
+ */
5933
+ ClientSecret?: string | undefined;
5910
5934
  /**
5911
5935
  * <p>The refresh token time limit. After this limit expires, your user can't use
5912
5936
  * their refresh token. To specify the time unit for <code>RefreshTokenValidity</code> as
@@ -6091,9 +6115,11 @@ export interface CreateUserPoolClientRequest {
6091
6115
  * </ul>
6092
6116
  * <p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 -
6093
6117
  * Redirection Endpoint</a>.</p>
6094
- * <p>Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes
6095
- * only.</p>
6096
- * <p>App callback URLs such as myapp://example are also supported.</p>
6118
+ * <p>Amazon Cognito requires HTTPS over HTTP except for callback URLs to
6119
+ * <code>http://localhost</code>, <code>http://127.0.0.1</code> and
6120
+ * <code>http://[::1]</code>. These callback URLs are for testing purposes only. You
6121
+ * can specify custom TCP ports for your callback URLs.</p>
6122
+ * <p>App callback URLs such as <code>myapp://example</code> are also supported.</p>
6097
6123
  * @public
6098
6124
  */
6099
6125
  CallbackURLs?: string[] | undefined;
@@ -6458,8 +6484,10 @@ export interface UserPoolClientType {
6458
6484
  * </ul>
6459
6485
  * <p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 -
6460
6486
  * Redirection Endpoint</a>.</p>
6461
- * <p>Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes
6462
- * only.</p>
6487
+ * <p>Amazon Cognito requires HTTPS over HTTP for callback URLs to <code>http://localhost</code>,
6488
+ * <code>http://127.0.0.1</code> and <code>http://[::1]</code>. These callback URLs are
6489
+ * for testing purposes only. You can specify custom TCP ports for your callback
6490
+ * URLs.</p>
6463
6491
  * <p>App callback URLs such as myapp://example are also supported.</p>
6464
6492
  * @public
6465
6493
  */
@@ -6485,8 +6513,10 @@ export interface UserPoolClientType {
6485
6513
  * </ul>
6486
6514
  * <p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 -
6487
6515
  * Redirection Endpoint</a>.</p>
6488
- * <p>Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes
6489
- * only.</p>
6516
+ * <p>Amazon Cognito requires HTTPS over HTTP for callback URLs to <code>http://localhost</code>,
6517
+ * <code>http://127.0.0.1</code> and <code>http://[::1]</code>. These callback URLs are
6518
+ * for testing purposes only. You can specify custom TCP ports for your callback
6519
+ * URLs.</p>
6490
6520
  * <p>App callback URLs such as myapp://example are also supported.</p>
6491
6521
  * @public
6492
6522
  */
@@ -6847,6 +6877,33 @@ export interface DeleteUserPoolClientRequest {
6847
6877
  */
6848
6878
  ClientId: string | undefined;
6849
6879
  }
6880
+ /**
6881
+ * <p>The request to delete a specific client secret from a user pool app client.</p>
6882
+ * @public
6883
+ */
6884
+ export interface DeleteUserPoolClientSecretRequest {
6885
+ /**
6886
+ * <p>The ID of the user pool that contains the app client.</p>
6887
+ * @public
6888
+ */
6889
+ UserPoolId: string | undefined;
6890
+ /**
6891
+ * <p>The ID of the app client from which you want to delete the secret.</p>
6892
+ * @public
6893
+ */
6894
+ ClientId: string | undefined;
6895
+ /**
6896
+ * <p>The unique identifier of the client secret you want to delete.</p>
6897
+ * @public
6898
+ */
6899
+ ClientSecretId: string | undefined;
6900
+ }
6901
+ /**
6902
+ * <p>The response from deleting a client secret.</p>
6903
+ * @public
6904
+ */
6905
+ export interface DeleteUserPoolClientSecretResponse {
6906
+ }
6850
6907
  /**
6851
6908
  * @public
6852
6909
  */
@@ -7387,19 +7444,15 @@ export interface ForgotPasswordRequest {
7387
7444
  AnalyticsMetadata?: AnalyticsMetadataType | undefined;
7388
7445
  /**
7389
7446
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
7390
- * that this action triggers.</p>
7391
- * <p>You create custom workflows by assigning Lambda functions to user pool
7392
- * triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any
7393
- * functions that are assigned to the following triggers: <i>pre sign-up</i>,
7394
- * <i>custom message</i>, and <i>user migration</i>. When
7395
- * Amazon Cognito invokes any of these functions, it passes a JSON payload, which the
7447
+ * that this action triggers. You create custom workflows by assigning Lambda functions
7448
+ * to user pool triggers.</p>
7449
+ * <p>When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the
7396
7450
  * function receives as input. This payload contains a <code>clientMetadata</code>
7397
- * attribute, which provides the data that you assigned to the ClientMetadata parameter in
7398
- * your ForgotPassword request. In your function code in Lambda, you can
7399
- * process the <code>clientMetadata</code> value to enhance your workflow for your specific
7400
- * needs.</p>
7401
- * <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">
7402
- * Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
7451
+ * attribute that provides the data that you assigned to the ClientMetadata parameter in
7452
+ * your request. In your function code, you can process the <code>clientMetadata</code>
7453
+ * value to enhance your workflow for your specific needs.</p>
7454
+ * <p>To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-working-with-lambda-triggers.html#lambda-triggers-by-event">
7455
+ * Connecting API actions to Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
7403
7456
  * <note>
7404
7457
  * <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
7405
7458
  * following:</p>
@@ -7760,13 +7813,16 @@ export interface GetTokensFromRefreshTokenRequest {
7760
7813
  */
7761
7814
  DeviceKey?: string | undefined;
7762
7815
  /**
7763
- * <p>A map of custom key-value pairs that you can provide as input for certain custom
7764
- * workflows that this action triggers.</p>
7765
- * <p>You create custom workflows by assigning Lambda functions to user pool triggers.
7766
- * When you use the <code>GetTokensFromRefreshToken</code> API action, Amazon Cognito invokes the
7767
- * Lambda function the pre token generation trigger.</p>
7768
- * <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">
7769
- * Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
7816
+ * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
7817
+ * that this action triggers. You create custom workflows by assigning Lambda functions
7818
+ * to user pool triggers.</p>
7819
+ * <p>When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the
7820
+ * function receives as input. This payload contains a <code>clientMetadata</code>
7821
+ * attribute that provides the data that you assigned to the ClientMetadata parameter in
7822
+ * your request. In your function code, you can process the <code>clientMetadata</code>
7823
+ * value to enhance your workflow for your specific needs.</p>
7824
+ * <p>To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-working-with-lambda-triggers.html#lambda-triggers-by-event">
7825
+ * Connecting API actions to Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
7770
7826
  * <note>
7771
7827
  * <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
7772
7828
  * following:</p>
@@ -7945,17 +8001,15 @@ export interface GetUserAttributeVerificationCodeRequest {
7945
8001
  AttributeName: string | undefined;
7946
8002
  /**
7947
8003
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
7948
- * that this action triggers.</p>
7949
- * <p>You create custom workflows by assigning Lambda functions to user pool
7950
- * triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes
7951
- * the function that is assigned to the <i>custom message</i> trigger. When
7952
- * Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as
7953
- * input. This payload contains a <code>clientMetadata</code> attribute, which provides the
7954
- * data that you assigned to the ClientMetadata parameter in your
7955
- * GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for
7956
- * your specific needs.</p>
7957
- * <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">
7958
- * Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
8004
+ * that this action triggers. You create custom workflows by assigning Lambda functions
8005
+ * to user pool triggers.</p>
8006
+ * <p>When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the
8007
+ * function receives as input. This payload contains a <code>clientMetadata</code>
8008
+ * attribute that provides the data that you assigned to the ClientMetadata parameter in
8009
+ * your request. In your function code, you can process the <code>clientMetadata</code>
8010
+ * value to enhance your workflow for your specific needs.</p>
8011
+ * <p>To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-working-with-lambda-triggers.html#lambda-triggers-by-event">
8012
+ * Connecting API actions to Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
7959
8013
  * <note>
7960
8014
  * <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
7961
8015
  * following:</p>
@@ -8353,15 +8407,21 @@ export interface InitiateAuthRequest {
8353
8407
  */
8354
8408
  AuthParameters?: Record<string, string> | undefined;
8355
8409
  /**
8356
- * <p>A map of custom key-value pairs that you can provide as input for certain custom
8357
- * workflows that this action triggers.</p>
8358
- * <p>You create custom workflows by assigning Lambda functions to user pool triggers.
8359
- * When you send an <code>InitiateAuth</code> request, Amazon Cognito invokes the Lambda functions
8360
- * that are specified for various triggers. The <code>ClientMetadata</code> value is passed
8361
- * as input to the functions for only the following triggers.</p>
8410
+ * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
8411
+ * that this action triggers. You create custom workflows by assigning Lambda functions
8412
+ * to user pool triggers.</p>
8413
+ * <p>When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the
8414
+ * function receives as input. This payload contains a <code>clientMetadata</code>
8415
+ * attribute that provides the data that you assigned to the ClientMetadata parameter in
8416
+ * your request. In your function code, you can process the <code>clientMetadata</code>
8417
+ * value to enhance your workflow for your specific needs.</p>
8418
+ * <p>To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-working-with-lambda-triggers.html#lambda-triggers-by-event">
8419
+ * Connecting API actions to Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
8420
+ * <p>The <code>ClientMetadata</code> value is passed as input to the functions for only the
8421
+ * following triggers:</p>
8362
8422
  * <ul>
8363
8423
  * <li>
8364
- * <p>Pre sign-up</p>
8424
+ * <p>Pre signup</p>
8365
8425
  * </li>
8366
8426
  * <li>
8367
8427
  * <p>Pre authentication</p>
@@ -8370,15 +8430,8 @@ export interface InitiateAuthRequest {
8370
8430
  * <p>User migration</p>
8371
8431
  * </li>
8372
8432
  * </ul>
8373
- * <p>When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload as input
8374
- * to the function. This payload contains a <code>validationData</code> attribute with the
8375
- * data that you assigned to the <code>ClientMetadata</code> parameter in your
8376
- * <code>InitiateAuth</code> request. In your function, <code>validationData</code> can
8377
- * contribute to operations that require data that isn't in the default
8378
- * payload.</p>
8379
- * <p>
8380
- * <code>InitiateAuth</code> requests invokes the following triggers without
8381
- * <code>ClientMetadata</code> as input.</p>
8433
+ * <p>This request also invokes the functions for the following triggers, but doesn't pass
8434
+ * <code>ClientMetadata</code>:</p>
8382
8435
  * <ul>
8383
8436
  * <li>
8384
8437
  * <p>Post authentication</p>
@@ -8402,8 +8455,6 @@ export interface InitiateAuthRequest {
8402
8455
  * <p>Custom SMS sender</p>
8403
8456
  * </li>
8404
8457
  * </ul>
8405
- * <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">
8406
- * Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
8407
8458
  * <note>
8408
8459
  * <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
8409
8460
  * following:</p>
@@ -9025,6 +9076,49 @@ export interface ListUserPoolClientsResponse {
9025
9076
  */
9026
9077
  NextToken?: string | undefined;
9027
9078
  }
9079
+ /**
9080
+ * <p>The request to list client secrets for a user pool app client.</p>
9081
+ * @public
9082
+ */
9083
+ export interface ListUserPoolClientSecretsRequest {
9084
+ /**
9085
+ * <p>The ID of the user pool that contains the app client.</p>
9086
+ * @public
9087
+ */
9088
+ UserPoolId: string | undefined;
9089
+ /**
9090
+ * <p>The ID of the app client whose secrets you want to list.</p>
9091
+ * @public
9092
+ */
9093
+ ClientId: string | undefined;
9094
+ /**
9095
+ * <p>This API operation returns a limited number of results. The pagination token is
9096
+ * an identifier that you can present in an additional API request with the same parameters. When
9097
+ * you include the pagination token, Amazon Cognito returns the next set of items after the current list.
9098
+ * Subsequent requests return a new pagination token. By use of this token, you can paginate
9099
+ * through the full list of items.</p>
9100
+ * @public
9101
+ */
9102
+ NextToken?: string | undefined;
9103
+ }
9104
+ /**
9105
+ * <p>The response containing the list of client secret metadata. This response does not include a NextToken field as all secrets are returned in a single response.</p>
9106
+ * @public
9107
+ */
9108
+ export interface ListUserPoolClientSecretsResponse {
9109
+ /**
9110
+ * <p>A list of client secret descriptors containing the identifier and creation date for each secret. For security reasons, the response never reveals the actual secret value in ClientSecretValue.</p>
9111
+ * @public
9112
+ */
9113
+ ClientSecrets?: ClientSecretDescriptorType[] | undefined;
9114
+ /**
9115
+ * <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
9116
+ * you include a pagination token in your request, Amazon Cognito returns the next set of items in
9117
+ * the list. By use of this token, you can paginate through the full list of items.</p>
9118
+ * @public
9119
+ */
9120
+ NextToken?: string | undefined;
9121
+ }
9028
9122
  /**
9029
9123
  * <p>Represents the request to list user pools.</p>
9030
9124
  * @public
@@ -9129,7 +9223,10 @@ export interface ListUsersRequest {
9129
9223
  */
9130
9224
  AttributesToGet?: string[] | undefined;
9131
9225
  /**
9132
- * <p>The maximum number of users that you want Amazon Cognito to return in the response.</p>
9226
+ * <p>The maximum number of users that you want Amazon Cognito to return in the response. In some SDK
9227
+ * contexts, this operation might return fewer items than you specify in the
9228
+ * <code>Limit</code> parameter without having reached the end of the full list. If the
9229
+ * response contains a <code>PaginationToken</code>, then there are more results.</p>
9133
9230
  * @public
9134
9231
  */
9135
9232
  Limit?: number | undefined;
@@ -9244,7 +9341,11 @@ export interface ListUsersRequest {
9244
9341
  */
9245
9342
  export interface ListUsersResponse {
9246
9343
  /**
9247
- * <p>An array of user pool users who match your query, and their attributes.</p>
9344
+ * <p>An array of user pool users who match your query, and their attributes. Between
9345
+ * different requests, you might observe variations in the sequence that users in this
9346
+ * response object are sorted into. The sort order of users isn't guaranteed to follow a
9347
+ * single pattern, but the paginated list from a single chain of requests won't return
9348
+ * duplicates.</p>
9248
9349
  * @public
9249
9350
  */
9250
9351
  Users?: UserType[] | undefined;
@@ -9272,7 +9373,10 @@ export interface ListUsersInGroupRequest {
9272
9373
  */
9273
9374
  GroupName: string | undefined;
9274
9375
  /**
9275
- * <p>The maximum number of groups that you want Amazon Cognito to return in the response.</p>
9376
+ * <p>The maximum number of groups that you want Amazon Cognito to return in the response. In some
9377
+ * SDK contexts, this operation might return fewer items than you specify in the
9378
+ * <code>Limit</code> parameter without having reached the end of the full list. If the
9379
+ * response contains a <code>PaginationToken</code>, then there are more results.</p>
9276
9380
  * @public
9277
9381
  */
9278
9382
  Limit?: number | undefined;
@@ -9431,17 +9535,15 @@ export interface ResendConfirmationCodeRequest {
9431
9535
  AnalyticsMetadata?: AnalyticsMetadataType | undefined;
9432
9536
  /**
9433
9537
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
9434
- * that this action triggers.</p>
9435
- * <p>You create custom workflows by assigning Lambda functions to user pool triggers.
9436
- * When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is
9437
- * assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this
9438
- * function, it passes a JSON payload, which the function receives as input. This payload
9439
- * contains a <code>clientMetadata</code> attribute, which provides the data that you
9440
- * assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your
9441
- * function code in Lambda, you can process the <code>clientMetadata</code> value to enhance
9442
- * your workflow for your specific needs.</p>
9443
- * <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">
9444
- * Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
9538
+ * that this action triggers. You create custom workflows by assigning Lambda functions
9539
+ * to user pool triggers.</p>
9540
+ * <p>When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the
9541
+ * function receives as input. This payload contains a <code>clientMetadata</code>
9542
+ * attribute that provides the data that you assigned to the ClientMetadata parameter in
9543
+ * your request. In your function code, you can process the <code>clientMetadata</code>
9544
+ * value to enhance your workflow for your specific needs.</p>
9545
+ * <p>To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-working-with-lambda-triggers.html#lambda-triggers-by-event">
9546
+ * Connecting API actions to Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
9445
9547
  * <note>
9446
9548
  * <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
9447
9549
  * following:</p>
@@ -9838,21 +9940,15 @@ export interface RespondToAuthChallengeRequest {
9838
9940
  UserContextData?: UserContextDataType | undefined;
9839
9941
  /**
9840
9942
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
9841
- * that this action triggers.</p>
9842
- * <p>You create custom workflows by assigning Lambda functions to user pool
9843
- * triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any
9844
- * functions that are assigned to the following triggers: <i>post
9845
- * authentication</i>, <i>pre token generation</i>,
9846
- * <i>define auth challenge</i>, <i>create auth
9847
- * challenge</i>, and <i>verify auth challenge</i>. When Amazon Cognito
9848
- * invokes any of these functions, it passes a JSON payload, which the function receives as
9849
- * input. This payload contains a <code>clientMetadata</code> attribute, which provides the
9850
- * data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge
9851
- * request. In your function code in Lambda, you can process the
9852
- * <code>clientMetadata</code> value to enhance your workflow for your specific
9853
- * needs.</p>
9854
- * <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">
9855
- * Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
9943
+ * that this action triggers. You create custom workflows by assigning Lambda functions
9944
+ * to user pool triggers.</p>
9945
+ * <p>When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the
9946
+ * function receives as input. This payload contains a <code>clientMetadata</code>
9947
+ * attribute that provides the data that you assigned to the ClientMetadata parameter in
9948
+ * your request. In your function code, you can process the <code>clientMetadata</code>
9949
+ * value to enhance your workflow for your specific needs.</p>
9950
+ * <p>To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-working-with-lambda-triggers.html#lambda-triggers-by-event">
9951
+ * Connecting API actions to Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
9856
9952
  * <note>
9857
9953
  * <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
9858
9954
  * following:</p>
@@ -10395,18 +10491,15 @@ export interface SignUpRequest {
10395
10491
  UserContextData?: UserContextDataType | undefined;
10396
10492
  /**
10397
10493
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
10398
- * that this action triggers.</p>
10399
- * <p>You create custom workflows by assigning Lambda functions to user pool triggers.
10400
- * When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the
10401
- * following triggers: <i>pre sign-up</i>, <i>custom
10402
- * message</i>, and <i>post confirmation</i>. When Amazon Cognito invokes
10403
- * any of these functions, it passes a JSON payload, which the function receives as input.
10404
- * This payload contains a <code>clientMetadata</code> attribute, which provides the data
10405
- * that you assigned to the ClientMetadata parameter in your SignUp request. In your
10406
- * function code in Lambda, you can process the <code>clientMetadata</code> value to enhance
10407
- * your workflow for your specific needs.</p>
10408
- * <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">
10409
- * Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
10494
+ * that this action triggers. You create custom workflows by assigning Lambda functions
10495
+ * to user pool triggers.</p>
10496
+ * <p>When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the
10497
+ * function receives as input. This payload contains a <code>clientMetadata</code>
10498
+ * attribute that provides the data that you assigned to the ClientMetadata parameter in
10499
+ * your request. In your function code, you can process the <code>clientMetadata</code>
10500
+ * value to enhance your workflow for your specific needs.</p>
10501
+ * <p>To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-working-with-lambda-triggers.html#lambda-triggers-by-event">
10502
+ * Connecting API actions to Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
10410
10503
  * <note>
10411
10504
  * <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
10412
10505
  * following:</p>
@@ -10983,316 +11076,3 @@ export interface UpdateResourceServerRequest {
10983
11076
  */
10984
11077
  Scopes?: ResourceServerScopeType[] | undefined;
10985
11078
  }
10986
- /**
10987
- * @public
10988
- */
10989
- export interface UpdateResourceServerResponse {
10990
- /**
10991
- * <p>The updated details of the requested resource server.</p>
10992
- * @public
10993
- */
10994
- ResourceServer: ResourceServerType | undefined;
10995
- }
10996
- /**
10997
- * @public
10998
- */
10999
- export interface UpdateTermsRequest {
11000
- /**
11001
- * <p>The ID of the terms document that you want to update.</p>
11002
- * @public
11003
- */
11004
- TermsId: string | undefined;
11005
- /**
11006
- * <p>The ID of the user pool that contains the terms that you want to update.</p>
11007
- * @public
11008
- */
11009
- UserPoolId: string | undefined;
11010
- /**
11011
- * <p>The new name that you want to apply to the requested terms documents.</p>
11012
- * @public
11013
- */
11014
- TermsName?: string | undefined;
11015
- /**
11016
- * <p>This parameter is reserved for future use and currently accepts only one value.</p>
11017
- * @public
11018
- */
11019
- TermsSource?: TermsSourceType | undefined;
11020
- /**
11021
- * <p>This parameter is reserved for future use and currently accepts only one value.</p>
11022
- * @public
11023
- */
11024
- Enforcement?: TermsEnforcementType | undefined;
11025
- /**
11026
- * <p>A map of URLs to languages. For each localized language that will view the requested
11027
- * <code>TermsName</code>, assign a URL. A selection of <code>cognito:default</code>
11028
- * displays for all languages that don't have a language-specific URL.</p>
11029
- * <p>For example, <code>"cognito:default": "https://terms.example.com", "cognito:spanish":
11030
- * "https://terms.example.com/es"</code>.</p>
11031
- * @public
11032
- */
11033
- Links?: Record<string, string> | undefined;
11034
- }
11035
- /**
11036
- * @public
11037
- */
11038
- export interface UpdateTermsResponse {
11039
- /**
11040
- * <p>A summary of the updates to your terms documents.</p>
11041
- * @public
11042
- */
11043
- Terms?: TermsType | undefined;
11044
- }
11045
- /**
11046
- * <p>Represents the request to update user attributes.</p>
11047
- * @public
11048
- */
11049
- export interface UpdateUserAttributesRequest {
11050
- /**
11051
- * <p>An array of name-value pairs representing user attributes.</p>
11052
- * <p>For custom attributes, you must add a <code>custom:</code> prefix to the attribute
11053
- * name.</p>
11054
- * <p>If you have set an attribute to require verification before Amazon Cognito updates its value,
11055
- * this request doesn’t immediately update the value of that attribute. After your user
11056
- * receives and responds to a verification message to verify the new value, Amazon Cognito updates
11057
- * the attribute value. Your user can sign in and receive messages with the original
11058
- * attribute value until they verify the new value.</p>
11059
- * @public
11060
- */
11061
- UserAttributes: AttributeType[] | undefined;
11062
- /**
11063
- * <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
11064
- * <code>aws.cognito.signin.user.admin</code>.</p>
11065
- * @public
11066
- */
11067
- AccessToken: string | undefined;
11068
- /**
11069
- * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
11070
- * that this action initiates. </p>
11071
- * <p>You create custom workflows by assigning Lambda functions to user pool triggers. When
11072
- * you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned
11073
- * to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it
11074
- * passes a JSON payload, which the function receives as input. This payload contains a
11075
- * <code>clientMetadata</code> attribute, which provides the data that you assigned to
11076
- * the ClientMetadata parameter in your UpdateUserAttributes request. In your function code
11077
- * in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow
11078
- * for your specific needs.</p>
11079
- * <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">
11080
- * Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
11081
- * <note>
11082
- * <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
11083
- * following:</p>
11084
- * <ul>
11085
- * <li>
11086
- * <p>Store the <code>ClientMetadata</code> value. This data is available only
11087
- * to Lambda triggers that are assigned to a user pool to support custom
11088
- * workflows. If your user pool configuration doesn't include triggers, the
11089
- * <code>ClientMetadata</code> parameter serves no purpose.</p>
11090
- * </li>
11091
- * <li>
11092
- * <p>Validate the <code>ClientMetadata</code> value.</p>
11093
- * </li>
11094
- * <li>
11095
- * <p>Encrypt the <code>ClientMetadata</code> value. Don't send sensitive
11096
- * information in this parameter.</p>
11097
- * </li>
11098
- * </ul>
11099
- * </note>
11100
- * @public
11101
- */
11102
- ClientMetadata?: Record<string, string> | undefined;
11103
- }
11104
- /**
11105
- * <p>Represents the response from the server for the request to update user
11106
- * attributes.</p>
11107
- * @public
11108
- */
11109
- export interface UpdateUserAttributesResponse {
11110
- /**
11111
- * <p>When the attribute-update request includes an email address or phone number attribute,
11112
- * Amazon Cognito sends a message to users with a code that confirms ownership of the new value that
11113
- * they entered. The <code>CodeDeliveryDetails</code> object is information about the
11114
- * delivery destination for that link or code. This behavior happens in user pools
11115
- * configured to automatically verify changes to those attributes. For more information,
11116
- * see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#verifying-when-users-change-their-email-or-phone-number">Verifying when users change their email or phone
11117
- * number</a>.</p>
11118
- * @public
11119
- */
11120
- CodeDeliveryDetailsList?: CodeDeliveryDetailsType[] | undefined;
11121
- }
11122
- /**
11123
- * <p>Represents the request to update the user pool.</p>
11124
- * @public
11125
- */
11126
- export interface UpdateUserPoolRequest {
11127
- /**
11128
- * <p>The ID of the user pool you want to update.</p>
11129
- * @public
11130
- */
11131
- UserPoolId: string | undefined;
11132
- /**
11133
- * <p>The password policy and sign-in policy in the user pool. The password policy sets
11134
- * options like password complexity requirements and password history. The sign-in policy
11135
- * 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>
11136
- * @public
11137
- */
11138
- Policies?: UserPoolPolicyType | undefined;
11139
- /**
11140
- * <p>When active, <code>DeletionProtection</code> prevents accidental deletion of your user
11141
- * pool. Before you can delete a user pool that you have protected against deletion, you
11142
- * must deactivate this feature.</p>
11143
- * <p>When you try to delete a protected user pool in a <code>DeleteUserPool</code> API request,
11144
- * Amazon Cognito returns an <code>InvalidParameterException</code> error. To delete a protected user pool,
11145
- * send a new <code>DeleteUserPool</code> request after you deactivate deletion protection in an
11146
- * <code>UpdateUserPool</code> API request.</p>
11147
- * @public
11148
- */
11149
- DeletionProtection?: DeletionProtectionType | undefined;
11150
- /**
11151
- * <p>A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible
11152
- * stages of authentication operations. Triggers can modify the outcome of the operations
11153
- * that invoked them.</p>
11154
- * @public
11155
- */
11156
- LambdaConfig?: LambdaConfigType | undefined;
11157
- /**
11158
- * <p>The attributes that you want your user pool to automatically verify. Possible values:
11159
- * <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>
11160
- * @public
11161
- */
11162
- AutoVerifiedAttributes?: VerifiedAttributeType[] | undefined;
11163
- /**
11164
- * <p>This parameter is no longer used.</p>
11165
- * @public
11166
- */
11167
- SmsVerificationMessage?: string | undefined;
11168
- /**
11169
- * <p>This parameter is no longer used.</p>
11170
- * @public
11171
- */
11172
- EmailVerificationMessage?: string | undefined;
11173
- /**
11174
- * <p>This parameter is no longer used.</p>
11175
- * @public
11176
- */
11177
- EmailVerificationSubject?: string | undefined;
11178
- /**
11179
- * <p>The template for the verification message that your user pool delivers to users who
11180
- * set an email address or phone number attribute.</p>
11181
- * <p>Set the email message type that corresponds to your <code>DefaultEmailOption</code>
11182
- * selection. For <code>CONFIRM_WITH_LINK</code>, specify an
11183
- * <code>EmailMessageByLink</code> and leave <code>EmailMessage</code> blank. For
11184
- * <code>CONFIRM_WITH_CODE</code>, specify an <code>EmailMessage</code> and leave
11185
- * <code>EmailMessageByLink</code> blank. When you supply both parameters with either
11186
- * choice, Amazon Cognito returns an error.</p>
11187
- * @public
11188
- */
11189
- VerificationMessageTemplate?: VerificationMessageTemplateType | undefined;
11190
- /**
11191
- * <p>The contents of the SMS message that your user pool sends to users in SMS
11192
- * authentication.</p>
11193
- * @public
11194
- */
11195
- SmsAuthenticationMessage?: string | undefined;
11196
- /**
11197
- * <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>,
11198
- * a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For
11199
- * more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates">
11200
- * Verifying updates to email addresses and phone numbers</a>.</p>
11201
- * @public
11202
- */
11203
- UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType | undefined;
11204
- /**
11205
- * <p>Sets multi-factor authentication (MFA) to be on, off, or optional. When
11206
- * <code>ON</code>, all users must set up MFA before they can sign in. When
11207
- * <code>OPTIONAL</code>, your application must make a client-side determination of
11208
- * whether a user wants to register an MFA device. For user pools with adaptive
11209
- * authentication with threat protection, choose <code>OPTIONAL</code>.</p>
11210
- * <p>When <code>MfaConfiguration</code> is <code>OPTIONAL</code>, managed login
11211
- * doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in
11212
- * API responses and in managed login for users who have chosen and configured a preferred
11213
- * MFA factor.</p>
11214
- * @public
11215
- */
11216
- MfaConfiguration?: UserPoolMfaType | undefined;
11217
- /**
11218
- * <p>The device-remembering configuration for a user pool. Device remembering or device
11219
- * tracking is a "Remember me on this device" option for user pools that perform
11220
- * authentication with the device key of a trusted device in the back end, instead of a
11221
- * 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
11222
- * you have deactivated device remembering in your user pool.</p>
11223
- * <note>
11224
- * <p>When you provide a value for any <code>DeviceConfiguration</code> field, you
11225
- * activate the Amazon Cognito device-remembering feature. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with devices</a>.</p>
11226
- * </note>
11227
- * @public
11228
- */
11229
- DeviceConfiguration?: DeviceConfigurationType | undefined;
11230
- /**
11231
- * <p>The email configuration of your user pool. The email configuration type sets your
11232
- * preferred sending method, Amazon Web Services Region, and sender for email invitation and verification
11233
- * messages from your user pool.</p>
11234
- * @public
11235
- */
11236
- EmailConfiguration?: EmailConfigurationType | undefined;
11237
- /**
11238
- * <p>The SMS configuration with the settings for your Amazon Cognito user pool to send SMS message
11239
- * with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the
11240
- * Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account. For
11241
- * more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html">SMS message settings</a>.</p>
11242
- * @public
11243
- */
11244
- SmsConfiguration?: SmsConfigurationType | undefined;
11245
- /**
11246
- * <p>The tag keys and values to assign to the user pool. A tag is a label that you can use
11247
- * to categorize and manage user pools in different ways, such as by purpose, owner,
11248
- * environment, or other criteria.</p>
11249
- * @public
11250
- */
11251
- UserPoolTags?: Record<string, string> | undefined;
11252
- /**
11253
- * <p>The configuration for administrative creation of users. Includes the template for the
11254
- * invitation message for new users, the duration of temporary passwords, and permitting
11255
- * self-service sign-up.</p>
11256
- * @public
11257
- */
11258
- AdminCreateUserConfig?: AdminCreateUserConfigType | undefined;
11259
- /**
11260
- * <p>Contains settings for activation of threat protection, including the operating
11261
- * mode and additional authentication types. To log user security information but take
11262
- * no action, set to <code>AUDIT</code>. To configure automatic security responses to
11263
- * potentially unwanted traffic to your user pool, set to <code>ENFORCED</code>.</p>
11264
- * <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">Adding advanced security to a user pool</a>. To activate this setting, your user pool must be on the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html">
11265
- * Plus tier</a>.</p>
11266
- * @public
11267
- */
11268
- UserPoolAddOns?: UserPoolAddOnsType | undefined;
11269
- /**
11270
- * <p>The available verified method a user can use to recover their password when they call
11271
- * <code>ForgotPassword</code>. You can use this setting to define a preferred method
11272
- * when a user has more than one method available. With this setting, SMS doesn't qualify
11273
- * for a valid password recovery mechanism if the user also has SMS multi-factor
11274
- * authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy
11275
- * behavior to determine the recovery method where SMS is preferred through email.</p>
11276
- * @public
11277
- */
11278
- AccountRecoverySetting?: AccountRecoverySettingType | undefined;
11279
- /**
11280
- * <p>The updated name of your user pool.</p>
11281
- * @public
11282
- */
11283
- PoolName?: string | undefined;
11284
- /**
11285
- * <p>The user pool <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html">feature plan</a>, or tier. This parameter determines the
11286
- * eligibility of the user pool for features like managed login, access-token
11287
- * customization, and threat protection. Defaults to <code>ESSENTIALS</code>.</p>
11288
- * @public
11289
- */
11290
- UserPoolTier?: UserPoolTierType | undefined;
11291
- }
11292
- /**
11293
- * <p>Represents the response from the server when you make a request to update the user
11294
- * pool.</p>
11295
- * @public
11296
- */
11297
- export interface UpdateUserPoolResponse {
11298
- }