@aws-sdk/client-cognito-identity-provider 3.650.0 → 3.651.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 (32) hide show
  1. package/dist-cjs/index.js +37 -36
  2. package/dist-es/commands/RespondToAuthChallengeCommand.js +2 -1
  3. package/dist-es/commands/RevokeTokenCommand.js +1 -1
  4. package/dist-es/models/models_0.js +13 -25
  5. package/dist-es/models/models_1.js +14 -1
  6. package/dist-es/protocols/Aws_json1_1.js +3 -3
  7. package/dist-types/commands/AdminCreateUserCommand.d.ts +1 -1
  8. package/dist-types/commands/AdminInitiateAuthCommand.d.ts +6 -2
  9. package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +1 -1
  10. package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +7 -3
  11. package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +9 -5
  12. package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +1 -1
  13. package/dist-types/commands/CreateUserPoolCommand.d.ts +1 -1
  14. package/dist-types/commands/ForgotPasswordCommand.d.ts +1 -1
  15. package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +1 -1
  16. package/dist-types/commands/GetUserPoolMfaConfigCommand.d.ts +4 -0
  17. package/dist-types/commands/InitiateAuthCommand.d.ts +6 -2
  18. package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +1 -1
  19. package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +9 -4
  20. package/dist-types/commands/RevokeTokenCommand.d.ts +1 -2
  21. package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +4 -0
  22. package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +9 -1
  23. package/dist-types/commands/SignUpCommand.d.ts +1 -1
  24. package/dist-types/commands/UpdateUserAttributesCommand.d.ts +1 -1
  25. package/dist-types/commands/UpdateUserPoolCommand.d.ts +1 -1
  26. package/dist-types/models/models_0.d.ts +139 -95
  27. package/dist-types/models/models_1.d.ts +96 -9
  28. package/dist-types/ts3.4/commands/RespondToAuthChallengeCommand.d.ts +2 -4
  29. package/dist-types/ts3.4/commands/RevokeTokenCommand.d.ts +1 -2
  30. package/dist-types/ts3.4/models/models_0.d.ts +21 -27
  31. package/dist-types/ts3.4/models/models_1.d.ts +24 -0
  32. package/package.json +1 -1
@@ -1402,7 +1402,7 @@ export interface AdminGetUserResponse {
1402
1402
  PreferredMfaSetting?: string;
1403
1403
  /**
1404
1404
  * <p>The MFA options that are activated for the user. The possible values in this list are
1405
- * <code>SMS_MFA</code> and <code>SOFTWARE_TOKEN_MFA</code>.</p>
1405
+ * <code>SMS_MFA</code>, <code>EMAIL_OTP</code>, and <code>SOFTWARE_TOKEN_MFA</code>.</p>
1406
1406
  * @public
1407
1407
  */
1408
1408
  UserMFASettingList?: string[];
@@ -1733,6 +1733,7 @@ export declare const ChallengeNameType: {
1733
1733
  readonly CUSTOM_CHALLENGE: "CUSTOM_CHALLENGE";
1734
1734
  readonly DEVICE_PASSWORD_VERIFIER: "DEVICE_PASSWORD_VERIFIER";
1735
1735
  readonly DEVICE_SRP_AUTH: "DEVICE_SRP_AUTH";
1736
+ readonly EMAIL_OTP: "EMAIL_OTP";
1736
1737
  readonly MFA_SETUP: "MFA_SETUP";
1737
1738
  readonly NEW_PASSWORD_REQUIRED: "NEW_PASSWORD_REQUIRED";
1738
1739
  readonly PASSWORD_VERIFIER: "PASSWORD_VERIFIER";
@@ -1764,13 +1765,21 @@ export interface AdminInitiateAuthResponse {
1764
1765
  * <li>
1765
1766
  * <p>
1766
1767
  * <code>SELECT_MFA_TYPE</code>: Selects the MFA type. Valid MFA options are
1767
- * <code>SMS_MFA</code> for text SMS MFA, and <code>SOFTWARE_TOKEN_MFA</code>
1768
- * for time-based one-time password (TOTP) software token MFA.</p>
1768
+ * <code>SMS_MFA</code> for SMS message MFA, <code>EMAIL_OTP</code> for email
1769
+ * message MFA, and <code>SOFTWARE_TOKEN_MFA</code> for time-based one-time
1770
+ * password (TOTP) software token MFA.</p>
1769
1771
  * </li>
1770
1772
  * <li>
1771
1773
  * <p>
1772
1774
  * <code>SMS_MFA</code>: Next challenge is to supply an
1773
- * <code>SMS_MFA_CODE</code>, delivered via SMS.</p>
1775
+ * <code>SMS_MFA_CODE</code>that your user pool delivered
1776
+ * in an SMS message.</p>
1777
+ * </li>
1778
+ * <li>
1779
+ * <p>
1780
+ * <code>EMAIL_OTP</code>: Next challenge is to supply an
1781
+ * <code>EMAIL_OTP_CODE</code> that your user pool delivered
1782
+ * in an email message.</p>
1774
1783
  * </li>
1775
1784
  * <li>
1776
1785
  * <p>
@@ -1867,6 +1876,19 @@ export interface AdminInitiateAuthResponse {
1867
1876
  */
1868
1877
  AuthenticationResult?: AuthenticationResultType;
1869
1878
  }
1879
+ /**
1880
+ * <p>This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP
1881
+ * status code: 400.</p>
1882
+ * @public
1883
+ */
1884
+ export declare class InvalidEmailRoleAccessPolicyException extends __BaseException {
1885
+ readonly name: "InvalidEmailRoleAccessPolicyException";
1886
+ readonly $fault: "client";
1887
+ /**
1888
+ * @internal
1889
+ */
1890
+ constructor(opts: __ExceptionOptionType<InvalidEmailRoleAccessPolicyException, __BaseException>);
1891
+ }
1870
1892
  /**
1871
1893
  * <p>This exception is thrown when Amazon Cognito can't find a multi-factor authentication
1872
1894
  * (MFA) method.</p>
@@ -2503,19 +2525,6 @@ export interface AdminResetUserPasswordRequest {
2503
2525
  */
2504
2526
  export interface AdminResetUserPasswordResponse {
2505
2527
  }
2506
- /**
2507
- * <p>This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP
2508
- * status code: 400.</p>
2509
- * @public
2510
- */
2511
- export declare class InvalidEmailRoleAccessPolicyException extends __BaseException {
2512
- readonly name: "InvalidEmailRoleAccessPolicyException";
2513
- readonly $fault: "client";
2514
- /**
2515
- * @internal
2516
- */
2517
- constructor(opts: __ExceptionOptionType<InvalidEmailRoleAccessPolicyException, __BaseException>);
2518
- }
2519
2528
  /**
2520
2529
  * <p>The request to respond to the authentication challenge, as an administrator.</p>
2521
2530
  * @public
@@ -2549,11 +2558,22 @@ export interface AdminRespondToAuthChallengeRequest {
2549
2558
  * <dd>
2550
2559
  * <p>
2551
2560
  * <code>"ChallengeName": "SMS_MFA", "ChallengeResponses": \{"SMS_MFA_CODE":
2552
- * "[SMS_code]", "USERNAME": "[username]"\}</code>
2561
+ * "[code]", "USERNAME": "[username]"\}</code>
2562
+ * </p>
2563
+ * </dd>
2564
+ * <dt>EMAIL_OTP</dt>
2565
+ * <dd>
2566
+ * <p>
2567
+ * <code>"ChallengeName": "EMAIL_OTP", "ChallengeResponses": \{"EMAIL_OTP_CODE":
2568
+ * "[code]", "USERNAME": "[username]"\}</code>
2553
2569
  * </p>
2554
2570
  * </dd>
2555
2571
  * <dt>PASSWORD_VERIFIER</dt>
2556
2572
  * <dd>
2573
+ * <p>This challenge response is part of the SRP flow. Amazon Cognito requires
2574
+ * that your application respond to this challenge within a few seconds. When
2575
+ * the response time exceeds this period, your user pool returns a
2576
+ * <code>NotAuthorizedException</code> error.</p>
2557
2577
  * <p>
2558
2578
  * <code>"ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses":
2559
2579
  * \{"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]",
@@ -2801,6 +2821,27 @@ export declare class SoftwareTokenMFANotFoundException extends __BaseException {
2801
2821
  */
2802
2822
  constructor(opts: __ExceptionOptionType<SoftwareTokenMFANotFoundException, __BaseException>);
2803
2823
  }
2824
+ /**
2825
+ * <p>User preferences for multi-factor authentication with email messages. Activates or
2826
+ * deactivates email MFA and sets it as the preferred MFA method when multiple methods are
2827
+ * available. To activate this setting, <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">
2828
+ * advanced security features</a> must be active in your user pool.</p>
2829
+ * @public
2830
+ */
2831
+ export interface EmailMfaSettingsType {
2832
+ /**
2833
+ * <p>Specifies whether email message MFA is active for a user. When the value of this
2834
+ * parameter is <code>Enabled</code>, the user will be prompted for MFA during all sign-in
2835
+ * attempts, unless device tracking is turned on and the device has been trusted.</p>
2836
+ * @public
2837
+ */
2838
+ Enabled?: boolean;
2839
+ /**
2840
+ * <p>Specifies whether email message MFA is the user's preferred method.</p>
2841
+ * @public
2842
+ */
2843
+ PreferredMfa?: boolean;
2844
+ }
2804
2845
  /**
2805
2846
  * <p>The type used for enabling SMS multi-factor authentication (MFA) at the user level.
2806
2847
  * Phone numbers don't need to be verified to be used for SMS MFA. If an MFA type is
@@ -2812,7 +2853,7 @@ export declare class SoftwareTokenMFANotFoundException extends __BaseException {
2812
2853
  */
2813
2854
  export interface SMSMfaSettingsType {
2814
2855
  /**
2815
- * <p>Specifies whether SMS text message MFA is activated. If an MFA type is activated for a
2856
+ * <p>Specifies whether SMS message MFA is activated. If an MFA type is activated for a
2816
2857
  * user, the user will be prompted for MFA during all sign-in attempts, unless device
2817
2858
  * tracking is turned on and the device has been trusted.</p>
2818
2859
  * @public
@@ -2851,15 +2892,25 @@ export interface SoftwareTokenMfaSettingsType {
2851
2892
  */
2852
2893
  export interface AdminSetUserMFAPreferenceRequest {
2853
2894
  /**
2854
- * <p>The SMS text message MFA settings.</p>
2895
+ * <p>User preferences for SMS message MFA. Activates or deactivates SMS MFA and sets it as
2896
+ * the preferred MFA method when multiple methods are available.</p>
2855
2897
  * @public
2856
2898
  */
2857
2899
  SMSMfaSettings?: SMSMfaSettingsType;
2858
2900
  /**
2859
- * <p>The time-based one-time password software token MFA settings.</p>
2901
+ * <p>User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates
2902
+ * TOTP MFA and sets it as the preferred MFA method when multiple methods are
2903
+ * available.</p>
2860
2904
  * @public
2861
2905
  */
2862
2906
  SoftwareTokenMfaSettings?: SoftwareTokenMfaSettingsType;
2907
+ /**
2908
+ * <p>User preferences for email message MFA. Activates or deactivates email MFA and sets it
2909
+ * as the preferred MFA method when multiple methods are available. To activate this setting, <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">
2910
+ * advanced security features</a> must be active in your user pool.</p>
2911
+ * @public
2912
+ */
2913
+ EmailMfaSettings?: EmailMfaSettingsType;
2863
2914
  /**
2864
2915
  * <p>The username of the user that you want to query or modify. The value of this parameter
2865
2916
  * is typically your user's username, but it can be any of their alias attributes. If
@@ -2870,7 +2921,7 @@ export interface AdminSetUserMFAPreferenceRequest {
2870
2921
  */
2871
2922
  Username: string | undefined;
2872
2923
  /**
2873
- * <p>The user pool ID.</p>
2924
+ * <p>The ID of the user pool where you want to set a user's MFA preferences.</p>
2874
2925
  * @public
2875
2926
  */
2876
2927
  UserPoolId: string | undefined;
@@ -5547,7 +5598,7 @@ export interface CreateUserPoolClientRequest {
5547
5598
  */
5548
5599
  TokenValidityUnits?: TokenValidityUnitsType;
5549
5600
  /**
5550
- * <p>The list of user attributes that you want your app client to have read-only access to.
5601
+ * <p>The list of user attributes that you want your app client to have read access to.
5551
5602
  * After your user authenticates in your app, their access token authorizes them to read
5552
5603
  * their own attribute value for any attribute in this list. An example of this kind of
5553
5604
  * activity is when your user selects a link to view their profile information. Your app
@@ -5556,7 +5607,7 @@ export interface CreateUserPoolClientRequest {
5556
5607
  * <p>When you don't specify the <code>ReadAttributes</code> for your app client, your
5557
5608
  * app can read the values of <code>email_verified</code>,
5558
5609
  * <code>phone_number_verified</code>, and the Standard attributes of your user pool.
5559
- * When your user pool has read access to these default attributes,
5610
+ * When your user pool app client has read access to these default attributes,
5560
5611
  * <code>ReadAttributes</code> doesn't return any information. Amazon Cognito only
5561
5612
  * populates <code>ReadAttributes</code> in the API response if you have specified your own
5562
5613
  * custom set of read attributes.</p>
@@ -5906,7 +5957,7 @@ export interface UserPoolClientType {
5906
5957
  */
5907
5958
  TokenValidityUnits?: TokenValidityUnitsType;
5908
5959
  /**
5909
- * <p>The list of user attributes that you want your app client to have read-only access to.
5960
+ * <p>The list of user attributes that you want your app client to have read access to.
5910
5961
  * After your user authenticates in your app, their access token authorizes them to read
5911
5962
  * their own attribute value for any attribute in this list. An example of this kind of
5912
5963
  * activity is when your user selects a link to view their profile information. Your app
@@ -5915,7 +5966,7 @@ export interface UserPoolClientType {
5915
5966
  * <p>When you don't specify the <code>ReadAttributes</code> for your app client, your
5916
5967
  * app can read the values of <code>email_verified</code>,
5917
5968
  * <code>phone_number_verified</code>, and the Standard attributes of your user pool.
5918
- * When your user pool has read access to these default attributes,
5969
+ * When your user pool app client has read access to these default attributes,
5919
5970
  * <code>ReadAttributes</code> doesn't return any information. Amazon Cognito only
5920
5971
  * populates <code>ReadAttributes</code> in the API response if you have specified your own
5921
5972
  * custom set of read attributes.</p>
@@ -7287,7 +7338,7 @@ export interface GetUserResponse {
7287
7338
  PreferredMfaSetting?: string;
7288
7339
  /**
7289
7340
  * <p>The MFA options that are activated for the user. The possible values in this list are
7290
- * <code>SMS_MFA</code> and <code>SOFTWARE_TOKEN_MFA</code>.</p>
7341
+ * <code>SMS_MFA</code>, <code>EMAIL_OTP</code>, and <code>SOFTWARE_TOKEN_MFA</code>.</p>
7291
7342
  * @public
7292
7343
  */
7293
7344
  UserMFASettingList?: string[];
@@ -7369,14 +7420,38 @@ export interface GetUserPoolMfaConfigRequest {
7369
7420
  UserPoolId: string | undefined;
7370
7421
  }
7371
7422
  /**
7372
- * <p>The SMS text message multi-factor authentication (MFA) configuration type.</p>
7423
+ * <p>Sets or shows user pool email message configuration for MFA. Includes the subject and
7424
+ * body of the email message template for MFA messages. To activate this setting, <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">
7425
+ * advanced security features</a> must be active in your user pool.</p>
7426
+ * @public
7427
+ */
7428
+ export interface EmailMfaConfigType {
7429
+ /**
7430
+ * <p>The template for the email message that your user pool sends to users with an MFA
7431
+ * code. The message must contain the <code>\{####\}</code> placeholder. In the message,
7432
+ * Amazon Cognito replaces this placeholder with the code. If you don't provide this parameter,
7433
+ * Amazon Cognito sends messages in the default format.</p>
7434
+ * @public
7435
+ */
7436
+ Message?: string;
7437
+ /**
7438
+ * <p>The subject of the email message that your user pool sends to users with an MFA
7439
+ * code.</p>
7440
+ * @public
7441
+ */
7442
+ Subject?: string;
7443
+ }
7444
+ /**
7445
+ * <p>Configures user pool SMS messages for multi-factor authentication (MFA). Sets the
7446
+ * message template and the SMS message sending configuration for Amazon SNS.</p>
7373
7447
  * @public
7374
7448
  */
7375
7449
  export interface SmsMfaConfigType {
7376
7450
  /**
7377
- * <p>The SMS authentication message that will be sent to users with the code they must sign
7378
- * in. The message must contain the ‘\{####\} placeholder, which is replaced with the code.
7379
- * If the message isn't included, and default message will be used.</p>
7451
+ * <p>The SMS message that your user pool sends to users with an MFA code. The message must
7452
+ * contain the <code>\{####\}</code> placeholder. In the message, Amazon Cognito replaces this
7453
+ * placeholder with the code. If you don't provide this parameter, Amazon Cognito sends
7454
+ * messages in the default format.</p>
7380
7455
  * @public
7381
7456
  */
7382
7457
  SmsAuthenticationMessage?: string;
@@ -7390,7 +7465,8 @@ export interface SmsMfaConfigType {
7390
7465
  SmsConfiguration?: SmsConfigurationType;
7391
7466
  }
7392
7467
  /**
7393
- * <p>The type used for enabling software token MFA at the user pool level.</p>
7468
+ * <p>Configures a user pool for time-based one-time password (TOTP) multi-factor
7469
+ * authentication (MFA). Enables or disables TOTP.</p>
7394
7470
  * @public
7395
7471
  */
7396
7472
  export interface SoftwareTokenMfaConfigType {
@@ -7405,15 +7481,24 @@ export interface SoftwareTokenMfaConfigType {
7405
7481
  */
7406
7482
  export interface GetUserPoolMfaConfigResponse {
7407
7483
  /**
7408
- * <p>The SMS text message multi-factor authentication (MFA) configuration.</p>
7484
+ * <p>Shows user pool SMS message configuration for MFA. Includes the message template and
7485
+ * the SMS message sending configuration for Amazon SNS.</p>
7409
7486
  * @public
7410
7487
  */
7411
7488
  SmsMfaConfiguration?: SmsMfaConfigType;
7412
7489
  /**
7413
- * <p>The software token multi-factor authentication (MFA) configuration.</p>
7490
+ * <p>Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes
7491
+ * TOTP enabled or disabled state.</p>
7414
7492
  * @public
7415
7493
  */
7416
7494
  SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType;
7495
+ /**
7496
+ * <p>Shows user pool email message configuration for MFA. Includes the subject and body of
7497
+ * the email message template for MFA messages. To activate this setting, <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">
7498
+ * advanced security features</a> must be active in your user pool.</p>
7499
+ * @public
7500
+ */
7501
+ EmailMfaConfiguration?: EmailMfaConfigType;
7417
7502
  /**
7418
7503
  * <p>The multi-factor authentication (MFA) configuration. Valid values include:</p>
7419
7504
  * <ul>
@@ -7645,7 +7730,14 @@ export interface InitiateAuthResponse {
7645
7730
  * <li>
7646
7731
  * <p>
7647
7732
  * <code>SMS_MFA</code>: Next challenge is to supply an
7648
- * <code>SMS_MFA_CODE</code>, delivered via SMS.</p>
7733
+ * <code>SMS_MFA_CODE</code>that your user pool delivered
7734
+ * in an SMS message.</p>
7735
+ * </li>
7736
+ * <li>
7737
+ * <p>
7738
+ * <code>EMAIL_OTP</code>: Next challenge is to supply an
7739
+ * <code>EMAIL_OTP_CODE</code> that your user pool delivered
7740
+ * in an email message.</p>
7649
7741
  * </li>
7650
7742
  * <li>
7651
7743
  * <p>
@@ -8436,11 +8528,22 @@ export interface RespondToAuthChallengeRequest {
8436
8528
  * <dd>
8437
8529
  * <p>
8438
8530
  * <code>"ChallengeName": "SMS_MFA", "ChallengeResponses": \{"SMS_MFA_CODE":
8439
- * "[SMS_code]", "USERNAME": "[username]"\}</code>
8531
+ * "[code]", "USERNAME": "[username]"\}</code>
8532
+ * </p>
8533
+ * </dd>
8534
+ * <dt>EMAIL_OTP</dt>
8535
+ * <dd>
8536
+ * <p>
8537
+ * <code>"ChallengeName": "EMAIL_OTP", "ChallengeResponses": \{"EMAIL_OTP_CODE":
8538
+ * "[code]", "USERNAME": "[username]"\}</code>
8440
8539
  * </p>
8441
8540
  * </dd>
8442
8541
  * <dt>PASSWORD_VERIFIER</dt>
8443
8542
  * <dd>
8543
+ * <p>This challenge response is part of the SRP flow. Amazon Cognito requires
8544
+ * that your application respond to this challenge within a few seconds. When
8545
+ * the response time exceeds this period, your user pool returns a
8546
+ * <code>NotAuthorizedException</code> error.</p>
8444
8547
  * <p>
8445
8548
  * <code>"ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses":
8446
8549
  * \{"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]",
@@ -8576,57 +8679,6 @@ export interface RespondToAuthChallengeRequest {
8576
8679
  */
8577
8680
  ClientMetadata?: Record<string, string>;
8578
8681
  }
8579
- /**
8580
- * <p>The response to respond to the authentication challenge.</p>
8581
- * @public
8582
- */
8583
- export interface RespondToAuthChallengeResponse {
8584
- /**
8585
- * <p>The challenge name. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a>.</p>
8586
- * @public
8587
- */
8588
- ChallengeName?: ChallengeNameType;
8589
- /**
8590
- * <p>The session that should be passed both ways in challenge-response calls to the
8591
- * service. If the caller must pass another challenge, they return a session with other
8592
- * challenge parameters. This session should be passed as it is to the next
8593
- * <code>RespondToAuthChallenge</code> API call.</p>
8594
- * @public
8595
- */
8596
- Session?: string;
8597
- /**
8598
- * <p>The challenge parameters. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a>.</p>
8599
- * @public
8600
- */
8601
- ChallengeParameters?: Record<string, string>;
8602
- /**
8603
- * <p>The result returned by the server in response to the request to respond to the
8604
- * authentication challenge.</p>
8605
- * @public
8606
- */
8607
- AuthenticationResult?: AuthenticationResultType;
8608
- }
8609
- /**
8610
- * @public
8611
- */
8612
- export interface RevokeTokenRequest {
8613
- /**
8614
- * <p>The refresh token that you want to revoke.</p>
8615
- * @public
8616
- */
8617
- Token: string | undefined;
8618
- /**
8619
- * <p>The client ID for the token that you want to revoke.</p>
8620
- * @public
8621
- */
8622
- ClientId: string | undefined;
8623
- /**
8624
- * <p>The secret for the client ID. This is required only if the client ID has a
8625
- * secret.</p>
8626
- * @public
8627
- */
8628
- ClientSecret?: string;
8629
- }
8630
8682
  /**
8631
8683
  * @internal
8632
8684
  */
@@ -8915,11 +8967,3 @@ export declare const ResendConfirmationCodeRequestFilterSensitiveLog: (obj: Rese
8915
8967
  * @internal
8916
8968
  */
8917
8969
  export declare const RespondToAuthChallengeRequestFilterSensitiveLog: (obj: RespondToAuthChallengeRequest) => any;
8918
- /**
8919
- * @internal
8920
- */
8921
- export declare const RespondToAuthChallengeResponseFilterSensitiveLog: (obj: RespondToAuthChallengeResponse) => any;
8922
- /**
8923
- * @internal
8924
- */
8925
- export declare const RevokeTokenRequestFilterSensitiveLog: (obj: RevokeTokenRequest) => any;
@@ -1,6 +1,57 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { CognitoIdentityProviderServiceException as __BaseException } from "./CognitoIdentityProviderServiceException";
3
- import { AccountRecoverySettingType, AccountTakeoverRiskConfigurationType, AdminCreateUserConfigType, AnalyticsConfigurationType, AnalyticsMetadataType, AttributeType, CodeDeliveryDetailsType, CompromisedCredentialsRiskConfigurationType, CustomDomainConfigType, DeletionProtectionType, DeviceConfigurationType, DeviceRememberedStatusType, EmailConfigurationType, ExplicitAuthFlowsType, FeedbackValueType, GroupType, IdentityProviderType, LambdaConfigType, LogConfigurationType, LogDeliveryConfigurationType, MFAOptionType, OAuthFlowType, PreventUserExistenceErrorTypes, ResourceServerScopeType, ResourceServerType, RiskConfigurationType, RiskExceptionConfigurationType, SmsConfigurationType, SmsMfaConfigType, SMSMfaSettingsType, SoftwareTokenMfaConfigType, SoftwareTokenMfaSettingsType, TokenValidityUnitsType, UICustomizationType, UserAttributeUpdateSettingsType, UserContextDataType, UserImportJobType, UserPoolAddOnsType, UserPoolClientType, UserPoolMfaType, UserPoolPolicyType, VerificationMessageTemplateType, VerifiedAttributeType } from "./models_0";
3
+ import { AccountRecoverySettingType, AccountTakeoverRiskConfigurationType, AdminCreateUserConfigType, AnalyticsConfigurationType, AnalyticsMetadataType, AttributeType, AuthenticationResultType, ChallengeNameType, CodeDeliveryDetailsType, CompromisedCredentialsRiskConfigurationType, CustomDomainConfigType, DeletionProtectionType, DeviceConfigurationType, DeviceRememberedStatusType, EmailConfigurationType, EmailMfaConfigType, EmailMfaSettingsType, ExplicitAuthFlowsType, FeedbackValueType, GroupType, IdentityProviderType, LambdaConfigType, LogConfigurationType, LogDeliveryConfigurationType, MFAOptionType, OAuthFlowType, PreventUserExistenceErrorTypes, ResourceServerScopeType, ResourceServerType, RiskConfigurationType, RiskExceptionConfigurationType, SmsConfigurationType, SmsMfaConfigType, SMSMfaSettingsType, SoftwareTokenMfaConfigType, SoftwareTokenMfaSettingsType, TokenValidityUnitsType, UICustomizationType, UserAttributeUpdateSettingsType, UserContextDataType, UserImportJobType, UserPoolAddOnsType, UserPoolClientType, UserPoolMfaType, UserPoolPolicyType, VerificationMessageTemplateType, VerifiedAttributeType } from "./models_0";
4
+ /**
5
+ * <p>The response to respond to the authentication challenge.</p>
6
+ * @public
7
+ */
8
+ export interface RespondToAuthChallengeResponse {
9
+ /**
10
+ * <p>The challenge name. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a>.</p>
11
+ * @public
12
+ */
13
+ ChallengeName?: ChallengeNameType;
14
+ /**
15
+ * <p>The session that should be passed both ways in challenge-response calls to the
16
+ * service. If the caller must pass another challenge, they return a session with other
17
+ * challenge parameters. This session should be passed as it is to the next
18
+ * <code>RespondToAuthChallenge</code> API call.</p>
19
+ * @public
20
+ */
21
+ Session?: string;
22
+ /**
23
+ * <p>The challenge parameters. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a>.</p>
24
+ * @public
25
+ */
26
+ ChallengeParameters?: Record<string, string>;
27
+ /**
28
+ * <p>The result returned by the server in response to the request to respond to the
29
+ * authentication challenge.</p>
30
+ * @public
31
+ */
32
+ AuthenticationResult?: AuthenticationResultType;
33
+ }
34
+ /**
35
+ * @public
36
+ */
37
+ export interface RevokeTokenRequest {
38
+ /**
39
+ * <p>The refresh token that you want to revoke.</p>
40
+ * @public
41
+ */
42
+ Token: string | undefined;
43
+ /**
44
+ * <p>The client ID for the token that you want to revoke.</p>
45
+ * @public
46
+ */
47
+ ClientId: string | undefined;
48
+ /**
49
+ * <p>The secret for the client ID. This is required only if the client ID has a
50
+ * secret.</p>
51
+ * @public
52
+ */
53
+ ClientSecret?: string;
54
+ }
4
55
  /**
5
56
  * @public
6
57
  */
@@ -155,15 +206,25 @@ export interface SetUICustomizationResponse {
155
206
  */
156
207
  export interface SetUserMFAPreferenceRequest {
157
208
  /**
158
- * <p>The SMS text message multi-factor authentication (MFA) settings.</p>
209
+ * <p>User preferences for SMS message MFA. Activates or deactivates SMS MFA and sets it as
210
+ * the preferred MFA method when multiple methods are available.</p>
159
211
  * @public
160
212
  */
161
213
  SMSMfaSettings?: SMSMfaSettingsType;
162
214
  /**
163
- * <p>The time-based one-time password (TOTP) software token MFA settings.</p>
215
+ * <p>User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates
216
+ * TOTP MFA and sets it as the preferred MFA method when multiple methods are
217
+ * available.</p>
164
218
  * @public
165
219
  */
166
220
  SoftwareTokenMfaSettings?: SoftwareTokenMfaSettingsType;
221
+ /**
222
+ * <p>User preferences for email message MFA. Activates or deactivates email MFA and sets it
223
+ * as the preferred MFA method when multiple methods are available. To activate this setting, <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">
224
+ * advanced security features</a> must be active in your user pool.</p>
225
+ * @public
226
+ */
227
+ EmailMfaSettings?: EmailMfaSettingsType;
167
228
  /**
168
229
  * <p>A valid access token that Amazon Cognito issued to the user whose MFA preference you want to
169
230
  * set.</p>
@@ -186,15 +247,24 @@ export interface SetUserPoolMfaConfigRequest {
186
247
  */
187
248
  UserPoolId: string | undefined;
188
249
  /**
189
- * <p>The SMS text message MFA configuration.</p>
250
+ * <p>Configures user pool SMS messages for MFA. Sets the message template and the SMS
251
+ * message sending configuration for Amazon SNS.</p>
190
252
  * @public
191
253
  */
192
254
  SmsMfaConfiguration?: SmsMfaConfigType;
193
255
  /**
194
- * <p>The software token MFA configuration.</p>
256
+ * <p>Configures a user pool for time-based one-time password (TOTP) MFA. Enables or
257
+ * disables TOTP.</p>
195
258
  * @public
196
259
  */
197
260
  SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType;
261
+ /**
262
+ * <p>Configures user pool email messages for MFA. Sets the subject and body of the email
263
+ * message template for MFA messages. To activate this setting, <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">
264
+ * advanced security features</a> must be active in your user pool.</p>
265
+ * @public
266
+ */
267
+ EmailMfaConfiguration?: EmailMfaConfigType;
198
268
  /**
199
269
  * <p>The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who
200
270
  * have set up an MFA factor can sign in. To learn more, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html">Adding Multi-Factor
@@ -223,15 +293,24 @@ export interface SetUserPoolMfaConfigRequest {
223
293
  */
224
294
  export interface SetUserPoolMfaConfigResponse {
225
295
  /**
226
- * <p>The SMS text message MFA configuration.</p>
296
+ * <p>Shows user pool SMS message configuration for MFA. Includes the message template and
297
+ * the SMS message sending configuration for Amazon SNS.</p>
227
298
  * @public
228
299
  */
229
300
  SmsMfaConfiguration?: SmsMfaConfigType;
230
301
  /**
231
- * <p>The software token MFA configuration.</p>
302
+ * <p>Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes
303
+ * TOTP enabled or disabled state.</p>
232
304
  * @public
233
305
  */
234
306
  SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType;
307
+ /**
308
+ * <p>Shows user pool email message configuration for MFA. Includes the subject and body of
309
+ * the email message template for MFA messages. To activate this setting, <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">
310
+ * advanced security features</a> must be active in your user pool.</p>
311
+ * @public
312
+ */
313
+ EmailMfaConfiguration?: EmailMfaConfigType;
235
314
  /**
236
315
  * <p>The MFA configuration. Valid values include:</p>
237
316
  * <ul>
@@ -1112,7 +1191,7 @@ export interface UpdateUserPoolClientRequest {
1112
1191
  */
1113
1192
  TokenValidityUnits?: TokenValidityUnitsType;
1114
1193
  /**
1115
- * <p>The list of user attributes that you want your app client to have read-only access to.
1194
+ * <p>The list of user attributes that you want your app client to have read access to.
1116
1195
  * After your user authenticates in your app, their access token authorizes them to read
1117
1196
  * their own attribute value for any attribute in this list. An example of this kind of
1118
1197
  * activity is when your user selects a link to view their profile information. Your app
@@ -1121,7 +1200,7 @@ export interface UpdateUserPoolClientRequest {
1121
1200
  * <p>When you don't specify the <code>ReadAttributes</code> for your app client, your
1122
1201
  * app can read the values of <code>email_verified</code>,
1123
1202
  * <code>phone_number_verified</code>, and the Standard attributes of your user pool.
1124
- * When your user pool has read access to these default attributes,
1203
+ * When your user pool app client has read access to these default attributes,
1125
1204
  * <code>ReadAttributes</code> doesn't return any information. Amazon Cognito only
1126
1205
  * populates <code>ReadAttributes</code> in the API response if you have specified your own
1127
1206
  * custom set of read attributes.</p>
@@ -1522,6 +1601,14 @@ export interface VerifyUserAttributeRequest {
1522
1601
  */
1523
1602
  export interface VerifyUserAttributeResponse {
1524
1603
  }
1604
+ /**
1605
+ * @internal
1606
+ */
1607
+ export declare const RespondToAuthChallengeResponseFilterSensitiveLog: (obj: RespondToAuthChallengeResponse) => any;
1608
+ /**
1609
+ * @internal
1610
+ */
1611
+ export declare const RevokeTokenRequestFilterSensitiveLog: (obj: RevokeTokenRequest) => any;
1525
1612
  /**
1526
1613
  * @internal
1527
1614
  */
@@ -5,10 +5,8 @@ import {
5
5
  ServiceInputTypes,
6
6
  ServiceOutputTypes,
7
7
  } from "../CognitoIdentityProviderClient";
8
- import {
9
- RespondToAuthChallengeRequest,
10
- RespondToAuthChallengeResponse,
11
- } from "../models/models_0";
8
+ import { RespondToAuthChallengeRequest } from "../models/models_0";
9
+ import { RespondToAuthChallengeResponse } from "../models/models_1";
12
10
  export { __MetadataBearer };
13
11
  export { $Command };
14
12
  export interface RespondToAuthChallengeCommandInput
@@ -5,8 +5,7 @@ import {
5
5
  ServiceInputTypes,
6
6
  ServiceOutputTypes,
7
7
  } from "../CognitoIdentityProviderClient";
8
- import { RevokeTokenRequest } from "../models/models_0";
9
- import { RevokeTokenResponse } from "../models/models_1";
8
+ import { RevokeTokenRequest, RevokeTokenResponse } from "../models/models_1";
10
9
  export { __MetadataBearer };
11
10
  export { $Command };
12
11
  export interface RevokeTokenCommandInput extends RevokeTokenRequest {}