@aws-sdk/client-cognito-identity-provider 3.53.0 → 3.55.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 (148) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/dist-cjs/CognitoIdentityProviderClient.js +12 -12
  3. package/dist-cjs/commands/AddCustomAttributesCommand.js +4 -4
  4. package/dist-cjs/commands/AdminAddUserToGroupCommand.js +4 -4
  5. package/dist-cjs/commands/AdminConfirmSignUpCommand.js +4 -4
  6. package/dist-cjs/commands/AdminCreateUserCommand.js +4 -4
  7. package/dist-cjs/commands/AdminDeleteUserAttributesCommand.js +4 -4
  8. package/dist-cjs/commands/AdminDeleteUserCommand.js +4 -4
  9. package/dist-cjs/commands/AdminDisableProviderForUserCommand.js +4 -4
  10. package/dist-cjs/commands/AdminDisableUserCommand.js +4 -4
  11. package/dist-cjs/commands/AdminEnableUserCommand.js +4 -4
  12. package/dist-cjs/commands/AdminForgetDeviceCommand.js +4 -4
  13. package/dist-cjs/commands/AdminGetDeviceCommand.js +4 -4
  14. package/dist-cjs/commands/AdminGetUserCommand.js +4 -4
  15. package/dist-cjs/commands/AdminInitiateAuthCommand.js +4 -4
  16. package/dist-cjs/commands/AdminLinkProviderForUserCommand.js +4 -4
  17. package/dist-cjs/commands/AdminListDevicesCommand.js +4 -4
  18. package/dist-cjs/commands/AdminListGroupsForUserCommand.js +4 -4
  19. package/dist-cjs/commands/AdminListUserAuthEventsCommand.js +4 -4
  20. package/dist-cjs/commands/AdminRemoveUserFromGroupCommand.js +4 -4
  21. package/dist-cjs/commands/AdminResetUserPasswordCommand.js +4 -4
  22. package/dist-cjs/commands/AdminRespondToAuthChallengeCommand.js +4 -4
  23. package/dist-cjs/commands/AdminSetUserMFAPreferenceCommand.js +4 -4
  24. package/dist-cjs/commands/AdminSetUserPasswordCommand.js +4 -4
  25. package/dist-cjs/commands/AdminSetUserSettingsCommand.js +4 -4
  26. package/dist-cjs/commands/AdminUpdateAuthEventFeedbackCommand.js +4 -4
  27. package/dist-cjs/commands/AdminUpdateDeviceStatusCommand.js +4 -4
  28. package/dist-cjs/commands/AdminUpdateUserAttributesCommand.js +4 -4
  29. package/dist-cjs/commands/AdminUserGlobalSignOutCommand.js +4 -4
  30. package/dist-cjs/commands/AssociateSoftwareTokenCommand.js +4 -4
  31. package/dist-cjs/commands/ChangePasswordCommand.js +3 -3
  32. package/dist-cjs/commands/ConfirmDeviceCommand.js +4 -4
  33. package/dist-cjs/commands/ConfirmForgotPasswordCommand.js +3 -3
  34. package/dist-cjs/commands/ConfirmSignUpCommand.js +3 -3
  35. package/dist-cjs/commands/CreateGroupCommand.js +4 -4
  36. package/dist-cjs/commands/CreateIdentityProviderCommand.js +4 -4
  37. package/dist-cjs/commands/CreateResourceServerCommand.js +4 -4
  38. package/dist-cjs/commands/CreateUserImportJobCommand.js +4 -4
  39. package/dist-cjs/commands/CreateUserPoolClientCommand.js +4 -4
  40. package/dist-cjs/commands/CreateUserPoolCommand.js +4 -4
  41. package/dist-cjs/commands/CreateUserPoolDomainCommand.js +4 -4
  42. package/dist-cjs/commands/DeleteGroupCommand.js +4 -4
  43. package/dist-cjs/commands/DeleteIdentityProviderCommand.js +4 -4
  44. package/dist-cjs/commands/DeleteResourceServerCommand.js +4 -4
  45. package/dist-cjs/commands/DeleteUserAttributesCommand.js +3 -3
  46. package/dist-cjs/commands/DeleteUserCommand.js +3 -3
  47. package/dist-cjs/commands/DeleteUserPoolClientCommand.js +4 -4
  48. package/dist-cjs/commands/DeleteUserPoolCommand.js +4 -4
  49. package/dist-cjs/commands/DeleteUserPoolDomainCommand.js +4 -4
  50. package/dist-cjs/commands/DescribeIdentityProviderCommand.js +4 -4
  51. package/dist-cjs/commands/DescribeResourceServerCommand.js +4 -4
  52. package/dist-cjs/commands/DescribeRiskConfigurationCommand.js +4 -4
  53. package/dist-cjs/commands/DescribeUserImportJobCommand.js +4 -4
  54. package/dist-cjs/commands/DescribeUserPoolClientCommand.js +4 -4
  55. package/dist-cjs/commands/DescribeUserPoolCommand.js +4 -4
  56. package/dist-cjs/commands/DescribeUserPoolDomainCommand.js +4 -4
  57. package/dist-cjs/commands/ForgetDeviceCommand.js +4 -4
  58. package/dist-cjs/commands/ForgotPasswordCommand.js +3 -3
  59. package/dist-cjs/commands/GetCSVHeaderCommand.js +4 -4
  60. package/dist-cjs/commands/GetDeviceCommand.js +4 -4
  61. package/dist-cjs/commands/GetGroupCommand.js +4 -4
  62. package/dist-cjs/commands/GetIdentityProviderByIdentifierCommand.js +4 -4
  63. package/dist-cjs/commands/GetSigningCertificateCommand.js +4 -4
  64. package/dist-cjs/commands/GetUICustomizationCommand.js +4 -4
  65. package/dist-cjs/commands/GetUserAttributeVerificationCodeCommand.js +3 -3
  66. package/dist-cjs/commands/GetUserCommand.js +3 -3
  67. package/dist-cjs/commands/GetUserPoolMfaConfigCommand.js +4 -4
  68. package/dist-cjs/commands/GlobalSignOutCommand.js +4 -4
  69. package/dist-cjs/commands/InitiateAuthCommand.js +3 -3
  70. package/dist-cjs/commands/ListDevicesCommand.js +4 -4
  71. package/dist-cjs/commands/ListGroupsCommand.js +4 -4
  72. package/dist-cjs/commands/ListIdentityProvidersCommand.js +4 -4
  73. package/dist-cjs/commands/ListResourceServersCommand.js +4 -4
  74. package/dist-cjs/commands/ListTagsForResourceCommand.js +4 -4
  75. package/dist-cjs/commands/ListUserImportJobsCommand.js +4 -4
  76. package/dist-cjs/commands/ListUserPoolClientsCommand.js +4 -4
  77. package/dist-cjs/commands/ListUserPoolsCommand.js +4 -4
  78. package/dist-cjs/commands/ListUsersCommand.js +4 -4
  79. package/dist-cjs/commands/ListUsersInGroupCommand.js +4 -4
  80. package/dist-cjs/commands/ResendConfirmationCodeCommand.js +3 -3
  81. package/dist-cjs/commands/RespondToAuthChallengeCommand.js +3 -3
  82. package/dist-cjs/commands/RevokeTokenCommand.js +4 -4
  83. package/dist-cjs/commands/SetRiskConfigurationCommand.js +4 -4
  84. package/dist-cjs/commands/SetUICustomizationCommand.js +4 -4
  85. package/dist-cjs/commands/SetUserMFAPreferenceCommand.js +4 -4
  86. package/dist-cjs/commands/SetUserPoolMfaConfigCommand.js +4 -4
  87. package/dist-cjs/commands/SetUserSettingsCommand.js +3 -3
  88. package/dist-cjs/commands/SignUpCommand.js +3 -3
  89. package/dist-cjs/commands/StartUserImportJobCommand.js +4 -4
  90. package/dist-cjs/commands/StopUserImportJobCommand.js +4 -4
  91. package/dist-cjs/commands/TagResourceCommand.js +4 -4
  92. package/dist-cjs/commands/UntagResourceCommand.js +4 -4
  93. package/dist-cjs/commands/UpdateAuthEventFeedbackCommand.js +4 -4
  94. package/dist-cjs/commands/UpdateDeviceStatusCommand.js +4 -4
  95. package/dist-cjs/commands/UpdateGroupCommand.js +4 -4
  96. package/dist-cjs/commands/UpdateIdentityProviderCommand.js +4 -4
  97. package/dist-cjs/commands/UpdateResourceServerCommand.js +4 -4
  98. package/dist-cjs/commands/UpdateUserAttributesCommand.js +3 -3
  99. package/dist-cjs/commands/UpdateUserPoolClientCommand.js +4 -4
  100. package/dist-cjs/commands/UpdateUserPoolCommand.js +4 -4
  101. package/dist-cjs/commands/UpdateUserPoolDomainCommand.js +4 -4
  102. package/dist-cjs/commands/VerifySoftwareTokenCommand.js +4 -4
  103. package/dist-cjs/commands/VerifyUserAttributeCommand.js +3 -3
  104. package/dist-cjs/endpoints.js +1 -1
  105. package/dist-cjs/protocols/Aws_json1_1.js +447 -448
  106. package/dist-cjs/runtimeConfig.browser.js +4 -4
  107. package/dist-cjs/runtimeConfig.js +9 -9
  108. package/dist-cjs/runtimeConfig.native.js +1 -1
  109. package/dist-es/CognitoIdentityProvider.js +101 -101
  110. package/dist-es/pagination/AdminListGroupsForUserPaginator.js +4 -4
  111. package/dist-es/pagination/AdminListUserAuthEventsPaginator.js +4 -4
  112. package/dist-es/pagination/ListGroupsPaginator.js +4 -4
  113. package/dist-es/pagination/ListIdentityProvidersPaginator.js +4 -4
  114. package/dist-es/pagination/ListResourceServersPaginator.js +4 -4
  115. package/dist-es/pagination/ListUserPoolClientsPaginator.js +4 -4
  116. package/dist-es/pagination/ListUserPoolsPaginator.js +4 -4
  117. package/dist-es/pagination/ListUsersInGroupPaginator.js +4 -4
  118. package/dist-es/pagination/ListUsersPaginator.js +4 -4
  119. package/dist-es/protocols/Aws_json1_1.js +7 -10
  120. package/dist-types/CognitoIdentityProvider.d.ts +261 -250
  121. package/dist-types/CognitoIdentityProviderClient.d.ts +2 -2
  122. package/dist-types/commands/AdminCreateUserCommand.d.ts +18 -16
  123. package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +7 -4
  124. package/dist-types/commands/AdminInitiateAuthCommand.d.ts +17 -16
  125. package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +17 -17
  126. package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +17 -16
  127. package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +17 -16
  128. package/dist-types/commands/CreateUserPoolCommand.d.ts +17 -17
  129. package/dist-types/commands/ForgotPasswordCommand.d.ts +17 -17
  130. package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +17 -17
  131. package/dist-types/commands/InitiateAuthCommand.d.ts +17 -16
  132. package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +17 -17
  133. package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +17 -16
  134. package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +15 -14
  135. package/dist-types/commands/SignUpCommand.d.ts +17 -17
  136. package/dist-types/commands/UpdateUserAttributesCommand.d.ts +17 -17
  137. package/dist-types/commands/UpdateUserPoolCommand.d.ts +17 -17
  138. package/dist-types/models/models_0.d.ts +352 -213
  139. package/dist-types/models/models_1.d.ts +21 -12
  140. package/dist-types/runtimeConfig.browser.d.ts +1 -1
  141. package/dist-types/runtimeConfig.d.ts +1 -1
  142. package/dist-types/runtimeConfig.native.d.ts +3 -3
  143. package/dist-types/ts3.4/CognitoIdentityProviderClient.d.ts +2 -2
  144. package/dist-types/ts3.4/models/models_0.d.ts +2 -0
  145. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
  146. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
  147. package/dist-types/ts3.4/runtimeConfig.native.d.ts +3 -3
  148. package/package.json +34 -34
@@ -54,7 +54,8 @@ export interface AccountTakeoverActionType {
54
54
  */
55
55
  Notify: boolean | undefined;
56
56
  /**
57
- * <p>The event action.</p>
57
+ * <p>The action to take in response to the account takeover action. Valid values
58
+ * are:</p>
58
59
  *
59
60
  * <ul>
60
61
  * <li>
@@ -417,14 +418,17 @@ export interface AdminConfirmSignUpRequest {
417
418
  Username: string | undefined;
418
419
  /**
419
420
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
420
- * <p>If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the Lambda function that is specified
421
- * for the <i>post confirmation</i> trigger. When Amazon Cognito invokes this function, it passes a
422
- * JSON
423
- * payload, which the function receives as input. In this payload, the <code>clientMetadata</code> attribute provides the data that you assigned
424
- * to the ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in Lambda, you can process the ClientMetadata value
425
- * to enhance your workflow for your specific needs.</p>
426
- * <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">Customizing User Pool Workflows
427
- * with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
421
+ * <p>If your user pool configuration includes triggers, the AdminConfirmSignUp API action
422
+ * invokes the Lambda function that is specified for the <i>post
423
+ * confirmation</i> trigger. When Amazon Cognito invokes this function, it passes a JSON
424
+ * payload, which the function receives as input. In this payload, the
425
+ * <code>clientMetadata</code> attribute provides the data that you assigned to the
426
+ * ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in
427
+ * Lambda, you can process the ClientMetadata value to enhance your workflow for your
428
+ * specific needs.</p>
429
+ *
430
+ * <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">
431
+ * Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
428
432
  *
429
433
  * <note>
430
434
  * <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
@@ -623,9 +627,10 @@ export interface AdminCreateUserRequest {
623
627
  * it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute,
624
628
  * which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code
625
629
  * in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
626
- * <p>For more information,
627
- * see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">Customizing User Pool Workflows with Lambda Triggers</a>
628
- * in the <i>Amazon Cognito Developer Guide</i>.</p>
630
+ *
631
+ * <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">
632
+ * Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
633
+ *
629
634
  * <note>
630
635
  * <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
631
636
  * <ul>
@@ -654,8 +659,9 @@ export declare namespace AdminCreateUserRequest {
654
659
  }
655
660
  /**
656
661
  * <p>
657
- * <i>This data type is no longer supported.</i> You can use it
658
- * only for SMS multi-factor authentication (MFA) configurations. You can't use it for time-based one-time password (TOTP) software token MFA configurations.</p>
662
+ * <i>This data type is no longer supported.</i> Applies only to SMS
663
+ * multi-factor authentication (MFA) configurations. Does not apply to time-based one-time
664
+ * password (TOTP) software token MFA configurations.</p>
659
665
  */
660
666
  export interface MFAOptionType {
661
667
  /**
@@ -720,9 +726,6 @@ export interface UserType {
720
726
  * <p>ARCHIVED - User is no longer active.</p>
721
727
  * </li>
722
728
  * <li>
723
- * <p>COMPROMISED - User is disabled due to a potential security threat.</p>
724
- * </li>
725
- * <li>
726
729
  * <p>UNKNOWN - User status isn't known.</p>
727
730
  * </li>
728
731
  * <li>
@@ -818,8 +821,7 @@ export declare class PreconditionNotMetException extends __BaseException {
818
821
  constructor(opts: __ExceptionOptionType<PreconditionNotMetException, __BaseException>);
819
822
  }
820
823
  /**
821
- * <p>The request failed because the user is in an unsupported
822
- * state.</p>
824
+ * <p>The request failed because the user is in an unsupported state.</p>
823
825
  */
824
826
  export declare class UnsupportedUserStateException extends __BaseException {
825
827
  readonly name: "UnsupportedUserStateException";
@@ -1226,9 +1228,6 @@ export interface AdminGetUserResponse {
1226
1228
  * <p>ARCHIVED - User is no longer active.</p>
1227
1229
  * </li>
1228
1230
  * <li>
1229
- * <p>COMPROMISED - User is disabled due to a potential security threat.</p>
1230
- * </li>
1231
- * <li>
1232
1231
  * <p>UNKNOWN - User status isn't known.</p>
1233
1232
  * </li>
1234
1233
  * <li>
@@ -1266,7 +1265,9 @@ export declare namespace AdminGetUserResponse {
1266
1265
  * <p>An Amazon Pinpoint analytics endpoint.</p>
1267
1266
  * <p>An endpoint uniquely identifies a mobile device, email address, or phone number that can receive messages from Amazon Pinpoint analytics.</p>
1268
1267
  * <note>
1269
- * <p>Amazon Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region in which the user pool resides.</p>
1268
+ * <p>Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N.
1269
+ * Virginia) us-east-1 Region, regardless of the Region where the user pool
1270
+ * resides.</p>
1270
1271
  * </note>
1271
1272
  */
1272
1273
  export interface AnalyticsMetadataType {
@@ -1436,10 +1437,12 @@ export interface AdminInitiateAuthRequest {
1436
1437
  * <p>User migration</p>
1437
1438
  * </li>
1438
1439
  * </ul>
1439
- * <p>When Amazon Cognito invokes the functions for these triggers, it passes a JSON
1440
- * payload, which the function receives as input. This payload contains a <code>validationData</code> attribute, which provides the data that you assigned to the
1441
- * ClientMetadata parameter in your AdminInitiateAuth request. In your function code in Lambda, you can process the <code>validationData</code> value to enhance
1442
- * your workflow for your specific needs.</p>
1440
+ * <p>When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which
1441
+ * the function receives as input. This payload contains a <code>validationData</code>
1442
+ * attribute, which provides the data that you assigned to the ClientMetadata parameter in
1443
+ * your AdminInitiateAuth request. In your function code in Lambda, you can process the
1444
+ * <code>validationData</code> value to enhance your workflow for your specific
1445
+ * needs.</p>
1443
1446
  * <p>When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:</p>
1444
1447
  * <ul>
1445
1448
  * <li>
@@ -1461,8 +1464,9 @@ export interface AdminInitiateAuthRequest {
1461
1464
  * <p>Verify auth challenge</p>
1462
1465
  * </li>
1463
1466
  * </ul>
1464
- * <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">Customizing User Pool Workflows with
1465
- * Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
1467
+ *
1468
+ * <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">
1469
+ * Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
1466
1470
  *
1467
1471
  * <note>
1468
1472
  * <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
@@ -1692,9 +1696,11 @@ export interface AdminLinkProviderForUserRequest {
1692
1696
  */
1693
1697
  UserPoolId: string | undefined;
1694
1698
  /**
1695
- * <p>The existing user in the user pool to be linked to the external identity provider user account. Can be a native (Username + Password) Amazon Cognito User Pools user or a federated user
1696
- * (for example, a SAML or Facebook user). If the user doesn't exist, an exception is thrown. This is the user that is returned when the new user (with the linked identity provider
1697
- * attribute) signs in.</p>
1699
+ * <p>The existing user in the user pool that you want to assign to the external identity
1700
+ * provider user account. This user can be a native (Username + Password) Amazon Cognito user pools
1701
+ * user or a federated user (for example, a SAML or Facebook user). If the user doesn't
1702
+ * exist, Amazon Cognito generates an exception. Amazon Cognito returns this user when the new user (with the
1703
+ * linked identity provider attribute) signs in.</p>
1698
1704
  * <p>For a native username + password user, the <code>ProviderAttributeValue</code> for the <code>DestinationUser</code> should be the username in the user pool. For a federated user,
1699
1705
  * it should be the provider-specific <code>user_id</code>.</p>
1700
1706
  * <p>The <code>ProviderAttributeName</code> of the <code>DestinationUser</code> is ignored.</p>
@@ -2126,8 +2132,9 @@ export interface AdminResetUserPasswordRequest {
2126
2132
  * ClientMetadata parameter in your AdminResetUserPassword request. In your function code in Lambda, you can process the <code>clientMetadata</code>
2127
2133
  * value to enhance your workflow for your specific needs.
2128
2134
  * </p>
2129
- * <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">Customizing User Pool
2130
- * Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
2135
+ *
2136
+ * <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">
2137
+ * Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
2131
2138
  *
2132
2139
  * <note>
2133
2140
  * <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
@@ -2247,16 +2254,44 @@ export interface AdminRespondToAuthChallengeRequest {
2247
2254
  ContextData?: ContextDataType;
2248
2255
  /**
2249
2256
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
2250
- * <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminRespondToAuthChallenge API action, Amazon Cognito
2251
- * invokes any functions that are assigned to the
2252
- * following triggers: <i>pre sign-up</i>, <i>custom message</i>, <i>post authentication</i>,
2253
- * <i>user migration</i>, <i>pre token generation</i>, <i>define auth challenge</i>, <i>create auth
2254
- * challenge</i>, and <i>verify auth challenge response</i>. When Amazon Cognito invokes any of these functions, it passes a JSON
2255
- * payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned
2256
- * to the ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your function code in Lambda, you can process the
2257
- * <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
2258
- * <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">Customizing User Pool Workflows with
2259
- * Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
2257
+ * <p>You create custom workflows by assigning Lambda functions to user pool triggers.
2258
+ * When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions
2259
+ * that you have assigned to the following triggers: </p>
2260
+ * <ul>
2261
+ * <li>
2262
+ * <p>pre sign-up</p>
2263
+ * </li>
2264
+ * <li>
2265
+ * <p>custom message</p>
2266
+ * </li>
2267
+ * <li>
2268
+ * <p>post authentication</p>
2269
+ * </li>
2270
+ * <li>
2271
+ * <p>user migration</p>
2272
+ * </li>
2273
+ * <li>
2274
+ * <p>pre token generation</p>
2275
+ * </li>
2276
+ * <li>
2277
+ * <p>define auth challenge</p>
2278
+ * </li>
2279
+ * <li>
2280
+ * <p>create auth challenge</p>
2281
+ * </li>
2282
+ * <li>
2283
+ * <p>verify auth challenge response</p>
2284
+ * </li>
2285
+ * </ul>
2286
+ * <p>When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the
2287
+ * function receives as input. This payload contains a <code>clientMetadata</code>
2288
+ * attribute that provides the data that you assigned to the ClientMetadata parameter in
2289
+ * your AdminRespondToAuthChallenge request. In your function code in Lambda, you can
2290
+ * process the <code>clientMetadata</code> value to enhance your workflow for your specific
2291
+ * needs.</p>
2292
+ *
2293
+ * <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">
2294
+ * Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
2260
2295
  *
2261
2296
  * <note>
2262
2297
  * <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
@@ -2589,9 +2624,9 @@ export interface AdminUpdateUserAttributesRequest {
2589
2624
  * as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your
2590
2625
  * AdminUpdateUserAttributes request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for
2591
2626
  * your specific needs.</p>
2592
- * <p>For more information,
2593
- * see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">Customizing User Pool Workflows with Lambda Triggers</a>
2594
- * in the <i>Amazon Cognito Developer Guide</i>.</p>
2627
+ *
2628
+ * <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">
2629
+ * Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
2595
2630
  *
2596
2631
  * <note>
2597
2632
  * <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
@@ -2673,8 +2708,9 @@ export declare enum AliasAttributeType {
2673
2708
  /**
2674
2709
  * <p>The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.</p>
2675
2710
  * <note>
2676
- * <p>In Regions where Pinpoint isn't available, User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In Regions where Pinpoint is available, User Pools will support
2677
- * sending events to Amazon Pinpoint projects within that same Region. </p>
2711
+ * <p>In Regions where Amazon Pinpointisn't available, user pools only support sending events to Amazon Pinpoint
2712
+ * projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support
2713
+ * sending events to Amazon Pinpoint projects within that same Region.</p>
2678
2714
  * </note>
2679
2715
  */
2680
2716
  export interface AnalyticsConfigurationType {
@@ -2683,8 +2719,9 @@ export interface AnalyticsConfigurationType {
2683
2719
  */
2684
2720
  ApplicationId?: string;
2685
2721
  /**
2686
- * <p>The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project for integration with the chosen User Pool Client. Amazon Cognito publishes events to the Amazon Pinpointproject
2687
- * declared by the app ARN.</p>
2722
+ * <p>The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project
2723
+ * to integrate with the chosen user pool Client. Amazon Cognito publishes events to the
2724
+ * Amazon Pinpointproject declared by the app ARN.</p>
2688
2725
  */
2689
2726
  ApplicationArn?: string;
2690
2727
  /**
@@ -2894,15 +2931,17 @@ export interface ConfirmForgotPasswordRequest {
2894
2931
  UserContextData?: UserContextDataType;
2895
2932
  /**
2896
2933
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
2897
- * <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito
2898
- * invokes the function that is assigned to the <i>post confirmation</i> trigger. When Amazon Cognito invokes this function, it passes a
2899
- * JSON payload,
2900
- * which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned
2901
- * to the ClientMetadata parameter in your ConfirmForgotPassword request. In your function code in Lambda, you can process the
2902
- * <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
2903
- * <p>For more information,
2904
- * see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">Customizing User Pool Workflows with Lambda Triggers</a>
2905
- * in the <i>Amazon Cognito Developer Guide</i>.</p>
2934
+ * <p>You create custom workflows by assigning Lambda functions to user pool triggers.
2935
+ * When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is
2936
+ * assigned to the <i>post confirmation</i> trigger. When Amazon Cognito invokes this
2937
+ * function, it passes a JSON payload, which the function receives as input. This payload
2938
+ * contains a <code>clientMetadata</code> attribute, which provides the data that you
2939
+ * assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your
2940
+ * function code in Lambda, you can process the <code>clientMetadata</code> value to
2941
+ * enhance your workflow for your specific needs.</p>
2942
+ *
2943
+ * <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">
2944
+ * Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
2906
2945
  *
2907
2946
  * <note>
2908
2947
  * <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
@@ -2984,9 +3023,9 @@ export interface ConfirmSignUpRequest {
2984
3023
  * function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which
2985
3024
  * provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda,
2986
3025
  * you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
2987
- * <p>For more information,
2988
- * see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">Customizing User Pool Workflows with Lambda Triggers</a>
2989
- * in the <i>Amazon Cognito Developer Guide</i>.</p>
3026
+ *
3027
+ * <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">
3028
+ * Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
2990
3029
  *
2991
3030
  * <note>
2992
3031
  * <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
@@ -3671,11 +3710,14 @@ export declare enum EmailSendingAccountType {
3671
3710
  DEVELOPER = "DEVELOPER"
3672
3711
  }
3673
3712
  /**
3674
- * <p>The email configuration type.</p>
3675
- * <note>
3676
- * <p>Amazon Cognito has specific Regions for use with Amazon Simple Email Service. For more information on the supported Regions, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html">Email
3677
- * settings for Amazon Cognito user pools</a>.</p>
3678
- * </note>
3713
+ * <p>The email configuration of your user pool. The email configuration type sets your
3714
+ * preferred sending method, Amazon Web Services Region, and sender for messages from your user
3715
+ * pool.</p>
3716
+ * <note>
3717
+ * <p>Amazon Cognito can send email messages with Amazon Simple Email Service resources in the Amazon Web Services Region where you
3718
+ * created your user pool, and in alternate Regions in some cases. For more information
3719
+ * on the supported Regions, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html">Email settings for Amazon Cognito user pools</a>.</p>
3720
+ * </note>
3679
3721
  */
3680
3722
  export interface EmailConfigurationType {
3681
3723
  /**
@@ -3689,6 +3731,10 @@ export interface EmailConfigurationType {
3689
3731
  * <p>If you specify <code>DEVELOPER</code>, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.</p>
3690
3732
  * </li>
3691
3733
  * </ul>
3734
+ * <p>The Region value of the <code>SourceArn</code> parameter must indicate a supported
3735
+ * Amazon Web Services Region of your user pool. Typically, the Region in the <code>SourceArn</code> and
3736
+ * the user pool Region are the same. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html#user-pool-email-developer-region-mapping">Amazon SES email configuration regions</a> in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html">Amazon Cognito Developer
3737
+ * Guide</a>.</p>
3692
3738
  */
3693
3739
  SourceArn?: string;
3694
3740
  /**
@@ -3696,7 +3742,9 @@ export interface EmailConfigurationType {
3696
3742
  */
3697
3743
  ReplyToEmailAddress?: string;
3698
3744
  /**
3699
- * <p>Specifies whether Amazon Cognito emails your users by using its built-in email functionality or your Amazon Simple Email Service email configuration. Specify one of the following values:</p>
3745
+ * <p>Specifies whether Amazon Cognito uses its built-in functionality to send your users email
3746
+ * messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following
3747
+ * values:</p>
3700
3748
  * <dl>
3701
3749
  * <dt>COGNITO_DEFAULT</dt>
3702
3750
  * <dd>
@@ -3760,20 +3808,26 @@ export interface EmailConfigurationType {
3760
3808
  */
3761
3809
  From?: string;
3762
3810
  /**
3763
- * <p>The set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. A configuration set is applied to an email by including a reference to the configuration
3764
- * set in the headers of the email. Once applied, all of the rules in that configuration set are applied to the email. Configuration sets can be used to apply the following
3811
+ * <p>The set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. A
3812
+ * configuration set is applied to an email by including a reference to the configuration
3813
+ * set in the headers of the email. Once applied, all of the rules in that configuration
3814
+ * set are applied to the email. Configuration sets can be used to apply the following
3765
3815
  * types of rules to emails: </p>
3766
- *
3767
- * <ul>
3768
- * <li>
3769
- * <p>Event publishing – Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing
3770
- * to send information about these events to other Amazon Web Services services such as and Amazon CloudWatch.</p>
3771
- * </li>
3772
- * <li>
3773
- * <p>IP pool management – When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then
3774
- * associate the dedicated IP pools with configuration sets.</p>
3775
- * </li>
3776
- * </ul>
3816
+ * <dl>
3817
+ * <dt>Event publishing</dt>
3818
+ * <dd>
3819
+ * <p>Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and
3820
+ * complaint events for each email sent. Use event publishing to send
3821
+ * information about these events to other Amazon Web Services services such as and
3822
+ * Amazon CloudWatch</p>
3823
+ * </dd>
3824
+ * <dt>IP pool management</dt>
3825
+ * <dd>
3826
+ * <p>When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups
3827
+ * of IP addresses, called dedicated IP pools. You can then associate the
3828
+ * dedicated IP pools with configuration sets.</p>
3829
+ * </dd>
3830
+ * </dl>
3777
3831
  */
3778
3832
  ConfigurationSet?: string;
3779
3833
  }
@@ -3950,8 +4004,10 @@ export declare namespace UserPoolPolicyType {
3950
4004
  const filterSensitiveLog: (obj: UserPoolPolicyType) => any;
3951
4005
  }
3952
4006
  /**
3953
- * <p>The SMS configuration type that includes the settings the Amazon Cognito User Pool must call for the Amazon Simple Notification Service service to send an SMS message from your Amazon Web Services account. The
3954
- * Amazon Cognito User Pool makes the request to the Amazon SNS Service by using an Identity and Access Management role that you provide for your Amazon Web Services account.</p>
4007
+ * <p>The SMS configuration type is the settings that your Amazon Cognito user pool must use to send
4008
+ * an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS
4009
+ * messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an
4010
+ * Identity and Access Management (IAM) role in your Amazon Web Services account.</p>
3955
4011
  */
3956
4012
  export interface SmsConfigurationType {
3957
4013
  /**
@@ -3960,15 +4016,30 @@ export interface SmsConfigurationType {
3960
4016
  */
3961
4017
  SnsCallerArn: string | undefined;
3962
4018
  /**
3963
- * <p>The external ID is a value that you should use to add security to your IAM role that is used to call Amazon SNS to send SMS messages for your user pool. If you provide an <code>ExternalId</code>,
3964
- * the Amazon Cognito User Pool will include it when attempting to assume your IAM role so that you can set your roles trust policy to require the <code>ExternalID</code>. If you use the Amazon Cognito Management
3965
- * Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito will create a role with the required permissions and a trust policy that demonstrates use of the <code>ExternalId</code>.</p>
4019
+ * <p>The external ID provides additional security for your IAM role. You can use an
4020
+ * <code>ExternalId</code> with the IAM role that you use with Amazon SNS to send SMS
4021
+ * messages for your user pool. If you provide an <code>ExternalId</code>, your Amazon Cognito user
4022
+ * pool includes it in the request to assume your IAM role. You can configure the role
4023
+ * trust policy to require that Amazon Cognito, and any principal, provide the
4024
+ * <code>ExternalID</code>. If you use the Amazon Cognito Management Console to create a role
4025
+ * for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required
4026
+ * permissions and a trust policy that demonstrates use of the
4027
+ * <code>ExternalId</code>.</p>
3966
4028
  * <p>For more information about the <code>ExternalId</code> of a role,
3967
4029
  * see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html">How to use an external ID when granting access to your Amazon Web Services resources to a
3968
4030
  * third party</a>
3969
4031
  * </p>
3970
4032
  */
3971
4033
  ExternalId?: string;
4034
+ /**
4035
+ * <p>The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your
4036
+ * user pool, or a supported <b>Legacy Amazon SNS alternate
4037
+ * Region</b>. </p>
4038
+ * <p>
4039
+ * Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS
4040
+ * configuration in the Asia Pacific (Tokyo) Region. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html">SMS message settings for Amazon Cognito user pools</a>.</p>
4041
+ */
4042
+ SnsRegion?: string;
3972
4043
  }
3973
4044
  export declare namespace SmsConfigurationType {
3974
4045
  /**
@@ -3985,26 +4056,25 @@ export declare enum UsernameAttributeType {
3985
4056
  */
3986
4057
  export interface UsernameConfigurationType {
3987
4058
  /**
3988
- * <p>Specifies whether username case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs.</p>
4059
+ * <p>Specifies whether username case sensitivity will be applied for all users in the user
4060
+ * pool through Amazon Cognito APIs.</p>
3989
4061
  * <p>Valid values include:</p>
3990
- *
3991
- * <ul>
3992
- * <li>
3993
- * <p>
3994
- * <b>
3995
- * <code>True</code>
3996
- * </b>: Enables case sensitivity for all username input. When this option is set to <code>True</code>,
3997
- * users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value.</p>
3998
- * </li>
3999
- * <li>
4000
- * <p>
4001
- * <b>
4002
- * <code>False</code>
4003
- * </b>: Enables case insensitivity for all username input. For example, when this option is set to
4004
- * <code>False</code>, users can sign in using either "username" or "Username". This option also enables both <code>preferred_username</code> and <code>email</code>
4005
- * alias to be case insensitive, in addition to the <code>username</code> attribute.</p>
4006
- * </li>
4007
- * </ul>
4062
+ * <dl>
4063
+ * <dt>True</dt>
4064
+ * <dd>
4065
+ * <p>Enables case sensitivity for all username input. When this option is set
4066
+ * to <code>True</code>, users must sign in using the exact capitalization of
4067
+ * their given username, such as “UserName”. This is the default value.</p>
4068
+ * </dd>
4069
+ * <dt>False</dt>
4070
+ * <dd>
4071
+ * <p>Enables case insensitivity for all username input. For example, when this
4072
+ * option is set to <code>False</code>, users can sign in using either
4073
+ * "username" or "Username". This option also enables both
4074
+ * <code>preferred_username</code> and <code>email</code> alias to be case
4075
+ * insensitive, in addition to the <code>username</code> attribute.</p>
4076
+ * </dd>
4077
+ * </dl>
4008
4078
  */
4009
4079
  CaseSensitive: boolean | undefined;
4010
4080
  }
@@ -4140,11 +4210,16 @@ export interface CreateUserPoolRequest {
4140
4210
  */
4141
4211
  DeviceConfiguration?: DeviceConfigurationType;
4142
4212
  /**
4143
- * <p>The email configuration.</p>
4213
+ * <p>The email configuration of your user pool. The email configuration type sets your
4214
+ * preferred sending method, Amazon Web Services Region, and sender for messages from your user
4215
+ * pool.</p>
4144
4216
  */
4145
4217
  EmailConfiguration?: EmailConfigurationType;
4146
4218
  /**
4147
- * <p>The SMS configuration.</p>
4219
+ * <p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an
4220
+ * SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages
4221
+ * with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management
4222
+ * (IAM) role in your Amazon Web Services account.</p>
4148
4223
  */
4149
4224
  SmsConfiguration?: SmsConfigurationType;
4150
4225
  /**
@@ -4286,11 +4361,16 @@ export interface UserPoolType {
4286
4361
  */
4287
4362
  EstimatedNumberOfUsers?: number;
4288
4363
  /**
4289
- * <p>The email configuration.</p>
4364
+ * <p>The email configuration of your user pool. The email configuration type sets your
4365
+ * preferred sending method, Amazon Web Services Region, and sender for messages tfrom your user
4366
+ * pool.</p>
4290
4367
  */
4291
4368
  EmailConfiguration?: EmailConfigurationType;
4292
4369
  /**
4293
- * <p>The SMS configuration.</p>
4370
+ * <p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an
4371
+ * SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages
4372
+ * with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management
4373
+ * (IAM) role in your Amazon Web Services account.</p>
4294
4374
  */
4295
4375
  SmsConfiguration?: SmsConfigurationType;
4296
4376
  /**
@@ -4302,25 +4382,30 @@ export interface UserPoolType {
4302
4382
  };
4303
4383
  /**
4304
4384
  * <p>The reason why the SMS configuration can't send the messages to your users.</p>
4305
- * <p>This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.</p>
4306
- *
4307
- *
4308
- * <ul>
4309
- * <li>
4310
- * <p>InvalidSmsRoleAccessPolicyException - The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information,
4311
- * see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SmsConfigurationType.html">SmsConfigurationType</a>.</p>
4312
- * </li>
4313
- * <li>
4314
- * <p>SNSSandbox -
4315
- * The Amazon Web Services account is in SNS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the IAM user creating the user pool
4316
- * doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox,
4317
- * see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox-moving-to-production.html">Moving out of the SMS sandbox</a>.</p>
4318
- * </li>
4319
- * </ul>
4385
+ * <p>This message might include comma-separated values to describe why your SMS
4386
+ * configuration can't send messages to user pool end users.</p>
4387
+ * <dl>
4388
+ * <dt>InvalidSmsRoleAccessPolicyException</dt>
4389
+ * <dd>
4390
+ * <p>The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly
4391
+ * configured. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SmsConfigurationType.html">SmsConfigurationType</a>.</p>
4392
+ * </dd>
4393
+ * <dt>SNSSandbox</dt>
4394
+ * <dd>
4395
+ * <p>The Amazon Web Services account is in the SNS SMS Sandbox and messages will
4396
+ * only reach verified end users. This parameter won’t get populated with
4397
+ * SNSSandbox if the IAM user creating the user pool doesn’t have SNS
4398
+ * permissions. To learn how to move your Amazon Web Services account out of the
4399
+ * sandbox, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox-moving-to-production.html">Moving out
4400
+ * of the SMS sandbox</a>.</p>
4401
+ * </dd>
4402
+ * </dl>
4320
4403
  */
4321
4404
  SmsConfigurationFailure?: string;
4322
4405
  /**
4323
- * <p>The reason why the email configuration can't send the messages to your users.</p>
4406
+ * <p>Deprecated. Review error codes from API requests with
4407
+ * <code>EventSource:cognito-idp.amazonaws.com</code> in CloudTrail for
4408
+ * information about problems with user pool email configuration.</p>
4324
4409
  */
4325
4410
  EmailConfigurationFailure?: string;
4326
4411
  /**
@@ -4480,42 +4565,52 @@ export interface CreateUserPoolClientRequest {
4480
4565
  ReadAttributes?: string[];
4481
4566
  /**
4482
4567
  * <p>The user pool attributes that the app client can write to.</p>
4483
- * <p>If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity
4484
- * provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client
4485
- * lacks write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see
4486
- * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html">Specifying Identity
4487
- * Provider Attribute Mappings for Your User Pool</a>.</p>
4568
+ * <p>If your app client allows users to sign in through an identity provider, this array
4569
+ * must include all attributes that you have mapped to identity provider attributes. Amazon Cognito
4570
+ * updates mapped attributes when users sign in to your application through an identity
4571
+ * provider. If your app client does not have write access to a mapped attribute, Amazon Cognito
4572
+ * throws an error when it tries to update the attribute. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html">Specifying Identity Provider Attribute Mappings for Your user
4573
+ * pool</a>.</p>
4488
4574
  */
4489
4575
  WriteAttributes?: string[];
4490
4576
  /**
4491
- * <p>The authentication flows that are supported by the user pool clients. Flow names without the <code>ALLOW_</code> prefix are no longer supported,
4492
- * in favor of new names with the <code>ALLOW_</code> prefix.
4493
- * Note that values with <code>ALLOW_</code> prefix must be used only along with the <code>ALLOW_</code> prefix.</p>
4577
+ * <p>The authentication flows that are supported by the user pool clients. Flow names
4578
+ * without the <code>ALLOW_</code> prefix are no longer supported, in favor of new names
4579
+ * with the <code>ALLOW_</code> prefix.</p>
4580
+ * <note>
4581
+ * <p>Values with <code>ALLOW_</code> prefix must be used only along with the
4582
+ * <code>ALLOW_</code> prefix.</p>
4583
+ * </note>
4494
4584
  * <p>Valid values include:</p>
4495
4585
  *
4496
- * <ul>
4586
+ * <ul>
4497
4587
  * <li>
4498
- * <p>
4499
- * <code>ALLOW_ADMIN_USER_PASSWORD_AUTH</code>: Enable admin based user password authentication flow <code>ADMIN_USER_PASSWORD_AUTH</code>. This setting replaces the
4500
- * <code>ADMIN_NO_SRP_AUTH</code> setting. With this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to
4501
- * verify passwords.</p>
4588
+ * <p>
4589
+ * <code>ALLOW_ADMIN_USER_PASSWORD_AUTH</code>: Enable admin based user password
4590
+ * authentication flow <code>ADMIN_USER_PASSWORD_AUTH</code>. This setting replaces
4591
+ * the <code>ADMIN_NO_SRP_AUTH</code> setting. With this authentication flow, Amazon Cognito
4592
+ * receives the password in the request instead of using the Secure Remote Password
4593
+ * (SRP) protocol to verify passwords.</p>
4502
4594
  * </li>
4503
4595
  * <li>
4504
- * <p>
4505
- * <code>ALLOW_CUSTOM_AUTH</code>: Enable Lambda trigger based authentication.</p>
4596
+ * <p>
4597
+ * <code>ALLOW_CUSTOM_AUTH</code>: Enable Lambda trigger based
4598
+ * authentication.</p>
4506
4599
  * </li>
4507
4600
  * <li>
4508
- * <p>
4509
- * <code>ALLOW_USER_PASSWORD_AUTH</code>: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP
4510
- * protocol to verify passwords.</p>
4601
+ * <p>
4602
+ * <code>ALLOW_USER_PASSWORD_AUTH</code>: Enable user password-based
4603
+ * authentication. In this flow, Amazon Cognito receives the password in the request instead
4604
+ * of using the SRP protocol to verify passwords.</p>
4511
4605
  * </li>
4512
4606
  * <li>
4513
- * <p>
4607
+ * <p>
4514
4608
  * <code>ALLOW_USER_SRP_AUTH</code>: Enable SRP-based authentication.</p>
4515
4609
  * </li>
4516
4610
  * <li>
4517
- * <p>
4518
- * <code>ALLOW_REFRESH_TOKEN_AUTH</code>: Enable authflow to refresh tokens.</p>
4611
+ * <p>
4612
+ * <code>ALLOW_REFRESH_TOKEN_AUTH</code>: Enable authflow to refresh
4613
+ * tokens.</p>
4519
4614
  * </li>
4520
4615
  * </ul>
4521
4616
  */
@@ -4587,11 +4682,14 @@ export interface CreateUserPoolClientRequest {
4587
4682
  */
4588
4683
  AllowedOAuthFlowsUserPoolClient?: boolean;
4589
4684
  /**
4590
- * <p>The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.</p>
4591
- * <note>
4592
- * <p>In Amazon Web Services Regions where isn't available, User Pools only supports sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where is available, User Pools will support
4593
- * sending events to Amazon Pinpoint projects within that same Region. </p>
4594
- * </note>
4685
+ * <p>The user pool analytics configuration for collecting metrics and sending them to your
4686
+ * Amazon Pinpoint campaign.</p>
4687
+ * <note>
4688
+ * <p>In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending
4689
+ * events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is
4690
+ * available, user pools support sending events to Amazon Pinpoint projects within that same
4691
+ * Region.</p>
4692
+ * </note>
4595
4693
  */
4596
4694
  AnalyticsConfiguration?: AnalyticsConfigurationType;
4597
4695
  /**
@@ -4779,7 +4877,9 @@ export interface UserPoolClientType {
4779
4877
  /**
4780
4878
  * <p>The Amazon Pinpoint analytics configuration for the user pool client.</p>
4781
4879
  * <note>
4782
- * <p>Amazon Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region in which the user pool resides.</p>
4880
+ * <p>Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N.
4881
+ * Virginia) us-east-1 Region, regardless of the Region where the user pool
4882
+ * resides.</p>
4783
4883
  * </note>
4784
4884
  */
4785
4885
  AnalyticsConfiguration?: AnalyticsConfigurationType;
@@ -4857,7 +4957,8 @@ export declare class ScopeDoesNotExistException extends __BaseException {
4857
4957
  */
4858
4958
  export interface CustomDomainConfigType {
4859
4959
  /**
4860
- * <p>The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.</p>
4960
+ * <p>The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use
4961
+ * this certificate for the subdomain of your custom domain.</p>
4861
4962
  */
4862
4963
  CertificateArn: string | undefined;
4863
4964
  }
@@ -5461,19 +5562,25 @@ export interface ForgotPasswordRequest {
5461
5562
  */
5462
5563
  Username: string | undefined;
5463
5564
  /**
5464
- * <p>The Amazon Pinpoint analytics metadata for collecting metrics for <code>ForgotPassword</code> calls.</p>
5565
+ * <p>The Amazon Pinpoint analytics metadata for collecting metrics for <code>ForgotPassword</code>
5566
+ * calls.</p>
5465
5567
  */
5466
5568
  AnalyticsMetadata?: AnalyticsMetadataType;
5467
5569
  /**
5468
5570
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
5469
- * <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action,
5470
- * Amazon Cognito invokes any functions that are assigned to the following triggers: <i>pre sign-up</i>, <i>custom message</i>,
5471
- * and <i>user migration</i>. When Amazon Cognito invokes any of these functions, it passes a JSON
5472
- * payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned
5473
- * to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the
5474
- * <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
5475
- * <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">Customizing User Pool Workflows
5476
- * with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
5571
+ * <p>You create custom workflows by assigning Lambda functions to user pool
5572
+ * triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any
5573
+ * functions that are assigned to the following triggers: <i>pre sign-up</i>,
5574
+ * <i>custom message</i>, and <i>user migration</i>. When
5575
+ * Amazon Cognito invokes any of these functions, it passes a JSON payload, which the
5576
+ * function receives as input. This payload contains a <code>clientMetadata</code>
5577
+ * attribute, which provides the data that you assigned to the ClientMetadata parameter in
5578
+ * your ForgotPassword request. In your function code in Lambda, you can
5579
+ * process the <code>clientMetadata</code> value to enhance your workflow for your specific
5580
+ * needs.</p>
5581
+ *
5582
+ * <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">
5583
+ * Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
5477
5584
  *
5478
5585
  * <note>
5479
5586
  * <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
@@ -5830,9 +5937,9 @@ export interface GetUserAttributeVerificationCodeRequest {
5830
5937
  * passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data
5831
5938
  * that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda,
5832
5939
  * you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
5833
- * <p>For more information,
5834
- * see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">Customizing User Pool Workflows with Lambda Triggers</a>
5835
- * in the <i>Amazon Cognito Developer Guide</i>.</p>
5940
+ *
5941
+ * <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">
5942
+ * Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
5836
5943
  *
5837
5944
  * <note>
5838
5945
  * <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
@@ -5897,7 +6004,10 @@ export interface SmsMfaConfigType {
5897
6004
  */
5898
6005
  SmsAuthenticationMessage?: string;
5899
6006
  /**
5900
- * <p>The SMS configuration.</p>
6007
+ * <p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an
6008
+ * SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To request Amazon SNS in
6009
+ * the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role that
6010
+ * you provide for your Amazon Web Services account.</p>
5901
6011
  */
5902
6012
  SmsConfiguration?: SmsConfigurationType;
5903
6013
  }
@@ -6064,9 +6174,12 @@ export interface InitiateAuthRequest {
6064
6174
  * <p>User migration</p>
6065
6175
  * </li>
6066
6176
  * </ul>
6067
- * <p>When Amazon Cognito invokes the functions for these triggers, it passes a JSON
6068
- * payload, which the function receives as input. This payload contains a <code>validationData</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your
6069
- * InitiateAuth request. In your function code in Lambda, you can process the <code>validationData</code> value to enhance your workflow for your specific needs.</p>
6177
+ * <p>When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which
6178
+ * the function receives as input. This payload contains a <code>validationData</code>
6179
+ * attribute, which provides the data that you assigned to the ClientMetadata parameter in
6180
+ * your InitiateAuth request. In your function code in Lambda, you can process the
6181
+ * <code>validationData</code> value to enhance your workflow for your specific
6182
+ * needs.</p>
6070
6183
  * <p>When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:</p>
6071
6184
  * <ul>
6072
6185
  * <li>
@@ -6088,8 +6201,10 @@ export interface InitiateAuthRequest {
6088
6201
  * <p>Verify auth challenge</p>
6089
6202
  * </li>
6090
6203
  * </ul>
6091
- * <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">Customizing User Pool Workflows with
6092
- * Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
6204
+ *
6205
+ * <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">
6206
+ * Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
6207
+ *
6093
6208
  *
6094
6209
  * <note>
6095
6210
  * <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
@@ -6134,45 +6249,65 @@ export declare namespace InitiateAuthRequest {
6134
6249
  */
6135
6250
  export interface InitiateAuthResponse {
6136
6251
  /**
6137
- * <p>The name of the challenge that you're responding to with this call. This name is returned in the <code>AdminInitiateAuth</code> response if you must pass another challenge.</p>
6138
- * <p>Valid values include the following. Note that all of these challenges require
6139
- * <code>USERNAME</code> and <code>SECRET_HASH</code> (if applicable) in the parameters.</p>
6252
+ * <p>The name of the challenge that you're responding to with this call. This name is
6253
+ * returned in the <code>AdminInitiateAuth</code> response if you must pass another
6254
+ * challenge.</p>
6255
+ * <p>Valid values include the following:</p>
6256
+ * <note>
6257
+ * <p>All of the following challenges require <code>USERNAME</code> and
6258
+ * <code>SECRET_HASH</code> (if applicable) in the parameters.</p>
6259
+ * </note>
6140
6260
  *
6141
- * <ul>
6261
+ * <ul>
6142
6262
  * <li>
6143
- * <p>
6144
- * <code>SMS_MFA</code>: Next challenge is to supply an <code>SMS_MFA_CODE</code>, delivered via SMS.</p>
6263
+ * <p>
6264
+ * <code>SMS_MFA</code>: Next challenge is to supply an
6265
+ * <code>SMS_MFA_CODE</code>, delivered via SMS.</p>
6145
6266
  * </li>
6146
6267
  * <li>
6147
- * <p>
6148
- * <code>PASSWORD_VERIFIER</code>: Next challenge is to supply <code>PASSWORD_CLAIM_SIGNATURE</code>, <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after the
6149
- * client-side SRP calculations.</p>
6268
+ * <p>
6269
+ * <code>PASSWORD_VERIFIER</code>: Next challenge is to supply
6270
+ * <code>PASSWORD_CLAIM_SIGNATURE</code>,
6271
+ * <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after
6272
+ * the client-side SRP calculations.</p>
6150
6273
  * </li>
6151
6274
  * <li>
6152
- * <p>
6153
- * <code>CUSTOM_CHALLENGE</code>: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.</p>
6275
+ * <p>
6276
+ * <code>CUSTOM_CHALLENGE</code>: This is returned if your custom authentication
6277
+ * flow determines that the user should pass another challenge before tokens are
6278
+ * issued.</p>
6154
6279
  * </li>
6155
6280
  * <li>
6156
- * <p>
6157
- * <code>DEVICE_SRP_AUTH</code>: If device tracking was activated on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking
6158
- * this device.</p>
6281
+ * <p>
6282
+ * <code>DEVICE_SRP_AUTH</code>: If device tracking was activated on your user
6283
+ * pool and the previous challenges were passed, this challenge is returned so that
6284
+ * Amazon Cognito can start tracking this device.</p>
6159
6285
  * </li>
6160
6286
  * <li>
6161
- * <p>
6162
- * <code>DEVICE_PASSWORD_VERIFIER</code>: Similar to <code>PASSWORD_VERIFIER</code>, but for devices only.</p>
6287
+ * <p>
6288
+ * <code>DEVICE_PASSWORD_VERIFIER</code>: Similar to
6289
+ * <code>PASSWORD_VERIFIER</code>, but for devices only.</p>
6163
6290
  * </li>
6164
6291
  * <li>
6165
- * <p>
6166
- * <code>NEW_PASSWORD_REQUIRED</code>: For users who are required to change their passwords after successful first login. This challenge should be passed with <code>NEW_PASSWORD</code>
6167
- * and any other required attributes.</p>
6292
+ * <p>
6293
+ * <code>NEW_PASSWORD_REQUIRED</code>: For users who are required to change their
6294
+ * passwords after successful first login. This challenge should be passed with
6295
+ * <code>NEW_PASSWORD</code> and any other required attributes.</p>
6168
6296
  * </li>
6169
6297
  * <li>
6170
- * <p>
6171
- * <code>MFA_SETUP</code>: For users who are required to setup an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters
6172
- * <code>MFA_CAN_SETUP</code> value. </p>
6173
- * <p> To set up software token MFA, use the session returned here from <code>InitiateAuth</code> as an input to <code>AssociateSoftwareToken</code>. Use the session returned by
6174
- * <code>VerifySoftwareToken</code> as an input to <code>RespondToAuthChallenge</code> with challenge name <code>MFA_SETUP</code> to complete sign-in. To set up SMS MFA, an
6175
- * administrator should help the user to add a phone number to their account, and then the user should call <code>InitiateAuth</code> again to restart sign-in.</p>
6298
+ * <p>
6299
+ * <code>MFA_SETUP</code>: For users who are required to setup an MFA factor
6300
+ * before they can sign in. The MFA types activated for the user pool will be
6301
+ * listed in the challenge parameters <code>MFA_CAN_SETUP</code> value. </p>
6302
+ * <p> To set up software token MFA, use the session returned here from
6303
+ * <code>InitiateAuth</code> as an input to
6304
+ * <code>AssociateSoftwareToken</code>. Use the session returned by
6305
+ * <code>VerifySoftwareToken</code> as an input to
6306
+ * <code>RespondToAuthChallenge</code> with challenge name
6307
+ * <code>MFA_SETUP</code> to complete sign-in. To set up SMS MFA, an
6308
+ * administrator should help the user to add a phone number to their account, and
6309
+ * then the user should call <code>InitiateAuth</code> again to restart
6310
+ * sign-in.</p>
6176
6311
  * </li>
6177
6312
  * </ul>
6178
6313
  */
@@ -6788,15 +6923,17 @@ export interface ResendConfirmationCodeRequest {
6788
6923
  AnalyticsMetadata?: AnalyticsMetadataType;
6789
6924
  /**
6790
6925
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p>
6791
- * <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ResendConfirmationCode API action, Amazon Cognito
6792
- * invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a
6793
- * JSON
6794
- * payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned
6795
- * to the ClientMetadata parameter in your ResendConfirmationCode request. In your function code in Lambda, you can process the <code>clientMetadata</code>
6796
- * value to enhance your workflow for your specific needs.</p>
6797
- * <p>For more information,
6798
- * see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">Customizing User Pool Workflows with Lambda Triggers</a>
6799
- * in the <i>Amazon Cognito Developer Guide</i>.</p>
6926
+ * <p>You create custom workflows by assigning Lambda functions to user pool triggers.
6927
+ * When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is
6928
+ * assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this
6929
+ * function, it passes a JSON payload, which the function receives as input. This payload
6930
+ * contains a <code>clientMetadata</code> attribute, which provides the data that you
6931
+ * assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your
6932
+ * function code in Lambda, you can process the <code>clientMetadata</code> value to enhance
6933
+ * your workflow for your specific needs.</p>
6934
+ *
6935
+ * <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">
6936
+ * Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
6800
6937
  *
6801
6938
  * <note>
6802
6939
  * <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
@@ -6919,8 +7056,9 @@ export interface RespondToAuthChallengeRequest {
6919
7056
  * invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code>
6920
7057
  * attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in
6921
7058
  * Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p>
6922
- * <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">Customizing
6923
- * User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
7059
+ *
7060
+ * <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">
7061
+ * Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
6924
7062
  *
6925
7063
  * <note>
6926
7064
  * <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>
@@ -7159,8 +7297,9 @@ export interface SetUserPoolMfaConfigRequest {
7159
7297
  */
7160
7298
  SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType;
7161
7299
  /**
7162
- * <p>The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users with an MFA factor set up can sign in. To learn more,
7163
- * see <a href="cognito/latest/developerguide/user-pool-settings-mfa.html">Adding Multi-Factor Authentication (MFA) to a User Pool</a>. Valid values include:</p>
7300
+ * <p>The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who
7301
+ * have set up an MFA factor can sign in. To learn more, see <a href="cognito/latest/developerguide/user-pool-settings-mfa.html">Adding Multi-Factor
7302
+ * Authentication (MFA) to a user pool</a>. Valid values include:</p>
7164
7303
  *
7165
7304
  * <ul>
7166
7305
  * <li>
@@ -7295,9 +7434,9 @@ export interface SignUpRequest {
7295
7434
  * receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the
7296
7435
  * ClientMetadata parameter in your SignUp request. In your function code in Lambda, you can process the <code>clientMetadata</code>
7297
7436
  * value to enhance your workflow for your specific needs.</p>
7298
- * <p>For more information,
7299
- * see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">Customizing User Pool Workflows with Lambda Triggers</a>
7300
- * in the <i>Amazon Cognito Developer Guide</i>.</p>
7437
+ *
7438
+ * <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">
7439
+ * Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
7301
7440
  *
7302
7441
  * <note>
7303
7442
  * <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p>