@aws-sdk/client-cognito-identity-provider 3.693.0 → 3.699.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 (117) hide show
  1. package/README.md +80 -0
  2. package/dist-cjs/auth/httpAuthSchemeProvider.js +20 -0
  3. package/dist-cjs/index.js +983 -71
  4. package/dist-es/CognitoIdentityProvider.js +20 -0
  5. package/dist-es/auth/httpAuthSchemeProvider.js +20 -0
  6. package/dist-es/commands/CompleteWebAuthnRegistrationCommand.js +23 -0
  7. package/dist-es/commands/ConfirmSignUpCommand.js +2 -2
  8. package/dist-es/commands/CreateManagedLoginBrandingCommand.js +23 -0
  9. package/dist-es/commands/DeleteManagedLoginBrandingCommand.js +22 -0
  10. package/dist-es/commands/DeleteWebAuthnCredentialCommand.js +23 -0
  11. package/dist-es/commands/DescribeManagedLoginBrandingByClientCommand.js +23 -0
  12. package/dist-es/commands/DescribeManagedLoginBrandingCommand.js +22 -0
  13. package/dist-es/commands/GetUserAuthFactorsCommand.js +23 -0
  14. package/dist-es/commands/GlobalSignOutCommand.js +1 -1
  15. package/dist-es/commands/InitiateAuthCommand.js +1 -1
  16. package/dist-es/commands/ListDevicesCommand.js +1 -1
  17. package/dist-es/commands/ListUserPoolClientsCommand.js +1 -1
  18. package/dist-es/commands/ListUsersCommand.js +1 -1
  19. package/dist-es/commands/ListUsersInGroupCommand.js +1 -1
  20. package/dist-es/commands/ListWebAuthnCredentialsCommand.js +23 -0
  21. package/dist-es/commands/ResendConfirmationCodeCommand.js +1 -1
  22. package/dist-es/commands/RespondToAuthChallengeCommand.js +1 -2
  23. package/dist-es/commands/SignUpCommand.js +2 -2
  24. package/dist-es/commands/StartWebAuthnRegistrationCommand.js +23 -0
  25. package/dist-es/commands/UpdateManagedLoginBrandingCommand.js +22 -0
  26. package/dist-es/commands/index.js +10 -0
  27. package/dist-es/models/models_0.js +184 -50
  28. package/dist-es/models/models_1.js +82 -1
  29. package/dist-es/protocols/Aws_json1_1.js +433 -2
  30. package/dist-types/CognitoIdentityProvider.d.ts +71 -0
  31. package/dist-types/CognitoIdentityProviderClient.d.ts +12 -2
  32. package/dist-types/commands/AdminCreateUserCommand.d.ts +9 -4
  33. package/dist-types/commands/AdminGetUserCommand.d.ts +2 -1
  34. package/dist-types/commands/AdminInitiateAuthCommand.d.ts +5 -4
  35. package/dist-types/commands/AdminListDevicesCommand.d.ts +1 -1
  36. package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +2 -2
  37. package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +4 -4
  38. package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +2 -2
  39. package/dist-types/commands/ChangePasswordCommand.d.ts +1 -1
  40. package/dist-types/commands/CompleteWebAuthnRegistrationCommand.d.ts +119 -0
  41. package/dist-types/commands/ConfirmSignUpCommand.d.ts +5 -2
  42. package/dist-types/commands/CreateManagedLoginBrandingCommand.d.ts +162 -0
  43. package/dist-types/commands/CreateUserPoolClientCommand.d.ts +2 -2
  44. package/dist-types/commands/CreateUserPoolCommand.d.ts +22 -2
  45. package/dist-types/commands/CreateUserPoolDomainCommand.d.ts +8 -1
  46. package/dist-types/commands/DeleteManagedLoginBrandingCommand.d.ts +113 -0
  47. package/dist-types/commands/DeleteWebAuthnCredentialCommand.d.ts +90 -0
  48. package/dist-types/commands/DescribeManagedLoginBrandingByClientCommand.d.ts +108 -0
  49. package/dist-types/commands/DescribeManagedLoginBrandingCommand.d.ts +108 -0
  50. package/dist-types/commands/DescribeUserPoolClientCommand.d.ts +1 -1
  51. package/dist-types/commands/DescribeUserPoolCommand.d.ts +6 -0
  52. package/dist-types/commands/DescribeUserPoolDomainCommand.d.ts +1 -0
  53. package/dist-types/commands/ForgotPasswordCommand.d.ts +2 -2
  54. package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +2 -2
  55. package/dist-types/commands/GetUserAuthFactorsCommand.d.ts +120 -0
  56. package/dist-types/commands/GetUserPoolMfaConfigCommand.d.ts +6 -1
  57. package/dist-types/commands/GlobalSignOutCommand.d.ts +1 -1
  58. package/dist-types/commands/InitiateAuthCommand.d.ts +9 -5
  59. package/dist-types/commands/ListDevicesCommand.d.ts +1 -1
  60. package/dist-types/commands/ListGroupsCommand.d.ts +1 -1
  61. package/dist-types/commands/ListIdentityProvidersCommand.d.ts +1 -1
  62. package/dist-types/commands/ListResourceServersCommand.d.ts +1 -1
  63. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  64. package/dist-types/commands/ListUserImportJobsCommand.d.ts +1 -1
  65. package/dist-types/commands/ListUserPoolClientsCommand.d.ts +1 -1
  66. package/dist-types/commands/ListUserPoolsCommand.d.ts +1 -1
  67. package/dist-types/commands/ListUsersCommand.d.ts +1 -1
  68. package/dist-types/commands/ListUsersInGroupCommand.d.ts +1 -1
  69. package/dist-types/commands/ListWebAuthnCredentialsCommand.d.ts +100 -0
  70. package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +3 -3
  71. package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +5 -6
  72. package/dist-types/commands/SetLogDeliveryConfigurationCommand.d.ts +4 -0
  73. package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +15 -3
  74. package/dist-types/commands/SignUpCommand.d.ts +11 -3
  75. package/dist-types/commands/StartWebAuthnRegistrationCommand.d.ts +107 -0
  76. package/dist-types/commands/UpdateManagedLoginBrandingCommand.d.ts +150 -0
  77. package/dist-types/commands/UpdateUserAttributesCommand.d.ts +2 -2
  78. package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +2 -2
  79. package/dist-types/commands/UpdateUserPoolCommand.d.ts +17 -2
  80. package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts +6 -0
  81. package/dist-types/commands/index.d.ts +10 -0
  82. package/dist-types/models/models_0.d.ts +1609 -1660
  83. package/dist-types/models/models_1.d.ts +1711 -7
  84. package/dist-types/protocols/Aws_json1_1.d.ts +90 -0
  85. package/dist-types/ts3.4/CognitoIdentityProvider.d.ts +177 -0
  86. package/dist-types/ts3.4/CognitoIdentityProviderClient.d.ts +60 -0
  87. package/dist-types/ts3.4/commands/CompleteWebAuthnRegistrationCommand.d.ts +51 -0
  88. package/dist-types/ts3.4/commands/ConfirmSignUpCommand.d.ts +1 -1
  89. package/dist-types/ts3.4/commands/CreateManagedLoginBrandingCommand.d.ts +51 -0
  90. package/dist-types/ts3.4/commands/DeleteManagedLoginBrandingCommand.d.ts +47 -0
  91. package/dist-types/ts3.4/commands/DeleteWebAuthnCredentialCommand.d.ts +51 -0
  92. package/dist-types/ts3.4/commands/DescribeManagedLoginBrandingByClientCommand.d.ts +51 -0
  93. package/dist-types/ts3.4/commands/DescribeManagedLoginBrandingCommand.d.ts +51 -0
  94. package/dist-types/ts3.4/commands/GetUserAuthFactorsCommand.d.ts +51 -0
  95. package/dist-types/ts3.4/commands/GetUserPoolMfaConfigCommand.d.ts +2 -4
  96. package/dist-types/ts3.4/commands/GlobalSignOutCommand.d.ts +1 -1
  97. package/dist-types/ts3.4/commands/InitiateAuthCommand.d.ts +1 -1
  98. package/dist-types/ts3.4/commands/ListDevicesCommand.d.ts +1 -1
  99. package/dist-types/ts3.4/commands/ListGroupsCommand.d.ts +1 -1
  100. package/dist-types/ts3.4/commands/ListIdentityProvidersCommand.d.ts +1 -1
  101. package/dist-types/ts3.4/commands/ListResourceServersCommand.d.ts +1 -1
  102. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
  103. package/dist-types/ts3.4/commands/ListUserImportJobsCommand.d.ts +1 -1
  104. package/dist-types/ts3.4/commands/ListUserPoolClientsCommand.d.ts +1 -1
  105. package/dist-types/ts3.4/commands/ListUserPoolsCommand.d.ts +1 -1
  106. package/dist-types/ts3.4/commands/ListUsersCommand.d.ts +1 -1
  107. package/dist-types/ts3.4/commands/ListUsersInGroupCommand.d.ts +1 -1
  108. package/dist-types/ts3.4/commands/ListWebAuthnCredentialsCommand.d.ts +51 -0
  109. package/dist-types/ts3.4/commands/ResendConfirmationCodeCommand.d.ts +1 -1
  110. package/dist-types/ts3.4/commands/RespondToAuthChallengeCommand.d.ts +4 -2
  111. package/dist-types/ts3.4/commands/StartWebAuthnRegistrationCommand.d.ts +51 -0
  112. package/dist-types/ts3.4/commands/UpdateManagedLoginBrandingCommand.d.ts +51 -0
  113. package/dist-types/ts3.4/commands/index.d.ts +10 -0
  114. package/dist-types/ts3.4/models/models_0.d.ts +248 -185
  115. package/dist-types/ts3.4/models/models_1.d.ts +262 -1
  116. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +120 -0
  117. package/package.json +35 -35
@@ -1,6 +1,1498 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
+ import { DocumentType as __DocumentType } from "@smithy/types";
2
3
  import { CognitoIdentityProviderServiceException as __BaseException } from "./CognitoIdentityProviderServiceException";
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
+ import { AccountRecoverySettingType, AccountTakeoverRiskConfigurationType, AdminCreateUserConfigType, AnalyticsConfigurationType, AnalyticsMetadataType, AssetType, AttributeType, AuthenticationResultType, AuthFlowType, ChallengeNameType, CodeDeliveryDetailsType, CompromisedCredentialsRiskConfigurationType, CustomDomainConfigType, DeletionProtectionType, DeviceConfigurationType, DeviceRememberedStatusType, DeviceType, EmailConfigurationType, EmailMfaConfigType, EmailMfaSettingsType, ExplicitAuthFlowsType, FeedbackValueType, GroupType, IdentityProviderType, IdentityProviderTypeType, LambdaConfigType, LogConfigurationType, LogDeliveryConfigurationType, ManagedLoginBrandingType, MFAOptionType, OAuthFlowType, PreventUserExistenceErrorTypes, ResourceServerScopeType, ResourceServerType, RiskConfigurationType, RiskExceptionConfigurationType, SmsConfigurationType, SmsMfaConfigType, SMSMfaSettingsType, SoftwareTokenMfaConfigType, SoftwareTokenMfaSettingsType, StatusType, TokenValidityUnitsType, UICustomizationType, UserAttributeUpdateSettingsType, UserContextDataType, UserImportJobType, UserPoolAddOnsType, UserPoolClientType, UserPoolMfaType, UserPoolPolicyType, UserPoolTierType, UserType, UserVerificationType, VerificationMessageTemplateType, VerifiedAttributeType } from "./models_0";
5
+ /**
6
+ * <p>Settings for multi-factor authentication (MFA) with passkey, or webauthN, biometric
7
+ * and security-key devices in a user pool. Configures the following:</p>
8
+ * <ul>
9
+ * <li>
10
+ * <p>Configuration at the user-pool level for whether you want to require passkey
11
+ * configuration as an MFA factor, or include it as a choice.</p>
12
+ * </li>
13
+ * <li>
14
+ * <p>The user pool relying-party ID. This is the user pool domain that user's
15
+ * passkey providers should trust as a receiver of passkey authentication.</p>
16
+ * </li>
17
+ * <li>
18
+ * <p>The providers that you want to allow as origins for passkey
19
+ * authentication.</p>
20
+ * </li>
21
+ * </ul>
22
+ * <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html">SetUserPoolMfaConfig</a> and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUserPoolMfaConfig.html">GetUserPoolMfaConfig</a>. </p>
23
+ * @public
24
+ */
25
+ export interface WebAuthnConfigurationType {
26
+ /**
27
+ * <p>Sets or displays the authentication domain, typically your user pool domain, that
28
+ * passkey providers must use as a relying party (RP) in their configuration.</p>
29
+ * <p>Under the following conditions, the passkey relying party ID must be the
30
+ * fully-qualified domain name of your custom domain:</p>
31
+ * <ul>
32
+ * <li>
33
+ * <p>The user pool is configured for passkey authentication.</p>
34
+ * </li>
35
+ * <li>
36
+ * <p>The user pool has a custom domain, whether or not it also has a prefix
37
+ * domain.</p>
38
+ * </li>
39
+ * <li>
40
+ * <p>Your application performs authentication with managed login or the classic
41
+ * hosted UI.</p>
42
+ * </li>
43
+ * </ul>
44
+ * @public
45
+ */
46
+ RelyingPartyId?: string | undefined;
47
+ /**
48
+ * <p>Sets or displays your user-pool treatment for MFA with a passkey. You can override
49
+ * other MFA options and require passkey MFA, or you can set it as preferred. When passkey
50
+ * MFA is preferred, the hosted UI encourages users to register a passkey at
51
+ * sign-in.</p>
52
+ * @public
53
+ */
54
+ UserVerification?: UserVerificationType | undefined;
55
+ }
56
+ /**
57
+ * @public
58
+ */
59
+ export interface GetUserPoolMfaConfigResponse {
60
+ /**
61
+ * <p>Shows user pool SMS message configuration for MFA. Includes the message template and
62
+ * the SMS message sending configuration for Amazon SNS.</p>
63
+ * @public
64
+ */
65
+ SmsMfaConfiguration?: SmsMfaConfigType | undefined;
66
+ /**
67
+ * <p>Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes
68
+ * TOTP enabled or disabled state.</p>
69
+ * @public
70
+ */
71
+ SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType | undefined;
72
+ /**
73
+ * <p>Shows user pool email message configuration for MFA. Includes the subject and body of
74
+ * 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">
75
+ * advanced security features</a> must be active in your user pool.</p>
76
+ * @public
77
+ */
78
+ EmailMfaConfiguration?: EmailMfaConfigType | undefined;
79
+ /**
80
+ * <p>The multi-factor authentication (MFA) configuration. Valid values include:</p>
81
+ * <ul>
82
+ * <li>
83
+ * <p>
84
+ * <code>OFF</code> MFA won't be used for any users.</p>
85
+ * </li>
86
+ * <li>
87
+ * <p>
88
+ * <code>ON</code> MFA is required for all users to sign in.</p>
89
+ * </li>
90
+ * <li>
91
+ * <p>
92
+ * <code>OPTIONAL</code> MFA will be required only for individual users who have
93
+ * an MFA factor activated.</p>
94
+ * </li>
95
+ * </ul>
96
+ * @public
97
+ */
98
+ MfaConfiguration?: UserPoolMfaType | undefined;
99
+ /**
100
+ * <p>Shows user pool configuration for MFA with passkeys from biometric devices and
101
+ * security keys.</p>
102
+ * @public
103
+ */
104
+ WebAuthnConfiguration?: WebAuthnConfigurationType | undefined;
105
+ }
106
+ /**
107
+ * <p>Represents the request to sign out all devices.</p>
108
+ * @public
109
+ */
110
+ export interface GlobalSignOutRequest {
111
+ /**
112
+ * <p>A valid access token that Amazon Cognito issued to the user who you want to sign out.</p>
113
+ * @public
114
+ */
115
+ AccessToken: string | undefined;
116
+ }
117
+ /**
118
+ * <p>The response to the request to sign out all devices.</p>
119
+ * @public
120
+ */
121
+ export interface GlobalSignOutResponse {
122
+ }
123
+ /**
124
+ * <p>Initiates the authentication request.</p>
125
+ * @public
126
+ */
127
+ export interface InitiateAuthRequest {
128
+ /**
129
+ * <p>The authentication flow that you want to initiate. The <code>AuthParameters</code>
130
+ * that you must submit are linked to the flow that you submit. For example:</p>
131
+ * <ul>
132
+ * <li>
133
+ * <p>
134
+ * <code>USER_AUTH</code>: Request a preferred authentication type or review
135
+ * available authentication types. From the offered authentication types, select
136
+ * one in a challenge response and then authenticate with that method in an
137
+ * additional challenge response.</p>
138
+ * </li>
139
+ * <li>
140
+ * <p>
141
+ * <code>REFRESH_TOKEN_AUTH</code>: Receive new ID and access tokens when you
142
+ * pass a <code>REFRESH_TOKEN</code> parameter with a valid refresh token as the
143
+ * value.</p>
144
+ * </li>
145
+ * <li>
146
+ * <p>
147
+ * <code>USER_SRP_AUTH</code>: Receive secure remote password (SRP) variables for
148
+ * the next challenge, <code>PASSWORD_VERIFIER</code>, when you pass
149
+ * <code>USERNAME</code> and <code>SRP_A</code> parameters.</p>
150
+ * </li>
151
+ * <li>
152
+ * <p>
153
+ * <code>USER_PASSWORD_AUTH</code>: Receive new tokens or the next challenge, for
154
+ * example <code>SOFTWARE_TOKEN_MFA</code>, when you pass <code>USERNAME</code> and
155
+ * <code>PASSWORD</code> parameters.</p>
156
+ * </li>
157
+ * </ul>
158
+ * <p>Valid values include the following:</p>
159
+ * <dl>
160
+ * <dt>USER_AUTH</dt>
161
+ * <dd>
162
+ * <p>The entry point for sign-in with passwords, one-time passwords, biometric
163
+ * devices, and security keys.</p>
164
+ * </dd>
165
+ * <dt>USER_SRP_AUTH</dt>
166
+ * <dd>
167
+ * <p>Username-password authentication with the Secure Remote Password (SRP)
168
+ * protocol. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow.html#Using-SRP-password-verification-in-custom-authentication-flow">Use SRP password verification in custom
169
+ * authentication flow</a>.</p>
170
+ * </dd>
171
+ * <dt>REFRESH_TOKEN_AUTH and REFRESH_TOKEN</dt>
172
+ * <dd>
173
+ * <p>Provide a valid refresh token and receive new ID and access tokens. For
174
+ * more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-using-the-refresh-token.html">Using the refresh token</a>.</p>
175
+ * </dd>
176
+ * <dt>CUSTOM_AUTH</dt>
177
+ * <dd>
178
+ * <p>Custom authentication with Lambda triggers. For more information, see
179
+ * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html">Custom authentication challenge Lambda
180
+ * triggers</a>.</p>
181
+ * </dd>
182
+ * <dt>USER_PASSWORD_AUTH</dt>
183
+ * <dd>
184
+ * <p>Username-password authentication with the password sent directly in the
185
+ * request. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow.html#Built-in-authentication-flow-and-challenges">Admin authentication flow</a>.</p>
186
+ * </dd>
187
+ * </dl>
188
+ * <p>
189
+ * <code>ADMIN_USER_PASSWORD_AUTH</code> is a flow type of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html">AdminInitiateAuth</a> and isn't valid for InitiateAuth.
190
+ * <code>ADMIN_NO_SRP_AUTH</code> is a legacy server-side username-password flow and
191
+ * isn't valid for InitiateAuth.</p>
192
+ * @public
193
+ */
194
+ AuthFlow: AuthFlowType | undefined;
195
+ /**
196
+ * <p>The authentication parameters. These are inputs corresponding to the
197
+ * <code>AuthFlow</code> that you're invoking. The required values depend on the value
198
+ * of <code>AuthFlow</code>:</p>
199
+ * <ul>
200
+ * <li>
201
+ * <p>For <code>USER_AUTH</code>: <code>USERNAME</code> (required),
202
+ * <code>PREFERRED_CHALLENGE</code>. If you don't provide a value for
203
+ * <code>PREFERRED_CHALLENGE</code>, Amazon Cognito responds with the
204
+ * <code>AvailableChallenges</code> parameter that specifies the available
205
+ * sign-in methods.</p>
206
+ * </li>
207
+ * <li>
208
+ * <p>For <code>USER_SRP_AUTH</code>: <code>USERNAME</code> (required),
209
+ * <code>SRP_A</code> (required), <code>SECRET_HASH</code> (required if the app
210
+ * client is configured with a client secret), <code>DEVICE_KEY</code>.</p>
211
+ * </li>
212
+ * <li>
213
+ * <p>For <code>USER_PASSWORD_AUTH</code>: <code>USERNAME</code> (required),
214
+ * <code>PASSWORD</code> (required), <code>SECRET_HASH</code> (required if the
215
+ * app client is configured with a client secret), <code>DEVICE_KEY</code>.</p>
216
+ * </li>
217
+ * <li>
218
+ * <p>For <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code>
219
+ * (required), <code>SECRET_HASH</code> (required if the app client is configured
220
+ * with a client secret), <code>DEVICE_KEY</code>.</p>
221
+ * </li>
222
+ * <li>
223
+ * <p>For <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required),
224
+ * <code>SECRET_HASH</code> (if app client is configured with client secret),
225
+ * <code>DEVICE_KEY</code>. To start the authentication flow with password
226
+ * verification, include <code>ChallengeName: SRP_A</code> and <code>SRP_A: (The
227
+ * SRP_A Value)</code>.</p>
228
+ * </li>
229
+ * </ul>
230
+ * <p>For more information about <code>SECRET_HASH</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash">Computing secret hash values</a>. For information about
231
+ * <code>DEVICE_KEY</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>
232
+ * @public
233
+ */
234
+ AuthParameters?: Record<string, string> | undefined;
235
+ /**
236
+ * <p>A map of custom key-value pairs that you can provide as input for certain custom
237
+ * workflows that this action triggers.</p>
238
+ * <p>You create custom workflows by assigning Lambda functions to user pool triggers.
239
+ * When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are
240
+ * specified for various triggers. The ClientMetadata value is passed as input to the
241
+ * functions for only the following triggers:</p>
242
+ * <ul>
243
+ * <li>
244
+ * <p>Pre signup</p>
245
+ * </li>
246
+ * <li>
247
+ * <p>Pre authentication</p>
248
+ * </li>
249
+ * <li>
250
+ * <p>User migration</p>
251
+ * </li>
252
+ * </ul>
253
+ * <p>When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which
254
+ * the function receives as input. This payload contains a <code>validationData</code>
255
+ * attribute, which provides the data that you assigned to the ClientMetadata parameter in
256
+ * your InitiateAuth request. In your function code in Lambda, you can process the
257
+ * <code>validationData</code> value to enhance your workflow for your specific
258
+ * needs.</p>
259
+ * <p>When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the
260
+ * following triggers, but it doesn't provide the ClientMetadata value as input:</p>
261
+ * <ul>
262
+ * <li>
263
+ * <p>Post authentication</p>
264
+ * </li>
265
+ * <li>
266
+ * <p>Custom message</p>
267
+ * </li>
268
+ * <li>
269
+ * <p>Pre token generation</p>
270
+ * </li>
271
+ * <li>
272
+ * <p>Create auth challenge</p>
273
+ * </li>
274
+ * <li>
275
+ * <p>Define auth challenge</p>
276
+ * </li>
277
+ * <li>
278
+ * <p>Custom email sender</p>
279
+ * </li>
280
+ * <li>
281
+ * <p>Custom SMS sender</p>
282
+ * </li>
283
+ * </ul>
284
+ * <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">
285
+ * Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
286
+ * <note>
287
+ * <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the
288
+ * following:</p>
289
+ * <ul>
290
+ * <li>
291
+ * <p>Store the ClientMetadata value. This data is available only to Lambda
292
+ * triggers that are assigned to a user pool to support custom workflows. If
293
+ * your user pool configuration doesn't include triggers, the ClientMetadata
294
+ * parameter serves no purpose.</p>
295
+ * </li>
296
+ * <li>
297
+ * <p>Validate the ClientMetadata value.</p>
298
+ * </li>
299
+ * <li>
300
+ * <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive
301
+ * information.</p>
302
+ * </li>
303
+ * </ul>
304
+ * </note>
305
+ * @public
306
+ */
307
+ ClientMetadata?: Record<string, string> | undefined;
308
+ /**
309
+ * <p>The app client ID.</p>
310
+ * @public
311
+ */
312
+ ClientId: string | undefined;
313
+ /**
314
+ * <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for
315
+ * <code>InitiateAuth</code> calls.</p>
316
+ * @public
317
+ */
318
+ AnalyticsMetadata?: AnalyticsMetadataType | undefined;
319
+ /**
320
+ * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
321
+ * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
322
+ * when it makes API requests.</p>
323
+ * @public
324
+ */
325
+ UserContextData?: UserContextDataType | undefined;
326
+ /**
327
+ * <p>The optional session ID from a <code>ConfirmSignUp</code> API request. You can sign in
328
+ * a user directly from the sign-up process with the <code>USER_AUTH</code> authentication
329
+ * flow.</p>
330
+ * @public
331
+ */
332
+ Session?: string | undefined;
333
+ }
334
+ /**
335
+ * <p>Initiates the authentication response.</p>
336
+ * @public
337
+ */
338
+ export interface InitiateAuthResponse {
339
+ /**
340
+ * <p>The name of the challenge that you're responding to with this call. This name is
341
+ * returned in the <code>InitiateAuth</code> response if you must pass another
342
+ * challenge.</p>
343
+ * <p>Valid values include the following:</p>
344
+ * <note>
345
+ * <p>All of the following challenges require <code>USERNAME</code> and
346
+ * <code>SECRET_HASH</code> (if applicable) in the parameters.</p>
347
+ * </note>
348
+ * <ul>
349
+ * <li>
350
+ * <p>
351
+ * <code>WEB_AUTHN</code>: Respond to the challenge with the results of a
352
+ * successful authentication with a passkey, or webauthN, factor. These are
353
+ * typically biometric devices or security keys.</p>
354
+ * </li>
355
+ * <li>
356
+ * <p>
357
+ * <code>PASSWORD</code>: Respond with <code>USER_PASSWORD_AUTH</code>
358
+ * parameters: <code>USERNAME</code> (required), <code>PASSWORD</code> (required),
359
+ * <code>SECRET_HASH</code> (required if the app client is configured with a
360
+ * client secret), <code>DEVICE_KEY</code>.</p>
361
+ * </li>
362
+ * <li>
363
+ * <p>
364
+ * <code>PASSWORD_SRP</code>: Respond with <code>USER_SRP_AUTH</code> parameters:
365
+ * <code>USERNAME</code> (required), <code>SRP_A</code> (required),
366
+ * <code>SECRET_HASH</code> (required if the app client is configured with a
367
+ * client secret), <code>DEVICE_KEY</code>.</p>
368
+ * </li>
369
+ * <li>
370
+ * <p>
371
+ * <code>SELECT_CHALLENGE</code>: Respond to the challenge with
372
+ * <code>USERNAME</code> and an <code>ANSWER</code> that matches one of the
373
+ * challenge types in the <code>AvailableChallenges</code> response
374
+ * parameter.</p>
375
+ * </li>
376
+ * <li>
377
+ * <p>
378
+ * <code>SMS_MFA</code>: Next challenge is to supply an
379
+ * <code>SMS_MFA_CODE</code>that your user pool delivered in an SMS message.</p>
380
+ * </li>
381
+ * <li>
382
+ * <p>
383
+ * <code>EMAIL_OTP</code>: Next challenge is to supply an
384
+ * <code>EMAIL_OTP_CODE</code> that your user pool delivered in an email
385
+ * message.</p>
386
+ * </li>
387
+ * <li>
388
+ * <p>
389
+ * <code>PASSWORD_VERIFIER</code>: Next challenge is to supply
390
+ * <code>PASSWORD_CLAIM_SIGNATURE</code>,
391
+ * <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after
392
+ * the client-side SRP calculations.</p>
393
+ * </li>
394
+ * <li>
395
+ * <p>
396
+ * <code>CUSTOM_CHALLENGE</code>: This is returned if your custom authentication
397
+ * flow determines that the user should pass another challenge before tokens are
398
+ * issued.</p>
399
+ * </li>
400
+ * <li>
401
+ * <p>
402
+ * <code>DEVICE_SRP_AUTH</code>: If device tracking was activated on your user
403
+ * pool and the previous challenges were passed, this challenge is returned so that
404
+ * Amazon Cognito can start tracking this device.</p>
405
+ * </li>
406
+ * <li>
407
+ * <p>
408
+ * <code>DEVICE_PASSWORD_VERIFIER</code>: Similar to
409
+ * <code>PASSWORD_VERIFIER</code>, but for devices only.</p>
410
+ * </li>
411
+ * <li>
412
+ * <p>
413
+ * <code>NEW_PASSWORD_REQUIRED</code>: For users who are required to change their
414
+ * passwords after successful first login.</p>
415
+ * <p>Respond to this challenge with <code>NEW_PASSWORD</code> and any required
416
+ * attributes that Amazon Cognito returned in the <code>requiredAttributes</code> parameter.
417
+ * You can also set values for attributes that aren't required by your user pool
418
+ * and that your app client can write. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RespondToAuthChallenge.html">RespondToAuthChallenge</a>.</p>
419
+ * <p>Amazon Cognito only returns this challenge for users who have temporary passwords.
420
+ * Because of this, and because in some cases you can create users who don't have
421
+ * values for required attributes, take care to collect and submit
422
+ * required-attribute values for all users who don't have passwords. You can create
423
+ * a user in the Amazon Cognito console without, for example, a required
424
+ * <code>birthdate</code> attribute. The API response from Amazon Cognito won't prompt
425
+ * you to submit a birthdate for the user if they don't have a password.</p>
426
+ * <note>
427
+ * <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value.
428
+ * In <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the <code>requiredAttributes</code> parameter,
429
+ * then use the <code>UpdateUserAttributes</code> API operation to modify the value of any additional attributes.</p>
430
+ * </note>
431
+ * </li>
432
+ * <li>
433
+ * <p>
434
+ * <code>MFA_SETUP</code>: For users who are required to setup an MFA factor
435
+ * before they can sign in. The MFA types activated for the user pool will be
436
+ * listed in the challenge parameters <code>MFAS_CAN_SETUP</code> value. </p>
437
+ * <p> To set up software token MFA, use the session returned here from
438
+ * <code>InitiateAuth</code> as an input to
439
+ * <code>AssociateSoftwareToken</code>. Use the session returned by
440
+ * <code>VerifySoftwareToken</code> as an input to
441
+ * <code>RespondToAuthChallenge</code> with challenge name
442
+ * <code>MFA_SETUP</code> to complete sign-in. To set up SMS MFA, an
443
+ * administrator should help the user to add a phone number to their account, and
444
+ * then the user should call <code>InitiateAuth</code> again to restart
445
+ * sign-in.</p>
446
+ * </li>
447
+ * </ul>
448
+ * @public
449
+ */
450
+ ChallengeName?: ChallengeNameType | undefined;
451
+ /**
452
+ * <p>The session that should pass both ways in challenge-response calls to the service. If
453
+ * the caller must pass another challenge, they return a session with other challenge
454
+ * parameters. Include this session identifier in a <code>RespondToAuthChallenge</code> API
455
+ * request.</p>
456
+ * @public
457
+ */
458
+ Session?: string | undefined;
459
+ /**
460
+ * <p>The challenge parameters. These are returned in the <code>InitiateAuth</code> response
461
+ * if you must pass another challenge. The responses in this parameter should be used to
462
+ * compute inputs to the next call (<code>RespondToAuthChallenge</code>). </p>
463
+ * <p>All challenges require <code>USERNAME</code>. They also require
464
+ * <code>SECRET_HASH</code> if your app client has a client secret.</p>
465
+ * @public
466
+ */
467
+ ChallengeParameters?: Record<string, string> | undefined;
468
+ /**
469
+ * <p>The result of the authentication response. This result is only returned if the caller
470
+ * doesn't need to pass another challenge. If the caller does need to pass another
471
+ * challenge before it gets tokens, <code>ChallengeName</code>,
472
+ * <code>ChallengeParameters</code>, and <code>Session</code> are returned.</p>
473
+ * @public
474
+ */
475
+ AuthenticationResult?: AuthenticationResultType | undefined;
476
+ /**
477
+ * <p>This response parameter prompts a user to select from multiple available challenges
478
+ * that they can complete authentication with. For example, they might be able to continue
479
+ * with passwordless authentication or with a one-time password from an SMS message.</p>
480
+ * @public
481
+ */
482
+ AvailableChallenges?: ChallengeNameType[] | undefined;
483
+ }
484
+ /**
485
+ * <p>Represents the request to list the devices.</p>
486
+ * @public
487
+ */
488
+ export interface ListDevicesRequest {
489
+ /**
490
+ * <p>A valid access token that Amazon Cognito issued to the user whose list of devices you want to
491
+ * view.</p>
492
+ * @public
493
+ */
494
+ AccessToken: string | undefined;
495
+ /**
496
+ * <p>The limit of the device request.</p>
497
+ * @public
498
+ */
499
+ Limit?: number | undefined;
500
+ /**
501
+ * <p>This API operation returns a limited number of results. The pagination token is
502
+ * an identifier that you can present in an additional API request with the same parameters. When
503
+ * you include the pagination token, Amazon Cognito returns the next set of items after the current list.
504
+ * Subsequent requests return a new pagination token. By use of this token, you can paginate
505
+ * through the full list of items.</p>
506
+ * @public
507
+ */
508
+ PaginationToken?: string | undefined;
509
+ }
510
+ /**
511
+ * <p>Represents the response to list devices.</p>
512
+ * @public
513
+ */
514
+ export interface ListDevicesResponse {
515
+ /**
516
+ * <p>The devices returned in the list devices response.</p>
517
+ * @public
518
+ */
519
+ Devices?: DeviceType[] | undefined;
520
+ /**
521
+ * <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
522
+ * you include a pagination token in your request, Amazon Cognito returns the next set of items in
523
+ * the list. By use of this token, you can paginate through the full list of items.</p>
524
+ * @public
525
+ */
526
+ PaginationToken?: string | undefined;
527
+ }
528
+ /**
529
+ * @public
530
+ */
531
+ export interface ListGroupsRequest {
532
+ /**
533
+ * <p>The user pool ID for the user pool.</p>
534
+ * @public
535
+ */
536
+ UserPoolId: string | undefined;
537
+ /**
538
+ * <p>The limit of the request to list groups.</p>
539
+ * @public
540
+ */
541
+ Limit?: number | undefined;
542
+ /**
543
+ * <p>An identifier that was returned from the previous call to this operation, which can be
544
+ * used to return the next set of items in the list.</p>
545
+ * @public
546
+ */
547
+ NextToken?: string | undefined;
548
+ }
549
+ /**
550
+ * @public
551
+ */
552
+ export interface ListGroupsResponse {
553
+ /**
554
+ * <p>The group objects for the groups.</p>
555
+ * @public
556
+ */
557
+ Groups?: GroupType[] | undefined;
558
+ /**
559
+ * <p>An identifier that was returned from the previous call to this operation, which can be
560
+ * used to return the next set of items in the list.</p>
561
+ * @public
562
+ */
563
+ NextToken?: string | undefined;
564
+ }
565
+ /**
566
+ * @public
567
+ */
568
+ export interface ListIdentityProvidersRequest {
569
+ /**
570
+ * <p>The user pool ID.</p>
571
+ * @public
572
+ */
573
+ UserPoolId: string | undefined;
574
+ /**
575
+ * <p>The maximum number of IdPs to return.</p>
576
+ * @public
577
+ */
578
+ MaxResults?: number | undefined;
579
+ /**
580
+ * <p>A pagination token.</p>
581
+ * @public
582
+ */
583
+ NextToken?: string | undefined;
584
+ }
585
+ /**
586
+ * <p>The details of a user pool identity provider (IdP), including name and type.</p>
587
+ * <p>This data type is a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListIdentityProviders.html">ListIdentityProviders</a>.</p>
588
+ * @public
589
+ */
590
+ export interface ProviderDescription {
591
+ /**
592
+ * <p>The name of the IdP, for example <code>MySAMLProvider</code>.</p>
593
+ * @public
594
+ */
595
+ ProviderName?: string | undefined;
596
+ /**
597
+ * <p>The type of the provider, for example <code>SAML</code>. Amazon Cognito supports SAML 2.0,
598
+ * OIDC, and social IdPs. User pools list supported social IdPs by name in this response
599
+ * parameter: Facebook, Google, Login with Amazon, and Sign in with Apple.</p>
600
+ * @public
601
+ */
602
+ ProviderType?: IdentityProviderTypeType | undefined;
603
+ /**
604
+ * <p>The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
605
+ * human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
606
+ * @public
607
+ */
608
+ LastModifiedDate?: Date | undefined;
609
+ /**
610
+ * <p>The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
611
+ * human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
612
+ * @public
613
+ */
614
+ CreationDate?: Date | undefined;
615
+ }
616
+ /**
617
+ * @public
618
+ */
619
+ export interface ListIdentityProvidersResponse {
620
+ /**
621
+ * <p>A list of IdP objects.</p>
622
+ * @public
623
+ */
624
+ Providers: ProviderDescription[] | undefined;
625
+ /**
626
+ * <p>A pagination token.</p>
627
+ * @public
628
+ */
629
+ NextToken?: string | undefined;
630
+ }
631
+ /**
632
+ * @public
633
+ */
634
+ export interface ListResourceServersRequest {
635
+ /**
636
+ * <p>The user pool ID for the user pool.</p>
637
+ * @public
638
+ */
639
+ UserPoolId: string | undefined;
640
+ /**
641
+ * <p>The maximum number of resource servers to return.</p>
642
+ * @public
643
+ */
644
+ MaxResults?: number | undefined;
645
+ /**
646
+ * <p>A pagination token.</p>
647
+ * @public
648
+ */
649
+ NextToken?: string | undefined;
650
+ }
651
+ /**
652
+ * @public
653
+ */
654
+ export interface ListResourceServersResponse {
655
+ /**
656
+ * <p>The resource servers.</p>
657
+ * @public
658
+ */
659
+ ResourceServers: ResourceServerType[] | undefined;
660
+ /**
661
+ * <p>A pagination token.</p>
662
+ * @public
663
+ */
664
+ NextToken?: string | undefined;
665
+ }
666
+ /**
667
+ * @public
668
+ */
669
+ export interface ListTagsForResourceRequest {
670
+ /**
671
+ * <p>The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.</p>
672
+ * @public
673
+ */
674
+ ResourceArn: string | undefined;
675
+ }
676
+ /**
677
+ * @public
678
+ */
679
+ export interface ListTagsForResourceResponse {
680
+ /**
681
+ * <p>The tags that are assigned to the user pool.</p>
682
+ * @public
683
+ */
684
+ Tags?: Record<string, string> | undefined;
685
+ }
686
+ /**
687
+ * <p>Represents the request to list the user import jobs.</p>
688
+ * @public
689
+ */
690
+ export interface ListUserImportJobsRequest {
691
+ /**
692
+ * <p>The user pool ID for the user pool that the users are being imported into.</p>
693
+ * @public
694
+ */
695
+ UserPoolId: string | undefined;
696
+ /**
697
+ * <p>The maximum number of import jobs you want the request to return.</p>
698
+ * @public
699
+ */
700
+ MaxResults: number | undefined;
701
+ /**
702
+ * <p>This API operation returns a limited number of results. The pagination token is
703
+ * an identifier that you can present in an additional API request with the same parameters. When
704
+ * you include the pagination token, Amazon Cognito returns the next set of items after the current list.
705
+ * Subsequent requests return a new pagination token. By use of this token, you can paginate
706
+ * through the full list of items.</p>
707
+ * @public
708
+ */
709
+ PaginationToken?: string | undefined;
710
+ }
711
+ /**
712
+ * <p>Represents the response from the server to the request to list the user import
713
+ * jobs.</p>
714
+ * @public
715
+ */
716
+ export interface ListUserImportJobsResponse {
717
+ /**
718
+ * <p>The user import jobs.</p>
719
+ * @public
720
+ */
721
+ UserImportJobs?: UserImportJobType[] | undefined;
722
+ /**
723
+ * <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
724
+ * you include a pagination token in your request, Amazon Cognito returns the next set of items in
725
+ * the list. By use of this token, you can paginate through the full list of items.</p>
726
+ * @public
727
+ */
728
+ PaginationToken?: string | undefined;
729
+ }
730
+ /**
731
+ * <p>Represents the request to list the user pool clients.</p>
732
+ * @public
733
+ */
734
+ export interface ListUserPoolClientsRequest {
735
+ /**
736
+ * <p>The user pool ID for the user pool where you want to list user pool clients.</p>
737
+ * @public
738
+ */
739
+ UserPoolId: string | undefined;
740
+ /**
741
+ * <p>The maximum number of results you want the request to return when listing the user
742
+ * pool clients.</p>
743
+ * @public
744
+ */
745
+ MaxResults?: number | undefined;
746
+ /**
747
+ * <p>An identifier that was returned from the previous call to this operation, which can be
748
+ * used to return the next set of items in the list.</p>
749
+ * @public
750
+ */
751
+ NextToken?: string | undefined;
752
+ }
753
+ /**
754
+ * <p>A short description of a user pool app client.</p>
755
+ * <p>This data type is a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListUserPoolClients.html">ListUserPoolClients</a>. </p>
756
+ * @public
757
+ */
758
+ export interface UserPoolClientDescription {
759
+ /**
760
+ * <p>The app client ID.</p>
761
+ * @public
762
+ */
763
+ ClientId?: string | undefined;
764
+ /**
765
+ * <p>The ID of the user pool that's associated with the app client.</p>
766
+ * @public
767
+ */
768
+ UserPoolId?: string | undefined;
769
+ /**
770
+ * <p>The app client name.</p>
771
+ * @public
772
+ */
773
+ ClientName?: string | undefined;
774
+ }
775
+ /**
776
+ * <p>Represents the response from the server that lists user pool clients.</p>
777
+ * @public
778
+ */
779
+ export interface ListUserPoolClientsResponse {
780
+ /**
781
+ * <p>The user pool clients in the response that lists user pool clients.</p>
782
+ * @public
783
+ */
784
+ UserPoolClients?: UserPoolClientDescription[] | undefined;
785
+ /**
786
+ * <p>An identifier that was returned from the previous call to this operation, which can be
787
+ * used to return the next set of items in the list.</p>
788
+ * @public
789
+ */
790
+ NextToken?: string | undefined;
791
+ }
792
+ /**
793
+ * <p>Represents the request to list user pools.</p>
794
+ * @public
795
+ */
796
+ export interface ListUserPoolsRequest {
797
+ /**
798
+ * <p>An identifier that was returned from the previous call to this operation, which can be
799
+ * used to return the next set of items in the list.</p>
800
+ * @public
801
+ */
802
+ NextToken?: string | undefined;
803
+ /**
804
+ * <p>The maximum number of results you want the request to return when listing the user
805
+ * pools.</p>
806
+ * @public
807
+ */
808
+ MaxResults: number | undefined;
809
+ }
810
+ /**
811
+ * <p>A short description of a user pool.</p>
812
+ * <p>This data type is a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListUserPools.html">ListUserPools</a>. </p>
813
+ * @public
814
+ */
815
+ export interface UserPoolDescriptionType {
816
+ /**
817
+ * <p>The user pool ID.</p>
818
+ * @public
819
+ */
820
+ Id?: string | undefined;
821
+ /**
822
+ * <p>The user pool name.</p>
823
+ * @public
824
+ */
825
+ Name?: string | undefined;
826
+ /**
827
+ * <p>A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible
828
+ * stages of user pool operations. Triggers can modify the outcome of the operations that
829
+ * invoked them.</p>
830
+ * @public
831
+ */
832
+ LambdaConfig?: LambdaConfigType | undefined;
833
+ /**
834
+ * @deprecated
835
+ *
836
+ * <p>The user pool status.</p>
837
+ * @public
838
+ */
839
+ Status?: StatusType | undefined;
840
+ /**
841
+ * <p>The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
842
+ * human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
843
+ * @public
844
+ */
845
+ LastModifiedDate?: Date | undefined;
846
+ /**
847
+ * <p>The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
848
+ * human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
849
+ * @public
850
+ */
851
+ CreationDate?: Date | undefined;
852
+ }
853
+ /**
854
+ * <p>Represents the response to list user pools.</p>
855
+ * @public
856
+ */
857
+ export interface ListUserPoolsResponse {
858
+ /**
859
+ * <p>The user pools from the response to list users.</p>
860
+ * @public
861
+ */
862
+ UserPools?: UserPoolDescriptionType[] | undefined;
863
+ /**
864
+ * <p>An identifier that was returned from the previous call to this operation, which can be
865
+ * used to return the next set of items in the list.</p>
866
+ * @public
867
+ */
868
+ NextToken?: string | undefined;
869
+ }
870
+ /**
871
+ * <p>Represents the request to list users.</p>
872
+ * @public
873
+ */
874
+ export interface ListUsersRequest {
875
+ /**
876
+ * <p>The user pool ID for the user pool on which the search should be performed.</p>
877
+ * @public
878
+ */
879
+ UserPoolId: string | undefined;
880
+ /**
881
+ * <p>A JSON array of user attribute names, for example <code>given_name</code>, that you
882
+ * want Amazon Cognito to include in the response for each user. When you don't provide an
883
+ * <code>AttributesToGet</code> parameter, Amazon Cognito returns all attributes for each
884
+ * user.</p>
885
+ * <p>Use <code>AttributesToGet</code> with required attributes in your user pool, or in
886
+ * conjunction with <code>Filter</code>. Amazon Cognito returns an error if not all users in the
887
+ * results have set a value for the attribute you request. Attributes that you can't
888
+ * filter on, including custom attributes, must have a value set in every user profile
889
+ * before an <code>AttributesToGet</code> parameter returns results.</p>
890
+ * @public
891
+ */
892
+ AttributesToGet?: string[] | undefined;
893
+ /**
894
+ * <p>Maximum number of users to be returned.</p>
895
+ * @public
896
+ */
897
+ Limit?: number | undefined;
898
+ /**
899
+ * <p>This API operation returns a limited number of results. The pagination token is
900
+ * an identifier that you can present in an additional API request with the same parameters. When
901
+ * you include the pagination token, Amazon Cognito returns the next set of items after the current list.
902
+ * Subsequent requests return a new pagination token. By use of this token, you can paginate
903
+ * through the full list of items.</p>
904
+ * @public
905
+ */
906
+ PaginationToken?: string | undefined;
907
+ /**
908
+ * <p>A filter string of the form <code>"AttributeName Filter-Type "AttributeValue"</code>.
909
+ * Quotation marks within the filter string must be escaped using the backslash
910
+ * (<code>\</code>) character. For example, <code>"family_name =
911
+ * \"Reddy\""</code>.</p>
912
+ * <ul>
913
+ * <li>
914
+ * <p>
915
+ * <i>AttributeName</i>: The name of the attribute to search for.
916
+ * You can only search for one attribute at a time.</p>
917
+ * </li>
918
+ * <li>
919
+ * <p>
920
+ * <i>Filter-Type</i>: For an exact match, use <code>=</code>, for
921
+ * example, "<code>given_name = \"Jon\"</code>". For a prefix ("starts with")
922
+ * match, use <code>^=</code>, for example, "<code>given_name ^= \"Jon\"</code>".
923
+ * </p>
924
+ * </li>
925
+ * <li>
926
+ * <p>
927
+ * <i>AttributeValue</i>: The attribute value that must be matched
928
+ * for each user.</p>
929
+ * </li>
930
+ * </ul>
931
+ * <p>If the filter string is empty, <code>ListUsers</code> returns all users in the user
932
+ * pool.</p>
933
+ * <p>You can only search for the following standard attributes:</p>
934
+ * <ul>
935
+ * <li>
936
+ * <p>
937
+ * <code>username</code> (case-sensitive)</p>
938
+ * </li>
939
+ * <li>
940
+ * <p>
941
+ * <code>email</code>
942
+ * </p>
943
+ * </li>
944
+ * <li>
945
+ * <p>
946
+ * <code>phone_number</code>
947
+ * </p>
948
+ * </li>
949
+ * <li>
950
+ * <p>
951
+ * <code>name</code>
952
+ * </p>
953
+ * </li>
954
+ * <li>
955
+ * <p>
956
+ * <code>given_name</code>
957
+ * </p>
958
+ * </li>
959
+ * <li>
960
+ * <p>
961
+ * <code>family_name</code>
962
+ * </p>
963
+ * </li>
964
+ * <li>
965
+ * <p>
966
+ * <code>preferred_username</code>
967
+ * </p>
968
+ * </li>
969
+ * <li>
970
+ * <p>
971
+ * <code>cognito:user_status</code> (called <b>Status</b> in the Console) (case-insensitive)</p>
972
+ * </li>
973
+ * <li>
974
+ * <p>
975
+ * <code>status (called <b>Enabled</b> in the Console)
976
+ * (case-sensitive)</code>
977
+ * </p>
978
+ * </li>
979
+ * <li>
980
+ * <p>
981
+ * <code>sub</code>
982
+ * </p>
983
+ * </li>
984
+ * </ul>
985
+ * <p>Custom attributes aren't searchable.</p>
986
+ * <note>
987
+ * <p>You can also list users with a client-side filter. The server-side filter matches
988
+ * no more than one attribute. For an advanced search, use a client-side filter with
989
+ * the <code>--query</code> parameter of the <code>list-users</code> action in the
990
+ * CLI. When you use a client-side filter, ListUsers returns a paginated list of zero
991
+ * or more users. You can receive multiple pages in a row with zero results. Repeat the
992
+ * query with each pagination token that is returned until you receive a null
993
+ * pagination token value, and then review the combined result. </p>
994
+ * <p>For more information about server-side and client-side filtering, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html">FilteringCLI output</a> in the <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html">Command Line Interface
995
+ * User Guide</a>. </p>
996
+ * </note>
997
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-using-listusers-api">Searching for Users Using the ListUsers API</a> and <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-listusers-api-examples">Examples of Using the ListUsers API</a> in the <i>Amazon Cognito Developer
998
+ * Guide</i>.</p>
999
+ * @public
1000
+ */
1001
+ Filter?: string | undefined;
1002
+ }
1003
+ /**
1004
+ * <p>The response from the request to list users.</p>
1005
+ * @public
1006
+ */
1007
+ export interface ListUsersResponse {
1008
+ /**
1009
+ * <p>A list of the user pool users, and their attributes, that match your query.</p>
1010
+ * <note>
1011
+ * <p>Amazon Cognito creates a profile in your user pool for each native user in your user pool,
1012
+ * and each unique user ID from your third-party identity providers (IdPs). When you
1013
+ * link users with the <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html">AdminLinkProviderForUser</a> API operation, the output of
1014
+ * <code>ListUsers</code> displays both the IdP user and the native user that you
1015
+ * linked. You can identify IdP users in the <code>Users</code> object of this API
1016
+ * response by the IdP prefix that Amazon Cognito appends to <code>Username</code>.</p>
1017
+ * </note>
1018
+ * @public
1019
+ */
1020
+ Users?: UserType[] | undefined;
1021
+ /**
1022
+ * <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
1023
+ * you include a pagination token in your request, Amazon Cognito returns the next set of items in
1024
+ * the list. By use of this token, you can paginate through the full list of items.</p>
1025
+ * @public
1026
+ */
1027
+ PaginationToken?: string | undefined;
1028
+ }
1029
+ /**
1030
+ * @public
1031
+ */
1032
+ export interface ListUsersInGroupRequest {
1033
+ /**
1034
+ * <p>The user pool ID for the user pool.</p>
1035
+ * @public
1036
+ */
1037
+ UserPoolId: string | undefined;
1038
+ /**
1039
+ * <p>The name of the group.</p>
1040
+ * @public
1041
+ */
1042
+ GroupName: string | undefined;
1043
+ /**
1044
+ * <p>The maximum number of users that you want to retrieve before pagination.</p>
1045
+ * @public
1046
+ */
1047
+ Limit?: number | undefined;
1048
+ /**
1049
+ * <p>An identifier that was returned from the previous call to this operation, which can be
1050
+ * used to return the next set of items in the list.</p>
1051
+ * @public
1052
+ */
1053
+ NextToken?: string | undefined;
1054
+ }
1055
+ /**
1056
+ * @public
1057
+ */
1058
+ export interface ListUsersInGroupResponse {
1059
+ /**
1060
+ * <p>A list of users in the group, and their attributes.</p>
1061
+ * @public
1062
+ */
1063
+ Users?: UserType[] | undefined;
1064
+ /**
1065
+ * <p>An identifier that you can use in a later request to return the next set of items in
1066
+ * the list.</p>
1067
+ * @public
1068
+ */
1069
+ NextToken?: string | undefined;
1070
+ }
1071
+ /**
1072
+ * @public
1073
+ */
1074
+ export interface ListWebAuthnCredentialsRequest {
1075
+ /**
1076
+ * <p>A valid access token that Amazon Cognito issued to the user whose registered passkeys you want
1077
+ * to list.</p>
1078
+ * @public
1079
+ */
1080
+ AccessToken: string | undefined;
1081
+ /**
1082
+ * <p>An identifier that was returned from the previous call to this operation, which can be
1083
+ * used to return the next set of items in the list.</p>
1084
+ * @public
1085
+ */
1086
+ NextToken?: string | undefined;
1087
+ /**
1088
+ * <p>The maximum number of the user's passkey credentials that you want to
1089
+ * return.</p>
1090
+ * @public
1091
+ */
1092
+ MaxResults?: number | undefined;
1093
+ }
1094
+ /**
1095
+ * <p>The details of a passkey, or webauthN, biometric or security-key authentication factor
1096
+ * for a user.</p>
1097
+ * <p>This data type is a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListWebAuthnCredentials.html">ListWebAuthnCredentials</a>.</p>
1098
+ * @public
1099
+ */
1100
+ export interface WebAuthnCredentialDescription {
1101
+ /**
1102
+ * <p>The unique identifier of the passkey credential.</p>
1103
+ * @public
1104
+ */
1105
+ CredentialId: string | undefined;
1106
+ /**
1107
+ * <p>An automatically-generated friendly name for the passkey credential.</p>
1108
+ * @public
1109
+ */
1110
+ FriendlyCredentialName: string | undefined;
1111
+ /**
1112
+ * <p>The relying-party ID of the provider for the passkey credential.</p>
1113
+ * @public
1114
+ */
1115
+ RelyingPartyId: string | undefined;
1116
+ /**
1117
+ * <p>The general category of the passkey authenticator. Can be a platform, or on-device
1118
+ * authenticator like a built-in fingerprint scanner, or a cross-platform device that's not
1119
+ * attached to the device like a Bluetooth security key.</p>
1120
+ * @public
1121
+ */
1122
+ AuthenticatorAttachment?: string | undefined;
1123
+ /**
1124
+ * <p>Information about the transport methods of the passkey credential, for example USB or
1125
+ * Bluetooth Low Energy.</p>
1126
+ * @public
1127
+ */
1128
+ AuthenticatorTransports: string[] | undefined;
1129
+ /**
1130
+ * <p>The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
1131
+ * human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
1132
+ * @public
1133
+ */
1134
+ CreatedAt: Date | undefined;
1135
+ }
1136
+ /**
1137
+ * @public
1138
+ */
1139
+ export interface ListWebAuthnCredentialsResponse {
1140
+ /**
1141
+ * <p>A list of registered passkeys for a user.</p>
1142
+ * @public
1143
+ */
1144
+ Credentials: WebAuthnCredentialDescription[] | undefined;
1145
+ /**
1146
+ * <p>An identifier that you can use in a later request to return the next set of items in
1147
+ * the list.</p>
1148
+ * @public
1149
+ */
1150
+ NextToken?: string | undefined;
1151
+ }
1152
+ /**
1153
+ * <p>Represents the request to resend the confirmation code.</p>
1154
+ * @public
1155
+ */
1156
+ export interface ResendConfirmationCodeRequest {
1157
+ /**
1158
+ * <p>The ID of the client associated with the user pool.</p>
1159
+ * @public
1160
+ */
1161
+ ClientId: string | undefined;
1162
+ /**
1163
+ * <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a
1164
+ * user pool client and username plus the client ID in the message.</p>
1165
+ * @public
1166
+ */
1167
+ SecretHash?: string | undefined;
1168
+ /**
1169
+ * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
1170
+ * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
1171
+ * when it makes API requests.</p>
1172
+ * @public
1173
+ */
1174
+ UserContextData?: UserContextDataType | undefined;
1175
+ /**
1176
+ * <p>The username of the user that you want to query or modify. The value of this parameter
1177
+ * is typically your user's username, but it can be any of their alias attributes. If
1178
+ * <code>username</code> isn't an alias attribute in your user pool, this value
1179
+ * must be the <code>sub</code> of a local user or the username of a user from a
1180
+ * third-party IdP.</p>
1181
+ * @public
1182
+ */
1183
+ Username: string | undefined;
1184
+ /**
1185
+ * <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for
1186
+ * <code>ResendConfirmationCode</code> calls.</p>
1187
+ * @public
1188
+ */
1189
+ AnalyticsMetadata?: AnalyticsMetadataType | undefined;
1190
+ /**
1191
+ * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
1192
+ * that this action triggers.</p>
1193
+ * <p>You create custom workflows by assigning Lambda functions to user pool triggers.
1194
+ * When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is
1195
+ * assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this
1196
+ * function, it passes a JSON payload, which the function receives as input. This payload
1197
+ * contains a <code>clientMetadata</code> attribute, which provides the data that you
1198
+ * assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your
1199
+ * function code in Lambda, you can process the <code>clientMetadata</code> value to enhance
1200
+ * your workflow for your specific needs.</p>
1201
+ * <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">
1202
+ * Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
1203
+ * <note>
1204
+ * <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the
1205
+ * following:</p>
1206
+ * <ul>
1207
+ * <li>
1208
+ * <p>Store the ClientMetadata value. This data is available only to Lambda
1209
+ * triggers that are assigned to a user pool to support custom workflows. If
1210
+ * your user pool configuration doesn't include triggers, the ClientMetadata
1211
+ * parameter serves no purpose.</p>
1212
+ * </li>
1213
+ * <li>
1214
+ * <p>Validate the ClientMetadata value.</p>
1215
+ * </li>
1216
+ * <li>
1217
+ * <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive
1218
+ * information.</p>
1219
+ * </li>
1220
+ * </ul>
1221
+ * </note>
1222
+ * @public
1223
+ */
1224
+ ClientMetadata?: Record<string, string> | undefined;
1225
+ }
1226
+ /**
1227
+ * <p>The response from the server when Amazon Cognito makes the request to resend a confirmation
1228
+ * code.</p>
1229
+ * @public
1230
+ */
1231
+ export interface ResendConfirmationCodeResponse {
1232
+ /**
1233
+ * <p>The code delivery details returned by the server in response to the request to resend
1234
+ * the confirmation code.</p>
1235
+ * @public
1236
+ */
1237
+ CodeDeliveryDetails?: CodeDeliveryDetailsType | undefined;
1238
+ }
1239
+ /**
1240
+ * <p>The request to respond to an authentication challenge.</p>
1241
+ * @public
1242
+ */
1243
+ export interface RespondToAuthChallengeRequest {
1244
+ /**
1245
+ * <p>The app client ID.</p>
1246
+ * @public
1247
+ */
1248
+ ClientId: string | undefined;
1249
+ /**
1250
+ * <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>
1251
+ * <p>
1252
+ * <code>ADMIN_NO_SRP_AUTH</code> isn't a valid value.</p>
1253
+ * @public
1254
+ */
1255
+ ChallengeName: ChallengeNameType | undefined;
1256
+ /**
1257
+ * <p>The session that should be passed both ways in challenge-response calls to the
1258
+ * service. If <code>InitiateAuth</code> or <code>RespondToAuthChallenge</code> API call
1259
+ * determines that the caller must pass another challenge, they return a session with other
1260
+ * challenge parameters. This session should be passed as it is to the next
1261
+ * <code>RespondToAuthChallenge</code> API call.</p>
1262
+ * @public
1263
+ */
1264
+ Session?: string | undefined;
1265
+ /**
1266
+ * <p>The responses to the challenge that you received in the previous request. Each
1267
+ * challenge has its own required response parameters. The following examples are partial
1268
+ * JSON request bodies that highlight challenge-response parameters.</p>
1269
+ * <important>
1270
+ * <p>You must provide a SECRET_HASH parameter in all challenge responses to an app
1271
+ * client that has a client secret. Include a <code>DEVICE_KEY</code> for device
1272
+ * authentication.</p>
1273
+ * </important>
1274
+ * <dl>
1275
+ * <dt>SELECT_CHALLENGE</dt>
1276
+ * <dd>
1277
+ * <p>
1278
+ * <code>"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
1279
+ * "USERNAME": "[username]",
1280
+ * "ANSWER": "[Challenge name]"\}</code>
1281
+ * </p>
1282
+ * <p>Available challenges are <code>PASSWORD</code>, <code>PASSWORD_SRP</code>,
1283
+ * <code>EMAIL_OTP</code>, <code>SMS_OTP</code>, and <code>WEB_AUTHN</code>.</p>
1284
+ * <p>Complete authentication in the <code>SELECT_CHALLENGE</code> response for
1285
+ * <code>PASSWORD</code>, <code>PASSWORD_SRP</code>, and <code>WEB_AUTHN</code>:</p>
1286
+ * <ul>
1287
+ * <li>
1288
+ * <p>
1289
+ * <code>"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
1290
+ * "ANSWER": "WEB_AUTHN",
1291
+ * "USERNAME": "[username]",
1292
+ * "CREDENTIAL": "[AuthenticationResponseJSON]"\}</code>
1293
+ * </p>
1294
+ * <p>See <a href="https://www.w3.org/TR/webauthn-3/#dictdef-authenticationresponsejson">
1295
+ * AuthenticationResponseJSON</a>.</p>
1296
+ * </li>
1297
+ * <li>
1298
+ * <p>
1299
+ * <code>"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
1300
+ * "ANSWER": "PASSWORD",
1301
+ * "USERNAME": "[username]",
1302
+ * "PASSWORD": "[password]"\}</code>
1303
+ * </p>
1304
+ * </li>
1305
+ * <li>
1306
+ * <p>
1307
+ * <code>"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
1308
+ * "ANSWER": "PASSWORD_SRP",
1309
+ * "USERNAME": "[username]",
1310
+ * "SRP_A": "[SRP_A]"\}</code>
1311
+ * </p>
1312
+ * </li>
1313
+ * </ul>
1314
+ * <p>For <code>SMS_OTP</code> and <code>EMAIL_OTP</code>, respond with the
1315
+ * username and answer. Your user pool will send a code for the user to submit in
1316
+ * the next challenge response.</p>
1317
+ * <ul>
1318
+ * <li>
1319
+ * <p>
1320
+ * <code>"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
1321
+ * "ANSWER": "SMS_OTP",
1322
+ * "USERNAME": "[username]"\}</code>
1323
+ * </p>
1324
+ * </li>
1325
+ * <li>
1326
+ * <p>
1327
+ * <code>"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
1328
+ * "ANSWER": "EMAIL_OTP",
1329
+ * "USERNAME": "[username]"\}</code>
1330
+ * </p>
1331
+ * </li>
1332
+ * </ul>
1333
+ * </dd>
1334
+ * <dt>SMS_OTP</dt>
1335
+ * <dd>
1336
+ * <p>
1337
+ * <code>"ChallengeName": "SMS_OTP", "ChallengeResponses":
1338
+ * \{"SMS_OTP_CODE": "[code]", "USERNAME": "[username]"\}</code>
1339
+ * </p>
1340
+ * </dd>
1341
+ * <dt>EMAIL_OTP</dt>
1342
+ * <dd>
1343
+ * <p>
1344
+ * <code>"ChallengeName": "EMAIL_OTP", "ChallengeResponses": \{"EMAIL_OTP_CODE":
1345
+ * "[code]", "USERNAME": "[username]"\}</code>
1346
+ * </p>
1347
+ * </dd>
1348
+ * <dt>SMS_MFA</dt>
1349
+ * <dd>
1350
+ * <p>
1351
+ * <code>"ChallengeName": "SMS_MFA", "ChallengeResponses": \{"SMS_MFA_CODE":
1352
+ * "[code]", "USERNAME": "[username]"\}</code>
1353
+ * </p>
1354
+ * </dd>
1355
+ * <dt>PASSWORD_VERIFIER</dt>
1356
+ * <dd>
1357
+ * <p>This challenge response is part of the SRP flow. Amazon Cognito requires
1358
+ * that your application respond to this challenge within a few seconds. When
1359
+ * the response time exceeds this period, your user pool returns a
1360
+ * <code>NotAuthorizedException</code> error.</p>
1361
+ * <p>
1362
+ * <code>"ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses":
1363
+ * \{"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]",
1364
+ * "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP":
1365
+ * [timestamp], "USERNAME": "[username]"\}</code>
1366
+ * </p>
1367
+ * <p>Add <code>"DEVICE_KEY"</code> when you sign in with a remembered
1368
+ * device.</p>
1369
+ * </dd>
1370
+ * <dt>CUSTOM_CHALLENGE</dt>
1371
+ * <dd>
1372
+ * <p>
1373
+ * <code>"ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses":
1374
+ * \{"USERNAME": "[username]", "ANSWER": "[challenge_answer]"\}</code>
1375
+ * </p>
1376
+ * <p>Add <code>"DEVICE_KEY"</code> when you sign in with a remembered
1377
+ * device.</p>
1378
+ * </dd>
1379
+ * <dt>NEW_PASSWORD_REQUIRED</dt>
1380
+ * <dd>
1381
+ * <p>
1382
+ * <code>"ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses":
1383
+ * \{"NEW_PASSWORD": "[new_password]", "USERNAME":
1384
+ * "[username]"\}</code>
1385
+ * </p>
1386
+ * <p>To set any required attributes that <code>InitiateAuth</code> returned in
1387
+ * an <code>requiredAttributes</code> parameter, add
1388
+ * <code>"userAttributes.[attribute_name]": "[attribute_value]"</code>.
1389
+ * This parameter can also set values for writable attributes that aren't
1390
+ * required by your user pool.</p>
1391
+ * <note>
1392
+ * <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value.
1393
+ * In <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the <code>requiredAttributes</code> parameter,
1394
+ * then use the <code>UpdateUserAttributes</code> API operation to modify the value of any additional attributes.</p>
1395
+ * </note>
1396
+ * </dd>
1397
+ * <dt>SOFTWARE_TOKEN_MFA</dt>
1398
+ * <dd>
1399
+ * <p>
1400
+ * <code>"ChallengeName": "SOFTWARE_TOKEN_MFA", "ChallengeResponses":
1401
+ * \{"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE":
1402
+ * [authenticator_code]\}</code>
1403
+ * </p>
1404
+ * </dd>
1405
+ * <dt>DEVICE_SRP_AUTH</dt>
1406
+ * <dd>
1407
+ * <p>
1408
+ * <code>"ChallengeName": "DEVICE_SRP_AUTH", "ChallengeResponses": \{"USERNAME":
1409
+ * "[username]", "DEVICE_KEY": "[device_key]", "SRP_A":
1410
+ * "[srp_a]"\}</code>
1411
+ * </p>
1412
+ * </dd>
1413
+ * <dt>DEVICE_PASSWORD_VERIFIER</dt>
1414
+ * <dd>
1415
+ * <p>
1416
+ * <code>"ChallengeName": "DEVICE_PASSWORD_VERIFIER", "ChallengeResponses":
1417
+ * \{"DEVICE_KEY": "[device_key]", "PASSWORD_CLAIM_SIGNATURE":
1418
+ * "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]",
1419
+ * "TIMESTAMP": [timestamp], "USERNAME": "[username]"\}</code>
1420
+ * </p>
1421
+ * </dd>
1422
+ * <dt>MFA_SETUP</dt>
1423
+ * <dd>
1424
+ * <p>
1425
+ * <code>"ChallengeName": "MFA_SETUP", "ChallengeResponses": \{"USERNAME":
1426
+ * "[username]"\}, "SESSION": "[Session ID from
1427
+ * VerifySoftwareToken]"</code>
1428
+ * </p>
1429
+ * </dd>
1430
+ * <dt>SELECT_MFA_TYPE</dt>
1431
+ * <dd>
1432
+ * <p>
1433
+ * <code>"ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses": \{"USERNAME":
1434
+ * "[username]", "ANSWER": "[SMS_MFA or SOFTWARE_TOKEN_MFA]"\}</code>
1435
+ * </p>
1436
+ * </dd>
1437
+ * </dl>
1438
+ * <p>For more information about <code>SECRET_HASH</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash">Computing secret hash values</a>. For information about
1439
+ * <code>DEVICE_KEY</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>
1440
+ * @public
1441
+ */
1442
+ ChallengeResponses?: Record<string, string> | undefined;
1443
+ /**
1444
+ * <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for
1445
+ * <code>RespondToAuthChallenge</code> calls.</p>
1446
+ * @public
1447
+ */
1448
+ AnalyticsMetadata?: AnalyticsMetadataType | undefined;
1449
+ /**
1450
+ * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
1451
+ * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
1452
+ * when it makes API requests.</p>
1453
+ * @public
1454
+ */
1455
+ UserContextData?: UserContextDataType | undefined;
1456
+ /**
1457
+ * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
1458
+ * that this action triggers.</p>
1459
+ * <p>You create custom workflows by assigning Lambda functions to user pool
1460
+ * triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any
1461
+ * functions that are assigned to the following triggers: <i>post
1462
+ * authentication</i>, <i>pre token generation</i>,
1463
+ * <i>define auth challenge</i>, <i>create auth
1464
+ * challenge</i>, and <i>verify auth challenge</i>. When Amazon Cognito
1465
+ * invokes any of these functions, it passes a JSON payload, which the function receives as
1466
+ * input. This payload contains a <code>clientMetadata</code> attribute, which provides the
1467
+ * data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge
1468
+ * request. In your function code in Lambda, you can process the
1469
+ * <code>clientMetadata</code> value to enhance your workflow for your specific
1470
+ * needs.</p>
1471
+ * <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">
1472
+ * Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
1473
+ * <note>
1474
+ * <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the
1475
+ * following:</p>
1476
+ * <ul>
1477
+ * <li>
1478
+ * <p>Store the ClientMetadata value. This data is available only to Lambda
1479
+ * triggers that are assigned to a user pool to support custom workflows. If
1480
+ * your user pool configuration doesn't include triggers, the ClientMetadata
1481
+ * parameter serves no purpose.</p>
1482
+ * </li>
1483
+ * <li>
1484
+ * <p>Validate the ClientMetadata value.</p>
1485
+ * </li>
1486
+ * <li>
1487
+ * <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive
1488
+ * information.</p>
1489
+ * </li>
1490
+ * </ul>
1491
+ * </note>
1492
+ * @public
1493
+ */
1494
+ ClientMetadata?: Record<string, string> | undefined;
1495
+ }
4
1496
  /**
5
1497
  * <p>The response to respond to the authentication challenge.</p>
6
1498
  * @public
@@ -287,6 +1779,13 @@ export interface SetUserPoolMfaConfigRequest {
287
1779
  * @public
288
1780
  */
289
1781
  MfaConfiguration?: UserPoolMfaType | undefined;
1782
+ /**
1783
+ * <p>The configuration of your user pool for passkey, or webauthN, authentication and
1784
+ * registration. You can set this configuration independent of the MFA configuration
1785
+ * options in this operation.</p>
1786
+ * @public
1787
+ */
1788
+ WebAuthnConfiguration?: WebAuthnConfigurationType | undefined;
290
1789
  }
291
1790
  /**
292
1791
  * @public
@@ -331,6 +1830,12 @@ export interface SetUserPoolMfaConfigResponse {
331
1830
  * @public
332
1831
  */
333
1832
  MfaConfiguration?: UserPoolMfaType | undefined;
1833
+ /**
1834
+ * <p>The configuration of your user pool for passkey, or webauthN, biometric and
1835
+ * security-key devices.</p>
1836
+ * @public
1837
+ */
1838
+ WebAuthnConfiguration?: WebAuthnConfigurationType | undefined;
334
1839
  }
335
1840
  /**
336
1841
  * <p>Represents the request to set user settings.</p>
@@ -380,9 +1885,13 @@ export interface SignUpRequest {
380
1885
  Username: string | undefined;
381
1886
  /**
382
1887
  * <p>The password of the user you want to register.</p>
1888
+ * <p>Users can sign up without a password when your user pool supports passwordless sign-in
1889
+ * with email or SMS OTPs. To create a user with no password, omit this parameter or submit
1890
+ * a blank value. You can only create a passwordless user when passwordless sign-in is
1891
+ * available. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SignInPolicyType.html">the SignInPolicyType</a> property of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a>.</p>
383
1892
  * @public
384
1893
  */
385
- Password: string | undefined;
1894
+ Password?: string | undefined;
386
1895
  /**
387
1896
  * <p>An array of name-value pairs representing user attributes.</p>
388
1897
  * <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the
@@ -476,6 +1985,13 @@ export interface SignUpResponse {
476
1985
  * @public
477
1986
  */
478
1987
  UserSub: string | undefined;
1988
+ /**
1989
+ * <p>A session Id that you can pass to <code>ConfirmSignUp</code> when you want to
1990
+ * immediately sign in your user with the <code>USER_AUTH</code> flow after they complete
1991
+ * sign-up.</p>
1992
+ * @public
1993
+ */
1994
+ Session?: string | undefined;
479
1995
  }
480
1996
  /**
481
1997
  * <p>Represents the request to start the user import job.</p>
@@ -505,6 +2021,41 @@ export interface StartUserImportJobResponse {
505
2021
  */
506
2022
  UserImportJob?: UserImportJobType | undefined;
507
2023
  }
2024
+ /**
2025
+ * @public
2026
+ */
2027
+ export interface StartWebAuthnRegistrationRequest {
2028
+ /**
2029
+ * <p>A valid access token that Amazon Cognito issued to the user whose passkey metadata you want to
2030
+ * generate.</p>
2031
+ * @public
2032
+ */
2033
+ AccessToken: string | undefined;
2034
+ }
2035
+ /**
2036
+ * @public
2037
+ */
2038
+ export interface StartWebAuthnRegistrationResponse {
2039
+ /**
2040
+ * <p>The information that a user can provide in their request to register with their
2041
+ * passkey provider.</p>
2042
+ * @public
2043
+ */
2044
+ CredentialCreationOptions: __DocumentType | undefined;
2045
+ }
2046
+ /**
2047
+ * <p>This exception is thrown when a user pool doesn't have a configured relying party
2048
+ * id or a user pool domain.</p>
2049
+ * @public
2050
+ */
2051
+ export declare class WebAuthnConfigurationMissingException extends __BaseException {
2052
+ readonly name: "WebAuthnConfigurationMissingException";
2053
+ readonly $fault: "client";
2054
+ /**
2055
+ * @internal
2056
+ */
2057
+ constructor(opts: __ExceptionOptionType<WebAuthnConfigurationMissingException, __BaseException>);
2058
+ }
508
2059
  /**
509
2060
  * <p>Represents the request to stop the user import job.</p>
510
2061
  * @public
@@ -845,6 +2396,54 @@ export interface UpdateIdentityProviderResponse {
845
2396
  */
846
2397
  IdentityProvider: IdentityProviderType | undefined;
847
2398
  }
2399
+ /**
2400
+ * @public
2401
+ */
2402
+ export interface UpdateManagedLoginBrandingRequest {
2403
+ /**
2404
+ * <p>The ID of the user pool that contains the managed login branding style that you want
2405
+ * to update.</p>
2406
+ * @public
2407
+ */
2408
+ UserPoolId?: string | undefined;
2409
+ /**
2410
+ * <p>The ID of the managed login branding style that you want to update.</p>
2411
+ * @public
2412
+ */
2413
+ ManagedLoginBrandingId?: string | undefined;
2414
+ /**
2415
+ * <p>When true, applies the default branding style options. This option reverts to default
2416
+ * style options that are managed by Amazon Cognito. You can modify them later in the branding
2417
+ * designer.</p>
2418
+ * <p>When you specify <code>true</code> for this option, you must also omit values for
2419
+ * <code>Settings</code> and <code>Assets</code> in the request.</p>
2420
+ * @public
2421
+ */
2422
+ UseCognitoProvidedValues?: boolean | undefined;
2423
+ /**
2424
+ * <p>A JSON file, encoded as a <code>Document</code> type, with the the settings that you
2425
+ * want to apply to your style.</p>
2426
+ * @public
2427
+ */
2428
+ Settings?: __DocumentType | undefined;
2429
+ /**
2430
+ * <p>An array of image files that you want to apply to roles like backgrounds, logos, and
2431
+ * icons. Each object must also indicate whether it is for dark mode, light mode, or
2432
+ * browser-adaptive mode.</p>
2433
+ * @public
2434
+ */
2435
+ Assets?: AssetType[] | undefined;
2436
+ }
2437
+ /**
2438
+ * @public
2439
+ */
2440
+ export interface UpdateManagedLoginBrandingResponse {
2441
+ /**
2442
+ * <p>The details of the branding style that you updated.</p>
2443
+ * @public
2444
+ */
2445
+ ManagedLoginBranding?: ManagedLoginBrandingType | undefined;
2446
+ }
848
2447
  /**
849
2448
  * @public
850
2449
  */
@@ -1107,6 +2706,18 @@ export interface UpdateUserPoolRequest {
1107
2706
  * @public
1108
2707
  */
1109
2708
  AccountRecoverySetting?: AccountRecoverySettingType | undefined;
2709
+ /**
2710
+ * <p>The updated name of your user pool.</p>
2711
+ * @public
2712
+ */
2713
+ PoolName?: string | undefined;
2714
+ /**
2715
+ * <p>The user pool <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html">feature plan</a>, or tier. This parameter determines the
2716
+ * eligibility of the user pool for features like managed login, access-token
2717
+ * customization, and threat protection. Defaults to <code>ESSENTIALS</code>.</p>
2718
+ * @public
2719
+ */
2720
+ UserPoolTier?: UserPoolTierType | undefined;
1110
2721
  }
1111
2722
  /**
1112
2723
  * <p>Represents the response from the server when you make a request to update the user
@@ -1240,6 +2851,18 @@ export interface UpdateUserPoolClientRequest {
1240
2851
  * <ul>
1241
2852
  * <li>
1242
2853
  * <p>
2854
+ * <code>ALLOW_USER_AUTH</code>: Enable selection-based sign-in
2855
+ * with <code>USER_AUTH</code>. This setting covers username-password,
2856
+ * secure remote password (SRP), passwordless, and passkey authentication.
2857
+ * This authentiation flow can do username-password and SRP authentication
2858
+ * without other <code>ExplicitAuthFlows</code> permitting them. For example
2859
+ * users can complete an SRP challenge through <code>USER_AUTH</code>
2860
+ * without the flow <code>USER_SRP_AUTH</code> being active for the app
2861
+ * client. This flow doesn't include <code>CUSTOM_AUTH</code>.
2862
+ * </p>
2863
+ * </li>
2864
+ * <li>
2865
+ * <p>
1243
2866
  * <code>ALLOW_ADMIN_USER_PASSWORD_AUTH</code>: Enable admin based user password
1244
2867
  * authentication flow <code>ADMIN_USER_PASSWORD_AUTH</code>. This setting replaces
1245
2868
  * the <code>ADMIN_NO_SRP_AUTH</code> setting. With this authentication flow, your app
@@ -1274,10 +2897,16 @@ export interface UpdateUserPoolClientRequest {
1274
2897
  */
1275
2898
  ExplicitAuthFlows?: ExplicitAuthFlowsType[] | undefined;
1276
2899
  /**
1277
- * <p>A list of provider names for the IdPs that this client supports. The following are
1278
- * supported: <code>COGNITO</code>, <code>Facebook</code>, <code>Google</code>,
1279
- * <code>SignInWithApple</code>, <code>LoginWithAmazon</code>, and the names of your
1280
- * own SAML and OIDC providers.</p>
2900
+ * <p>A list of provider names for the identity providers (IdPs) that are supported on this
2901
+ * client. The following are supported: <code>COGNITO</code>, <code>Facebook</code>,
2902
+ * <code>Google</code>, <code>SignInWithApple</code>, and <code>LoginWithAmazon</code>.
2903
+ * You can also specify the names that you configured for the SAML and OIDC IdPs in your
2904
+ * user pool, for example <code>MySAMLIdP</code> or <code>MyOIDCIdP</code>.</p>
2905
+ * <p>This setting applies to providers that you can access with the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html">hosted
2906
+ * UI and OAuth 2.0 authorization server</a>. The removal of <code>COGNITO</code>
2907
+ * from this list doesn't prevent authentication operations for local users with the
2908
+ * user pools API in an Amazon Web Services SDK. The only way to prevent API-based authentication is to
2909
+ * block access with a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html">WAF rule</a>.</p>
1281
2910
  * @public
1282
2911
  */
1283
2912
  SupportedIdentityProviders?: string[] | undefined;
@@ -1437,7 +3066,7 @@ export interface UpdateUserPoolClientRequest {
1437
3066
  EnableTokenRevocation?: boolean | undefined;
1438
3067
  /**
1439
3068
  * <p>Activates the propagation of additional user context data. For more information about
1440
- * propagation of user context data, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html"> Adding advanced security to a user pool</a>. If you don’t include this
3069
+ * propagation of user context data, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-threat-protection.html"> Adding advanced security to a user pool</a>. If you don’t include this
1441
3070
  * parameter, you can't send device fingerprint information, including source IP address,
1442
3071
  * to Amazon Cognito advanced security. You can only activate
1443
3072
  * <code>EnablePropagateAdditionalUserContextData</code> in an app client that has a
@@ -1484,10 +3113,22 @@ export interface UpdateUserPoolDomainRequest {
1484
3113
  * @public
1485
3114
  */
1486
3115
  UserPoolId: string | undefined;
3116
+ /**
3117
+ * <p>A version number that indicates the state of managed login for your domain. Version
3118
+ * <code>1</code> is hosted UI (classic). Version <code>2</code> is the newer managed
3119
+ * login with the branding designer. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html">Managed login</a>.</p>
3120
+ * @public
3121
+ */
3122
+ ManagedLoginVersion?: number | undefined;
1487
3123
  /**
1488
3124
  * <p>The configuration for a custom domain that hosts the sign-up and sign-in pages for
1489
3125
  * your application. Use this object to specify an SSL certificate that is managed by
1490
3126
  * ACM.</p>
3127
+ * <p>When you create a custom domain, the passkey RP ID defaults to the custom domain. If
3128
+ * you had a prefix domain active, this will cause passkey integration for your prefix
3129
+ * domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey
3130
+ * integration working, you can explicitly set RP ID to the prefix domain. Update the RP ID
3131
+ * in a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html">SetUserPoolMfaConfig</a> request.</p>
1491
3132
  * @public
1492
3133
  */
1493
3134
  CustomDomainConfig: CustomDomainConfigType | undefined;
@@ -1497,6 +3138,13 @@ export interface UpdateUserPoolDomainRequest {
1497
3138
  * @public
1498
3139
  */
1499
3140
  export interface UpdateUserPoolDomainResponse {
3141
+ /**
3142
+ * <p>A version number that indicates the state of managed login for your domain. Version
3143
+ * <code>1</code> is hosted UI (classic). Version <code>2</code> is the newer managed
3144
+ * login with the branding designer. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html">Managed login</a>.</p>
3145
+ * @public
3146
+ */
3147
+ ManagedLoginVersion?: number | undefined;
1500
3148
  /**
1501
3149
  * <p>The Amazon CloudFront endpoint that Amazon Cognito set up when you added the custom domain to your user
1502
3150
  * pool.</p>
@@ -1601,6 +3249,54 @@ export interface VerifyUserAttributeRequest {
1601
3249
  */
1602
3250
  export interface VerifyUserAttributeResponse {
1603
3251
  }
3252
+ /**
3253
+ * @internal
3254
+ */
3255
+ export declare const GlobalSignOutRequestFilterSensitiveLog: (obj: GlobalSignOutRequest) => any;
3256
+ /**
3257
+ * @internal
3258
+ */
3259
+ export declare const InitiateAuthRequestFilterSensitiveLog: (obj: InitiateAuthRequest) => any;
3260
+ /**
3261
+ * @internal
3262
+ */
3263
+ export declare const InitiateAuthResponseFilterSensitiveLog: (obj: InitiateAuthResponse) => any;
3264
+ /**
3265
+ * @internal
3266
+ */
3267
+ export declare const ListDevicesRequestFilterSensitiveLog: (obj: ListDevicesRequest) => any;
3268
+ /**
3269
+ * @internal
3270
+ */
3271
+ export declare const ListDevicesResponseFilterSensitiveLog: (obj: ListDevicesResponse) => any;
3272
+ /**
3273
+ * @internal
3274
+ */
3275
+ export declare const UserPoolClientDescriptionFilterSensitiveLog: (obj: UserPoolClientDescription) => any;
3276
+ /**
3277
+ * @internal
3278
+ */
3279
+ export declare const ListUserPoolClientsResponseFilterSensitiveLog: (obj: ListUserPoolClientsResponse) => any;
3280
+ /**
3281
+ * @internal
3282
+ */
3283
+ export declare const ListUsersResponseFilterSensitiveLog: (obj: ListUsersResponse) => any;
3284
+ /**
3285
+ * @internal
3286
+ */
3287
+ export declare const ListUsersInGroupResponseFilterSensitiveLog: (obj: ListUsersInGroupResponse) => any;
3288
+ /**
3289
+ * @internal
3290
+ */
3291
+ export declare const ListWebAuthnCredentialsRequestFilterSensitiveLog: (obj: ListWebAuthnCredentialsRequest) => any;
3292
+ /**
3293
+ * @internal
3294
+ */
3295
+ export declare const ResendConfirmationCodeRequestFilterSensitiveLog: (obj: ResendConfirmationCodeRequest) => any;
3296
+ /**
3297
+ * @internal
3298
+ */
3299
+ export declare const RespondToAuthChallengeRequestFilterSensitiveLog: (obj: RespondToAuthChallengeRequest) => any;
1604
3300
  /**
1605
3301
  * @internal
1606
3302
  */
@@ -1637,6 +3333,14 @@ export declare const SetUserSettingsRequestFilterSensitiveLog: (obj: SetUserSett
1637
3333
  * @internal
1638
3334
  */
1639
3335
  export declare const SignUpRequestFilterSensitiveLog: (obj: SignUpRequest) => any;
3336
+ /**
3337
+ * @internal
3338
+ */
3339
+ export declare const SignUpResponseFilterSensitiveLog: (obj: SignUpResponse) => any;
3340
+ /**
3341
+ * @internal
3342
+ */
3343
+ export declare const StartWebAuthnRegistrationRequestFilterSensitiveLog: (obj: StartWebAuthnRegistrationRequest) => any;
1640
3344
  /**
1641
3345
  * @internal
1642
3346
  */