@aws-sdk/client-cognito-identity-provider 3.315.0 → 3.319.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.
@@ -101,1248 +101,622 @@ import { UpdateUserPoolCommandInput, UpdateUserPoolCommandOutput } from "./comma
101
101
  import { UpdateUserPoolDomainCommandInput, UpdateUserPoolDomainCommandOutput } from "./commands/UpdateUserPoolDomainCommand";
102
102
  import { VerifySoftwareTokenCommandInput, VerifySoftwareTokenCommandOutput } from "./commands/VerifySoftwareTokenCommand";
103
103
  import { VerifyUserAttributeCommandInput, VerifyUserAttributeCommandOutput } from "./commands/VerifyUserAttributeCommand";
104
- /**
105
- * @public
106
- * <p>Using the Amazon Cognito user pools API, you can create a user pool to manage directories and
107
- * users. You can authenticate a user to obtain tokens related to user identity and access
108
- * policies.</p>
109
- * <p>This API reference provides information about user pools in Amazon Cognito user pools.</p>
110
- * <p>For more information, see the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html">Amazon Cognito
111
- * Documentation</a>.</p>
112
- */
113
- export declare class CognitoIdentityProvider extends CognitoIdentityProviderClient {
104
+ export interface CognitoIdentityProvider {
114
105
  /**
115
- * @public
116
- * <p>Adds additional user attributes to the user pool schema.</p>
106
+ * @see {@link AddCustomAttributesCommand}
117
107
  */
118
108
  addCustomAttributes(args: AddCustomAttributesCommandInput, options?: __HttpHandlerOptions): Promise<AddCustomAttributesCommandOutput>;
119
109
  addCustomAttributes(args: AddCustomAttributesCommandInput, cb: (err: any, data?: AddCustomAttributesCommandOutput) => void): void;
120
110
  addCustomAttributes(args: AddCustomAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddCustomAttributesCommandOutput) => void): void;
121
111
  /**
122
- * @public
123
- * <p>Adds the specified user to the specified group.</p>
124
- * <p>Calling this action requires developer credentials.</p>
112
+ * @see {@link AdminAddUserToGroupCommand}
125
113
  */
126
114
  adminAddUserToGroup(args: AdminAddUserToGroupCommandInput, options?: __HttpHandlerOptions): Promise<AdminAddUserToGroupCommandOutput>;
127
115
  adminAddUserToGroup(args: AdminAddUserToGroupCommandInput, cb: (err: any, data?: AdminAddUserToGroupCommandOutput) => void): void;
128
116
  adminAddUserToGroup(args: AdminAddUserToGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminAddUserToGroupCommandOutput) => void): void;
129
117
  /**
130
- * @public
131
- * <p>Confirms user registration as an admin without using a confirmation code. Works on any
132
- * user.</p>
133
- * <p>Calling this action requires developer credentials.</p>
118
+ * @see {@link AdminConfirmSignUpCommand}
134
119
  */
135
120
  adminConfirmSignUp(args: AdminConfirmSignUpCommandInput, options?: __HttpHandlerOptions): Promise<AdminConfirmSignUpCommandOutput>;
136
121
  adminConfirmSignUp(args: AdminConfirmSignUpCommandInput, cb: (err: any, data?: AdminConfirmSignUpCommandOutput) => void): void;
137
122
  adminConfirmSignUp(args: AdminConfirmSignUpCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminConfirmSignUpCommandOutput) => void): void;
138
123
  /**
139
- * @public
140
- * <p>Creates a new user in the specified user pool.</p>
141
- * <p>If <code>MessageAction</code> isn't set, the default is to send a welcome message via
142
- * email or phone (SMS).</p>
143
- *
144
- * <note>
145
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
146
- * require you to register an origination phone number before you can send SMS messages
147
- * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
148
- * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
149
- * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
150
- * receive SMS messages might not be able to sign up, activate their accounts, or sign
151
- * in.</p>
152
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
153
- * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
154
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
155
- * mode</a>
156
- * </i>, you can send messages only to verified phone
157
- * numbers. After you test your app while in the sandbox environment, you can move out
158
- * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
159
- * Developer Guide</i>.</p>
160
- * </note>
161
- *
162
- * <p>This message is based on a template that you configured in your call to create or
163
- * update a user pool. This template includes your custom sign-up instructions and
164
- * placeholders for user name and temporary password.</p>
165
- * <p>Alternatively, you can call <code>AdminCreateUser</code> with <code>SUPPRESS</code>
166
- * for the <code>MessageAction</code> parameter, and Amazon Cognito won't send any email. </p>
167
- * <p>In either case, the user will be in the <code>FORCE_CHANGE_PASSWORD</code> state until
168
- * they sign in and change their password.</p>
169
- * <p>
170
- * <code>AdminCreateUser</code> requires developer credentials.</p>
124
+ * @see {@link AdminCreateUserCommand}
171
125
  */
172
126
  adminCreateUser(args: AdminCreateUserCommandInput, options?: __HttpHandlerOptions): Promise<AdminCreateUserCommandOutput>;
173
127
  adminCreateUser(args: AdminCreateUserCommandInput, cb: (err: any, data?: AdminCreateUserCommandOutput) => void): void;
174
128
  adminCreateUser(args: AdminCreateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminCreateUserCommandOutput) => void): void;
175
129
  /**
176
- * @public
177
- * <p>Deletes a user as an administrator. Works on any user.</p>
178
- * <p>Calling this action requires developer credentials.</p>
130
+ * @see {@link AdminDeleteUserCommand}
179
131
  */
180
132
  adminDeleteUser(args: AdminDeleteUserCommandInput, options?: __HttpHandlerOptions): Promise<AdminDeleteUserCommandOutput>;
181
133
  adminDeleteUser(args: AdminDeleteUserCommandInput, cb: (err: any, data?: AdminDeleteUserCommandOutput) => void): void;
182
134
  adminDeleteUser(args: AdminDeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminDeleteUserCommandOutput) => void): void;
183
135
  /**
184
- * @public
185
- * <p>Deletes the user attributes in a user pool as an administrator. Works on any
186
- * user.</p>
187
- * <p>Calling this action requires developer credentials.</p>
136
+ * @see {@link AdminDeleteUserAttributesCommand}
188
137
  */
189
138
  adminDeleteUserAttributes(args: AdminDeleteUserAttributesCommandInput, options?: __HttpHandlerOptions): Promise<AdminDeleteUserAttributesCommandOutput>;
190
139
  adminDeleteUserAttributes(args: AdminDeleteUserAttributesCommandInput, cb: (err: any, data?: AdminDeleteUserAttributesCommandOutput) => void): void;
191
140
  adminDeleteUserAttributes(args: AdminDeleteUserAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminDeleteUserAttributesCommandOutput) => void): void;
192
141
  /**
193
- * @public
194
- * <p>Prevents the user from signing in with the specified external (SAML or social)
195
- * identity provider (IdP). If the user that you want to deactivate is a Amazon Cognito user pools
196
- * native username + password user, they can't use their password to sign in. If the user
197
- * to deactivate is a linked external IdP user, any link between that user and an existing
198
- * user is removed. When the external user signs in again, and the user is no longer
199
- * attached to the previously linked <code>DestinationUser</code>, the user must create a
200
- * new user account. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html">AdminLinkProviderForUser</a>.</p>
201
- * <p>This action is enabled only for admin access and requires developer
202
- * credentials.</p>
203
- * <p>The <code>ProviderName</code> must match the value specified when creating an IdP for
204
- * the pool. </p>
205
- * <p>To deactivate a native username + password user, the <code>ProviderName</code> value
206
- * must be <code>Cognito</code> and the <code>ProviderAttributeName</code> must be
207
- * <code>Cognito_Subject</code>. The <code>ProviderAttributeValue</code> must be the
208
- * name that is used in the user pool for the user.</p>
209
- * <p>The <code>ProviderAttributeName</code> must always be <code>Cognito_Subject</code> for
210
- * social IdPs. The <code>ProviderAttributeValue</code> must always be the exact subject
211
- * that was used when the user was originally linked as a source user.</p>
212
- * <p>For de-linking a SAML identity, there are two scenarios. If the linked identity has
213
- * not yet been used to sign in, the <code>ProviderAttributeName</code> and
214
- * <code>ProviderAttributeValue</code> must be the same values that were used for the
215
- * <code>SourceUser</code> when the identities were originally linked using <code>
216
- * AdminLinkProviderForUser</code> call. (If the linking was done with
217
- * <code>ProviderAttributeName</code> set to <code>Cognito_Subject</code>, the same
218
- * applies here). However, if the user has already signed in, the
219
- * <code>ProviderAttributeName</code> must be <code>Cognito_Subject</code> and
220
- * <code>ProviderAttributeValue</code> must be the subject of the SAML
221
- * assertion.</p>
142
+ * @see {@link AdminDisableProviderForUserCommand}
222
143
  */
223
144
  adminDisableProviderForUser(args: AdminDisableProviderForUserCommandInput, options?: __HttpHandlerOptions): Promise<AdminDisableProviderForUserCommandOutput>;
224
145
  adminDisableProviderForUser(args: AdminDisableProviderForUserCommandInput, cb: (err: any, data?: AdminDisableProviderForUserCommandOutput) => void): void;
225
146
  adminDisableProviderForUser(args: AdminDisableProviderForUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminDisableProviderForUserCommandOutput) => void): void;
226
147
  /**
227
- * @public
228
- * <p>Deactivates a user and revokes all access tokens for the user. A deactivated user can't sign in,
229
- * but still appears in the responses to <code>GetUser</code> and <code>ListUsers</code> API requests.</p>
230
- * <p>You must make this API request with Amazon Web Services credentials that have <code>cognito-idp:AdminDisableUser</code> permissions.</p>
148
+ * @see {@link AdminDisableUserCommand}
231
149
  */
232
150
  adminDisableUser(args: AdminDisableUserCommandInput, options?: __HttpHandlerOptions): Promise<AdminDisableUserCommandOutput>;
233
151
  adminDisableUser(args: AdminDisableUserCommandInput, cb: (err: any, data?: AdminDisableUserCommandOutput) => void): void;
234
152
  adminDisableUser(args: AdminDisableUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminDisableUserCommandOutput) => void): void;
235
153
  /**
236
- * @public
237
- * <p>Enables the specified user as an administrator. Works on any user.</p>
238
- * <p>Calling this action requires developer credentials.</p>
154
+ * @see {@link AdminEnableUserCommand}
239
155
  */
240
156
  adminEnableUser(args: AdminEnableUserCommandInput, options?: __HttpHandlerOptions): Promise<AdminEnableUserCommandOutput>;
241
157
  adminEnableUser(args: AdminEnableUserCommandInput, cb: (err: any, data?: AdminEnableUserCommandOutput) => void): void;
242
158
  adminEnableUser(args: AdminEnableUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminEnableUserCommandOutput) => void): void;
243
159
  /**
244
- * @public
245
- * <p>Forgets the device, as an administrator.</p>
246
- * <p>Calling this action requires developer credentials.</p>
160
+ * @see {@link AdminForgetDeviceCommand}
247
161
  */
248
162
  adminForgetDevice(args: AdminForgetDeviceCommandInput, options?: __HttpHandlerOptions): Promise<AdminForgetDeviceCommandOutput>;
249
163
  adminForgetDevice(args: AdminForgetDeviceCommandInput, cb: (err: any, data?: AdminForgetDeviceCommandOutput) => void): void;
250
164
  adminForgetDevice(args: AdminForgetDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminForgetDeviceCommandOutput) => void): void;
251
165
  /**
252
- * @public
253
- * <p>Gets the device, as an administrator.</p>
254
- * <p>Calling this action requires developer credentials.</p>
166
+ * @see {@link AdminGetDeviceCommand}
255
167
  */
256
168
  adminGetDevice(args: AdminGetDeviceCommandInput, options?: __HttpHandlerOptions): Promise<AdminGetDeviceCommandOutput>;
257
169
  adminGetDevice(args: AdminGetDeviceCommandInput, cb: (err: any, data?: AdminGetDeviceCommandOutput) => void): void;
258
170
  adminGetDevice(args: AdminGetDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminGetDeviceCommandOutput) => void): void;
259
171
  /**
260
- * @public
261
- * <p>Gets the specified user by user name in a user pool as an administrator. Works on any
262
- * user.</p>
263
- * <p>Calling this action requires developer credentials.</p>
172
+ * @see {@link AdminGetUserCommand}
264
173
  */
265
174
  adminGetUser(args: AdminGetUserCommandInput, options?: __HttpHandlerOptions): Promise<AdminGetUserCommandOutput>;
266
175
  adminGetUser(args: AdminGetUserCommandInput, cb: (err: any, data?: AdminGetUserCommandOutput) => void): void;
267
176
  adminGetUser(args: AdminGetUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminGetUserCommandOutput) => void): void;
268
177
  /**
269
- * @public
270
- * <p>Initiates the authentication flow, as an administrator.</p>
271
- *
272
- * <note>
273
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
274
- * require you to register an origination phone number before you can send SMS messages
275
- * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
276
- * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
277
- * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
278
- * receive SMS messages might not be able to sign up, activate their accounts, or sign
279
- * in.</p>
280
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
281
- * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
282
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
283
- * mode</a>
284
- * </i>, you can send messages only to verified phone
285
- * numbers. After you test your app while in the sandbox environment, you can move out
286
- * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
287
- * Developer Guide</i>.</p>
288
- * </note>
289
- *
290
- * <p>Calling this action requires developer credentials.</p>
178
+ * @see {@link AdminInitiateAuthCommand}
291
179
  */
292
180
  adminInitiateAuth(args: AdminInitiateAuthCommandInput, options?: __HttpHandlerOptions): Promise<AdminInitiateAuthCommandOutput>;
293
181
  adminInitiateAuth(args: AdminInitiateAuthCommandInput, cb: (err: any, data?: AdminInitiateAuthCommandOutput) => void): void;
294
182
  adminInitiateAuth(args: AdminInitiateAuthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminInitiateAuthCommandOutput) => void): void;
295
183
  /**
296
- * @public
297
- * <p>Links an existing user account in a user pool (<code>DestinationUser</code>) to an
298
- * identity from an external IdP (<code>SourceUser</code>) based on a specified attribute
299
- * name and value from the external IdP. This allows you to create a link from the existing
300
- * user account to an external federated user identity that has not yet been used to sign
301
- * in. You can then use the federated user identity to sign in as the existing user
302
- * account. </p>
303
- * <p> For example, if there is an existing user with a username and password, this API
304
- * links that user to a federated user identity. When the user signs in with a federated
305
- * user identity, they sign in as the existing user account.</p>
306
- * <note>
307
- * <p>The maximum number of federated identities linked to a user is five.</p>
308
- * </note>
309
- * <important>
310
- * <p>Because this API allows a user with an external federated identity to sign in as
311
- * an existing user in the user pool, it is critical that it only be used with external
312
- * IdPs and provider attributes that have been trusted by the application owner.</p>
313
- * </important>
314
- *
315
- * <p>This action is administrative and requires developer credentials.</p>
184
+ * @see {@link AdminLinkProviderForUserCommand}
316
185
  */
317
186
  adminLinkProviderForUser(args: AdminLinkProviderForUserCommandInput, options?: __HttpHandlerOptions): Promise<AdminLinkProviderForUserCommandOutput>;
318
187
  adminLinkProviderForUser(args: AdminLinkProviderForUserCommandInput, cb: (err: any, data?: AdminLinkProviderForUserCommandOutput) => void): void;
319
188
  adminLinkProviderForUser(args: AdminLinkProviderForUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminLinkProviderForUserCommandOutput) => void): void;
320
189
  /**
321
- * @public
322
- * <p>Lists devices, as an administrator.</p>
323
- * <p>Calling this action requires developer credentials.</p>
190
+ * @see {@link AdminListDevicesCommand}
324
191
  */
325
192
  adminListDevices(args: AdminListDevicesCommandInput, options?: __HttpHandlerOptions): Promise<AdminListDevicesCommandOutput>;
326
193
  adminListDevices(args: AdminListDevicesCommandInput, cb: (err: any, data?: AdminListDevicesCommandOutput) => void): void;
327
194
  adminListDevices(args: AdminListDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminListDevicesCommandOutput) => void): void;
328
195
  /**
329
- * @public
330
- * <p>Lists the groups that the user belongs to.</p>
331
- * <p>Calling this action requires developer credentials.</p>
196
+ * @see {@link AdminListGroupsForUserCommand}
332
197
  */
333
198
  adminListGroupsForUser(args: AdminListGroupsForUserCommandInput, options?: __HttpHandlerOptions): Promise<AdminListGroupsForUserCommandOutput>;
334
199
  adminListGroupsForUser(args: AdminListGroupsForUserCommandInput, cb: (err: any, data?: AdminListGroupsForUserCommandOutput) => void): void;
335
200
  adminListGroupsForUser(args: AdminListGroupsForUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminListGroupsForUserCommandOutput) => void): void;
336
201
  /**
337
- * @public
338
- * <p>A history of user activity and any risks detected as part of Amazon Cognito advanced
339
- * security.</p>
202
+ * @see {@link AdminListUserAuthEventsCommand}
340
203
  */
341
204
  adminListUserAuthEvents(args: AdminListUserAuthEventsCommandInput, options?: __HttpHandlerOptions): Promise<AdminListUserAuthEventsCommandOutput>;
342
205
  adminListUserAuthEvents(args: AdminListUserAuthEventsCommandInput, cb: (err: any, data?: AdminListUserAuthEventsCommandOutput) => void): void;
343
206
  adminListUserAuthEvents(args: AdminListUserAuthEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminListUserAuthEventsCommandOutput) => void): void;
344
207
  /**
345
- * @public
346
- * <p>Removes the specified user from the specified group.</p>
347
- * <p>Calling this action requires developer credentials.</p>
208
+ * @see {@link AdminRemoveUserFromGroupCommand}
348
209
  */
349
210
  adminRemoveUserFromGroup(args: AdminRemoveUserFromGroupCommandInput, options?: __HttpHandlerOptions): Promise<AdminRemoveUserFromGroupCommandOutput>;
350
211
  adminRemoveUserFromGroup(args: AdminRemoveUserFromGroupCommandInput, cb: (err: any, data?: AdminRemoveUserFromGroupCommandOutput) => void): void;
351
212
  adminRemoveUserFromGroup(args: AdminRemoveUserFromGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminRemoveUserFromGroupCommandOutput) => void): void;
352
213
  /**
353
- * @public
354
- * <p>Resets the specified user's password in a user pool as an administrator. Works on any
355
- * user.</p>
356
- * <p>When a developer calls this API, the current password is invalidated, so it must be
357
- * changed. If a user tries to sign in after the API is called, the app will get a
358
- * PasswordResetRequiredException exception back and should direct the user down the flow
359
- * to reset the password, which is the same as the forgot password flow. In addition, if
360
- * the user pool has phone verification selected and a verified phone number exists for the
361
- * user, or if email verification is selected and a verified email exists for the user,
362
- * calling this API will also result in sending a message to the end user with the code to
363
- * change their password.</p>
364
- *
365
- * <note>
366
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
367
- * require you to register an origination phone number before you can send SMS messages
368
- * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
369
- * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
370
- * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
371
- * receive SMS messages might not be able to sign up, activate their accounts, or sign
372
- * in.</p>
373
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
374
- * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
375
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
376
- * mode</a>
377
- * </i>, you can send messages only to verified phone
378
- * numbers. After you test your app while in the sandbox environment, you can move out
379
- * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
380
- * Developer Guide</i>.</p>
381
- * </note>
382
- *
383
- * <p>Calling this action requires developer credentials.</p>
214
+ * @see {@link AdminResetUserPasswordCommand}
384
215
  */
385
216
  adminResetUserPassword(args: AdminResetUserPasswordCommandInput, options?: __HttpHandlerOptions): Promise<AdminResetUserPasswordCommandOutput>;
386
217
  adminResetUserPassword(args: AdminResetUserPasswordCommandInput, cb: (err: any, data?: AdminResetUserPasswordCommandOutput) => void): void;
387
218
  adminResetUserPassword(args: AdminResetUserPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminResetUserPasswordCommandOutput) => void): void;
388
219
  /**
389
- * @public
390
- * <p>Responds to an authentication challenge, as an administrator.</p>
391
- *
392
- * <note>
393
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
394
- * require you to register an origination phone number before you can send SMS messages
395
- * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
396
- * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
397
- * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
398
- * receive SMS messages might not be able to sign up, activate their accounts, or sign
399
- * in.</p>
400
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
401
- * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
402
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
403
- * mode</a>
404
- * </i>, you can send messages only to verified phone
405
- * numbers. After you test your app while in the sandbox environment, you can move out
406
- * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
407
- * Developer Guide</i>.</p>
408
- * </note>
409
- *
410
- * <p>Calling this action requires developer credentials.</p>
220
+ * @see {@link AdminRespondToAuthChallengeCommand}
411
221
  */
412
222
  adminRespondToAuthChallenge(args: AdminRespondToAuthChallengeCommandInput, options?: __HttpHandlerOptions): Promise<AdminRespondToAuthChallengeCommandOutput>;
413
223
  adminRespondToAuthChallenge(args: AdminRespondToAuthChallengeCommandInput, cb: (err: any, data?: AdminRespondToAuthChallengeCommandOutput) => void): void;
414
224
  adminRespondToAuthChallenge(args: AdminRespondToAuthChallengeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminRespondToAuthChallengeCommandOutput) => void): void;
415
225
  /**
416
- * @public
417
- * <p>The user's multi-factor authentication (MFA) preference, including which MFA options
418
- * are activated, and if any are preferred. Only one factor can be set as preferred. The
419
- * preferred MFA factor will be used to authenticate a user if multiple factors are
420
- * activated. If multiple options are activated and no preference is set, a challenge to
421
- * choose an MFA option will be returned during sign-in.</p>
226
+ * @see {@link AdminSetUserMFAPreferenceCommand}
422
227
  */
423
228
  adminSetUserMFAPreference(args: AdminSetUserMFAPreferenceCommandInput, options?: __HttpHandlerOptions): Promise<AdminSetUserMFAPreferenceCommandOutput>;
424
229
  adminSetUserMFAPreference(args: AdminSetUserMFAPreferenceCommandInput, cb: (err: any, data?: AdminSetUserMFAPreferenceCommandOutput) => void): void;
425
230
  adminSetUserMFAPreference(args: AdminSetUserMFAPreferenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminSetUserMFAPreferenceCommandOutput) => void): void;
426
231
  /**
427
- * @public
428
- * <p>Sets the specified user's password in a user pool as an administrator. Works on any
429
- * user. </p>
430
- * <p>The password can be temporary or permanent. If it is temporary, the user status enters
431
- * the <code>FORCE_CHANGE_PASSWORD</code> state. When the user next tries to sign in, the
432
- * InitiateAuth/AdminInitiateAuth response will contain the
433
- * <code>NEW_PASSWORD_REQUIRED</code> challenge. If the user doesn't sign in before it
434
- * expires, the user won't be able to sign in, and an administrator must reset their
435
- * password. </p>
436
- * <p>Once the user has set a new password, or the password is permanent, the user status is
437
- * set to <code>Confirmed</code>.</p>
232
+ * @see {@link AdminSetUserPasswordCommand}
438
233
  */
439
234
  adminSetUserPassword(args: AdminSetUserPasswordCommandInput, options?: __HttpHandlerOptions): Promise<AdminSetUserPasswordCommandOutput>;
440
235
  adminSetUserPassword(args: AdminSetUserPasswordCommandInput, cb: (err: any, data?: AdminSetUserPasswordCommandOutput) => void): void;
441
236
  adminSetUserPassword(args: AdminSetUserPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminSetUserPasswordCommandOutput) => void): void;
442
237
  /**
443
- * @public
444
- * <p>
445
- * <i>This action is no longer supported.</i> You can use it to configure
446
- * only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software
447
- * token MFA. To configure either type of MFA, use <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserMFAPreference.html">AdminSetUserMFAPreference</a> instead.</p>
238
+ * @see {@link AdminSetUserSettingsCommand}
448
239
  */
449
240
  adminSetUserSettings(args: AdminSetUserSettingsCommandInput, options?: __HttpHandlerOptions): Promise<AdminSetUserSettingsCommandOutput>;
450
241
  adminSetUserSettings(args: AdminSetUserSettingsCommandInput, cb: (err: any, data?: AdminSetUserSettingsCommandOutput) => void): void;
451
242
  adminSetUserSettings(args: AdminSetUserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminSetUserSettingsCommandOutput) => void): void;
452
243
  /**
453
- * @public
454
- * <p>Provides feedback for an authentication event indicating if it was from a valid user.
455
- * This feedback is used for improving the risk evaluation decision for the user pool as
456
- * part of Amazon Cognito advanced security.</p>
244
+ * @see {@link AdminUpdateAuthEventFeedbackCommand}
457
245
  */
458
246
  adminUpdateAuthEventFeedback(args: AdminUpdateAuthEventFeedbackCommandInput, options?: __HttpHandlerOptions): Promise<AdminUpdateAuthEventFeedbackCommandOutput>;
459
247
  adminUpdateAuthEventFeedback(args: AdminUpdateAuthEventFeedbackCommandInput, cb: (err: any, data?: AdminUpdateAuthEventFeedbackCommandOutput) => void): void;
460
248
  adminUpdateAuthEventFeedback(args: AdminUpdateAuthEventFeedbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminUpdateAuthEventFeedbackCommandOutput) => void): void;
461
249
  /**
462
- * @public
463
- * <p>Updates the device status as an administrator.</p>
464
- * <p>Calling this action requires developer credentials.</p>
250
+ * @see {@link AdminUpdateDeviceStatusCommand}
465
251
  */
466
252
  adminUpdateDeviceStatus(args: AdminUpdateDeviceStatusCommandInput, options?: __HttpHandlerOptions): Promise<AdminUpdateDeviceStatusCommandOutput>;
467
253
  adminUpdateDeviceStatus(args: AdminUpdateDeviceStatusCommandInput, cb: (err: any, data?: AdminUpdateDeviceStatusCommandOutput) => void): void;
468
254
  adminUpdateDeviceStatus(args: AdminUpdateDeviceStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminUpdateDeviceStatusCommandOutput) => void): void;
469
255
  /**
470
- * @public
471
- * <p>Updates the specified user's attributes, including developer attributes, as an
472
- * administrator. Works on any user.</p>
473
- * <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the
474
- * attribute name.</p>
475
- * <p>In addition to updating user attributes, this API can also be used to mark phone and
476
- * email as verified.</p>
477
- *
478
- * <note>
479
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
480
- * require you to register an origination phone number before you can send SMS messages
481
- * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
482
- * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
483
- * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
484
- * receive SMS messages might not be able to sign up, activate their accounts, or sign
485
- * in.</p>
486
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
487
- * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
488
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
489
- * mode</a>
490
- * </i>, you can send messages only to verified phone
491
- * numbers. After you test your app while in the sandbox environment, you can move out
492
- * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
493
- * Developer Guide</i>.</p>
494
- * </note>
495
- *
496
- * <p>Calling this action requires developer credentials.</p>
256
+ * @see {@link AdminUpdateUserAttributesCommand}
497
257
  */
498
258
  adminUpdateUserAttributes(args: AdminUpdateUserAttributesCommandInput, options?: __HttpHandlerOptions): Promise<AdminUpdateUserAttributesCommandOutput>;
499
259
  adminUpdateUserAttributes(args: AdminUpdateUserAttributesCommandInput, cb: (err: any, data?: AdminUpdateUserAttributesCommandOutput) => void): void;
500
260
  adminUpdateUserAttributes(args: AdminUpdateUserAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminUpdateUserAttributesCommandOutput) => void): void;
501
261
  /**
502
- * @public
503
- * <p>Signs out a user from all devices. You must sign <code>AdminUserGlobalSignOut</code> requests
504
- * with Amazon Web Services credentials. It also invalidates all refresh tokens that Amazon Cognito has issued to
505
- * a user. The user's current access and ID tokens remain valid until they expire. By
506
- * default, access and ID tokens expire one hour after they're issued. A user can still use
507
- * a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period
508
- * of 1 hour.</p>
509
- * <p>Calling this action requires developer credentials.</p>
262
+ * @see {@link AdminUserGlobalSignOutCommand}
510
263
  */
511
264
  adminUserGlobalSignOut(args: AdminUserGlobalSignOutCommandInput, options?: __HttpHandlerOptions): Promise<AdminUserGlobalSignOutCommandOutput>;
512
265
  adminUserGlobalSignOut(args: AdminUserGlobalSignOutCommandInput, cb: (err: any, data?: AdminUserGlobalSignOutCommandOutput) => void): void;
513
266
  adminUserGlobalSignOut(args: AdminUserGlobalSignOutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminUserGlobalSignOutCommandOutput) => void): void;
514
267
  /**
515
- * @public
516
- * <p>Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA)
517
- * for a user, with a unique private key that Amazon Cognito generates and returns in the API
518
- * response. You can authorize an <code>AssociateSoftwareToken</code> request with either
519
- * the user's access token, or a session string from a challenge response that you received
520
- * from Amazon Cognito.</p>
521
- * <note>
522
- * <p>Amazon Cognito disassociates an existing software token when you verify the new token in a
523
- * <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifySoftwareToken.html"> VerifySoftwareToken</a> API request. If you don't verify the software
524
- * token and your user pool doesn't require MFA, the user can then authenticate with
525
- * user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito
526
- * generates an <code>MFA_SETUP</code> or <code>SOFTWARE_TOKEN_SETUP</code> challenge
527
- * each time your user signs. Complete setup with <code>AssociateSoftwareToken</code>
528
- * and <code>VerifySoftwareToken</code>.</p>
529
- * <p>After you set up software token MFA for your user, Amazon Cognito generates a
530
- * <code>SOFTWARE_TOKEN_MFA</code> challenge when they authenticate. Respond to
531
- * this challenge with your user's TOTP.</p>
532
- * </note>
268
+ * @see {@link AssociateSoftwareTokenCommand}
533
269
  */
534
270
  associateSoftwareToken(args: AssociateSoftwareTokenCommandInput, options?: __HttpHandlerOptions): Promise<AssociateSoftwareTokenCommandOutput>;
535
271
  associateSoftwareToken(args: AssociateSoftwareTokenCommandInput, cb: (err: any, data?: AssociateSoftwareTokenCommandOutput) => void): void;
536
272
  associateSoftwareToken(args: AssociateSoftwareTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateSoftwareTokenCommandOutput) => void): void;
537
273
  /**
538
- * @public
539
- * <p>Changes the password for a specified user in a user pool.</p>
274
+ * @see {@link ChangePasswordCommand}
540
275
  */
541
276
  changePassword(args: ChangePasswordCommandInput, options?: __HttpHandlerOptions): Promise<ChangePasswordCommandOutput>;
542
277
  changePassword(args: ChangePasswordCommandInput, cb: (err: any, data?: ChangePasswordCommandOutput) => void): void;
543
278
  changePassword(args: ChangePasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ChangePasswordCommandOutput) => void): void;
544
279
  /**
545
- * @public
546
- * <p>Confirms tracking of the device. This API call is the call that begins device
547
- * tracking.</p>
280
+ * @see {@link ConfirmDeviceCommand}
548
281
  */
549
282
  confirmDevice(args: ConfirmDeviceCommandInput, options?: __HttpHandlerOptions): Promise<ConfirmDeviceCommandOutput>;
550
283
  confirmDevice(args: ConfirmDeviceCommandInput, cb: (err: any, data?: ConfirmDeviceCommandOutput) => void): void;
551
284
  confirmDevice(args: ConfirmDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfirmDeviceCommandOutput) => void): void;
552
285
  /**
553
- * @public
554
- * <p>Allows a user to enter a confirmation code to reset a forgotten password.</p>
286
+ * @see {@link ConfirmForgotPasswordCommand}
555
287
  */
556
288
  confirmForgotPassword(args: ConfirmForgotPasswordCommandInput, options?: __HttpHandlerOptions): Promise<ConfirmForgotPasswordCommandOutput>;
557
289
  confirmForgotPassword(args: ConfirmForgotPasswordCommandInput, cb: (err: any, data?: ConfirmForgotPasswordCommandOutput) => void): void;
558
290
  confirmForgotPassword(args: ConfirmForgotPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfirmForgotPasswordCommandOutput) => void): void;
559
291
  /**
560
- * @public
561
- * <p>Confirms registration of a new user.</p>
292
+ * @see {@link ConfirmSignUpCommand}
562
293
  */
563
294
  confirmSignUp(args: ConfirmSignUpCommandInput, options?: __HttpHandlerOptions): Promise<ConfirmSignUpCommandOutput>;
564
295
  confirmSignUp(args: ConfirmSignUpCommandInput, cb: (err: any, data?: ConfirmSignUpCommandOutput) => void): void;
565
296
  confirmSignUp(args: ConfirmSignUpCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfirmSignUpCommandOutput) => void): void;
566
297
  /**
567
- * @public
568
- * <p>Creates a new group in the specified user pool.</p>
569
- * <p>Calling this action requires developer credentials.</p>
298
+ * @see {@link CreateGroupCommand}
570
299
  */
571
300
  createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateGroupCommandOutput>;
572
301
  createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void;
573
302
  createGroup(args: CreateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupCommandOutput) => void): void;
574
303
  /**
575
- * @public
576
- * <p>Creates an IdP for a user pool.</p>
304
+ * @see {@link CreateIdentityProviderCommand}
577
305
  */
578
306
  createIdentityProvider(args: CreateIdentityProviderCommandInput, options?: __HttpHandlerOptions): Promise<CreateIdentityProviderCommandOutput>;
579
307
  createIdentityProvider(args: CreateIdentityProviderCommandInput, cb: (err: any, data?: CreateIdentityProviderCommandOutput) => void): void;
580
308
  createIdentityProvider(args: CreateIdentityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIdentityProviderCommandOutput) => void): void;
581
309
  /**
582
- * @public
583
- * <p>Creates a new OAuth2.0 resource server and defines custom scopes within it.</p>
310
+ * @see {@link CreateResourceServerCommand}
584
311
  */
585
312
  createResourceServer(args: CreateResourceServerCommandInput, options?: __HttpHandlerOptions): Promise<CreateResourceServerCommandOutput>;
586
313
  createResourceServer(args: CreateResourceServerCommandInput, cb: (err: any, data?: CreateResourceServerCommandOutput) => void): void;
587
314
  createResourceServer(args: CreateResourceServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResourceServerCommandOutput) => void): void;
588
315
  /**
589
- * @public
590
- * <p>Creates the user import job.</p>
316
+ * @see {@link CreateUserImportJobCommand}
591
317
  */
592
318
  createUserImportJob(args: CreateUserImportJobCommandInput, options?: __HttpHandlerOptions): Promise<CreateUserImportJobCommandOutput>;
593
319
  createUserImportJob(args: CreateUserImportJobCommandInput, cb: (err: any, data?: CreateUserImportJobCommandOutput) => void): void;
594
320
  createUserImportJob(args: CreateUserImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserImportJobCommandOutput) => void): void;
595
321
  /**
596
- * @public
597
- * <p>Creates a new Amazon Cognito user pool and sets the password policy for the
598
- * pool.</p>
599
- *
600
- * <note>
601
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
602
- * require you to register an origination phone number before you can send SMS messages
603
- * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
604
- * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
605
- * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
606
- * receive SMS messages might not be able to sign up, activate their accounts, or sign
607
- * in.</p>
608
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
609
- * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
610
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
611
- * mode</a>
612
- * </i>, you can send messages only to verified phone
613
- * numbers. After you test your app while in the sandbox environment, you can move out
614
- * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
615
- * Developer Guide</i>.</p>
616
- * </note>
322
+ * @see {@link CreateUserPoolCommand}
617
323
  */
618
324
  createUserPool(args: CreateUserPoolCommandInput, options?: __HttpHandlerOptions): Promise<CreateUserPoolCommandOutput>;
619
325
  createUserPool(args: CreateUserPoolCommandInput, cb: (err: any, data?: CreateUserPoolCommandOutput) => void): void;
620
326
  createUserPool(args: CreateUserPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserPoolCommandOutput) => void): void;
621
327
  /**
622
- * @public
623
- * <p>Creates the user pool client.</p>
624
- * <p>When you create a new user pool client, token revocation is automatically activated.
625
- * For more information about revoking tokens, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
328
+ * @see {@link CreateUserPoolClientCommand}
626
329
  */
627
330
  createUserPoolClient(args: CreateUserPoolClientCommandInput, options?: __HttpHandlerOptions): Promise<CreateUserPoolClientCommandOutput>;
628
331
  createUserPoolClient(args: CreateUserPoolClientCommandInput, cb: (err: any, data?: CreateUserPoolClientCommandOutput) => void): void;
629
332
  createUserPoolClient(args: CreateUserPoolClientCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserPoolClientCommandOutput) => void): void;
630
333
  /**
631
- * @public
632
- * <p>Creates a new domain for a user pool.</p>
334
+ * @see {@link CreateUserPoolDomainCommand}
633
335
  */
634
336
  createUserPoolDomain(args: CreateUserPoolDomainCommandInput, options?: __HttpHandlerOptions): Promise<CreateUserPoolDomainCommandOutput>;
635
337
  createUserPoolDomain(args: CreateUserPoolDomainCommandInput, cb: (err: any, data?: CreateUserPoolDomainCommandOutput) => void): void;
636
338
  createUserPoolDomain(args: CreateUserPoolDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserPoolDomainCommandOutput) => void): void;
637
339
  /**
638
- * @public
639
- * <p>Deletes a group.</p>
640
- * <p>Calling this action requires developer credentials.</p>
340
+ * @see {@link DeleteGroupCommand}
641
341
  */
642
342
  deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteGroupCommandOutput>;
643
343
  deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void;
644
344
  deleteGroup(args: DeleteGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void;
645
345
  /**
646
- * @public
647
- * <p>Deletes an IdP for a user pool.</p>
346
+ * @see {@link DeleteIdentityProviderCommand}
648
347
  */
649
348
  deleteIdentityProvider(args: DeleteIdentityProviderCommandInput, options?: __HttpHandlerOptions): Promise<DeleteIdentityProviderCommandOutput>;
650
349
  deleteIdentityProvider(args: DeleteIdentityProviderCommandInput, cb: (err: any, data?: DeleteIdentityProviderCommandOutput) => void): void;
651
350
  deleteIdentityProvider(args: DeleteIdentityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIdentityProviderCommandOutput) => void): void;
652
351
  /**
653
- * @public
654
- * <p>Deletes a resource server.</p>
352
+ * @see {@link DeleteResourceServerCommand}
655
353
  */
656
354
  deleteResourceServer(args: DeleteResourceServerCommandInput, options?: __HttpHandlerOptions): Promise<DeleteResourceServerCommandOutput>;
657
355
  deleteResourceServer(args: DeleteResourceServerCommandInput, cb: (err: any, data?: DeleteResourceServerCommandOutput) => void): void;
658
356
  deleteResourceServer(args: DeleteResourceServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourceServerCommandOutput) => void): void;
659
357
  /**
660
- * @public
661
- * <p>Allows a user to delete himself or herself.</p>
358
+ * @see {@link DeleteUserCommand}
662
359
  */
663
360
  deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise<DeleteUserCommandOutput>;
664
361
  deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void;
665
362
  deleteUser(args: DeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserCommandOutput) => void): void;
666
363
  /**
667
- * @public
668
- * <p>Deletes the attributes for a user.</p>
364
+ * @see {@link DeleteUserAttributesCommand}
669
365
  */
670
366
  deleteUserAttributes(args: DeleteUserAttributesCommandInput, options?: __HttpHandlerOptions): Promise<DeleteUserAttributesCommandOutput>;
671
367
  deleteUserAttributes(args: DeleteUserAttributesCommandInput, cb: (err: any, data?: DeleteUserAttributesCommandOutput) => void): void;
672
368
  deleteUserAttributes(args: DeleteUserAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserAttributesCommandOutput) => void): void;
673
369
  /**
674
- * @public
675
- * <p>Deletes the specified Amazon Cognito user pool.</p>
370
+ * @see {@link DeleteUserPoolCommand}
676
371
  */
677
372
  deleteUserPool(args: DeleteUserPoolCommandInput, options?: __HttpHandlerOptions): Promise<DeleteUserPoolCommandOutput>;
678
373
  deleteUserPool(args: DeleteUserPoolCommandInput, cb: (err: any, data?: DeleteUserPoolCommandOutput) => void): void;
679
374
  deleteUserPool(args: DeleteUserPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserPoolCommandOutput) => void): void;
680
375
  /**
681
- * @public
682
- * <p>Allows the developer to delete the user pool client.</p>
376
+ * @see {@link DeleteUserPoolClientCommand}
683
377
  */
684
378
  deleteUserPoolClient(args: DeleteUserPoolClientCommandInput, options?: __HttpHandlerOptions): Promise<DeleteUserPoolClientCommandOutput>;
685
379
  deleteUserPoolClient(args: DeleteUserPoolClientCommandInput, cb: (err: any, data?: DeleteUserPoolClientCommandOutput) => void): void;
686
380
  deleteUserPoolClient(args: DeleteUserPoolClientCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserPoolClientCommandOutput) => void): void;
687
381
  /**
688
- * @public
689
- * <p>Deletes a domain for a user pool.</p>
382
+ * @see {@link DeleteUserPoolDomainCommand}
690
383
  */
691
384
  deleteUserPoolDomain(args: DeleteUserPoolDomainCommandInput, options?: __HttpHandlerOptions): Promise<DeleteUserPoolDomainCommandOutput>;
692
385
  deleteUserPoolDomain(args: DeleteUserPoolDomainCommandInput, cb: (err: any, data?: DeleteUserPoolDomainCommandOutput) => void): void;
693
386
  deleteUserPoolDomain(args: DeleteUserPoolDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserPoolDomainCommandOutput) => void): void;
694
387
  /**
695
- * @public
696
- * <p>Gets information about a specific IdP.</p>
388
+ * @see {@link DescribeIdentityProviderCommand}
697
389
  */
698
390
  describeIdentityProvider(args: DescribeIdentityProviderCommandInput, options?: __HttpHandlerOptions): Promise<DescribeIdentityProviderCommandOutput>;
699
391
  describeIdentityProvider(args: DescribeIdentityProviderCommandInput, cb: (err: any, data?: DescribeIdentityProviderCommandOutput) => void): void;
700
392
  describeIdentityProvider(args: DescribeIdentityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIdentityProviderCommandOutput) => void): void;
701
393
  /**
702
- * @public
703
- * <p>Describes a resource server.</p>
394
+ * @see {@link DescribeResourceServerCommand}
704
395
  */
705
396
  describeResourceServer(args: DescribeResourceServerCommandInput, options?: __HttpHandlerOptions): Promise<DescribeResourceServerCommandOutput>;
706
397
  describeResourceServer(args: DescribeResourceServerCommandInput, cb: (err: any, data?: DescribeResourceServerCommandOutput) => void): void;
707
398
  describeResourceServer(args: DescribeResourceServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeResourceServerCommandOutput) => void): void;
708
399
  /**
709
- * @public
710
- * <p>Describes the risk configuration.</p>
400
+ * @see {@link DescribeRiskConfigurationCommand}
711
401
  */
712
402
  describeRiskConfiguration(args: DescribeRiskConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRiskConfigurationCommandOutput>;
713
403
  describeRiskConfiguration(args: DescribeRiskConfigurationCommandInput, cb: (err: any, data?: DescribeRiskConfigurationCommandOutput) => void): void;
714
404
  describeRiskConfiguration(args: DescribeRiskConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRiskConfigurationCommandOutput) => void): void;
715
405
  /**
716
- * @public
717
- * <p>Describes the user import job.</p>
406
+ * @see {@link DescribeUserImportJobCommand}
718
407
  */
719
408
  describeUserImportJob(args: DescribeUserImportJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeUserImportJobCommandOutput>;
720
409
  describeUserImportJob(args: DescribeUserImportJobCommandInput, cb: (err: any, data?: DescribeUserImportJobCommandOutput) => void): void;
721
410
  describeUserImportJob(args: DescribeUserImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserImportJobCommandOutput) => void): void;
722
411
  /**
723
- * @public
724
- * <p>Returns the configuration information and metadata of the specified user pool.</p>
412
+ * @see {@link DescribeUserPoolCommand}
725
413
  */
726
414
  describeUserPool(args: DescribeUserPoolCommandInput, options?: __HttpHandlerOptions): Promise<DescribeUserPoolCommandOutput>;
727
415
  describeUserPool(args: DescribeUserPoolCommandInput, cb: (err: any, data?: DescribeUserPoolCommandOutput) => void): void;
728
416
  describeUserPool(args: DescribeUserPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserPoolCommandOutput) => void): void;
729
417
  /**
730
- * @public
731
- * <p>Client method for returning the configuration information and metadata of the
732
- * specified user pool app client.</p>
418
+ * @see {@link DescribeUserPoolClientCommand}
733
419
  */
734
420
  describeUserPoolClient(args: DescribeUserPoolClientCommandInput, options?: __HttpHandlerOptions): Promise<DescribeUserPoolClientCommandOutput>;
735
421
  describeUserPoolClient(args: DescribeUserPoolClientCommandInput, cb: (err: any, data?: DescribeUserPoolClientCommandOutput) => void): void;
736
422
  describeUserPoolClient(args: DescribeUserPoolClientCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserPoolClientCommandOutput) => void): void;
737
423
  /**
738
- * @public
739
- * <p>Gets information about a domain.</p>
424
+ * @see {@link DescribeUserPoolDomainCommand}
740
425
  */
741
426
  describeUserPoolDomain(args: DescribeUserPoolDomainCommandInput, options?: __HttpHandlerOptions): Promise<DescribeUserPoolDomainCommandOutput>;
742
427
  describeUserPoolDomain(args: DescribeUserPoolDomainCommandInput, cb: (err: any, data?: DescribeUserPoolDomainCommandOutput) => void): void;
743
428
  describeUserPoolDomain(args: DescribeUserPoolDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserPoolDomainCommandOutput) => void): void;
744
429
  /**
745
- * @public
746
- * <p>Forgets the specified device.</p>
430
+ * @see {@link ForgetDeviceCommand}
747
431
  */
748
432
  forgetDevice(args: ForgetDeviceCommandInput, options?: __HttpHandlerOptions): Promise<ForgetDeviceCommandOutput>;
749
433
  forgetDevice(args: ForgetDeviceCommandInput, cb: (err: any, data?: ForgetDeviceCommandOutput) => void): void;
750
434
  forgetDevice(args: ForgetDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ForgetDeviceCommandOutput) => void): void;
751
435
  /**
752
- * @public
753
- * <p>Calling this API causes a message to be sent to the end user with a confirmation code
754
- * that is required to change the user's password. For the <code>Username</code> parameter,
755
- * you can use the username or user alias. The method used to send the confirmation code is
756
- * sent according to the specified AccountRecoverySetting. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-recover-a-user-account.html">Recovering
757
- * User Accounts</a> in the <i>Amazon Cognito Developer Guide</i>. If
758
- * neither a verified phone number nor a verified email exists, an
759
- * <code>InvalidParameterException</code> is thrown. To use the confirmation code for
760
- * resetting the password, call <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html">ConfirmForgotPassword</a>. </p>
761
- *
762
- * <note>
763
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
764
- * require you to register an origination phone number before you can send SMS messages
765
- * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
766
- * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
767
- * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
768
- * receive SMS messages might not be able to sign up, activate their accounts, or sign
769
- * in.</p>
770
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
771
- * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
772
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
773
- * mode</a>
774
- * </i>, you can send messages only to verified phone
775
- * numbers. After you test your app while in the sandbox environment, you can move out
776
- * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
777
- * Developer Guide</i>.</p>
778
- * </note>
436
+ * @see {@link ForgotPasswordCommand}
779
437
  */
780
438
  forgotPassword(args: ForgotPasswordCommandInput, options?: __HttpHandlerOptions): Promise<ForgotPasswordCommandOutput>;
781
439
  forgotPassword(args: ForgotPasswordCommandInput, cb: (err: any, data?: ForgotPasswordCommandOutput) => void): void;
782
440
  forgotPassword(args: ForgotPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ForgotPasswordCommandOutput) => void): void;
783
441
  /**
784
- * @public
785
- * <p>Gets the header information for the comma-separated value (CSV) file to be used as
786
- * input for the user import job.</p>
442
+ * @see {@link GetCSVHeaderCommand}
787
443
  */
788
444
  getCSVHeader(args: GetCSVHeaderCommandInput, options?: __HttpHandlerOptions): Promise<GetCSVHeaderCommandOutput>;
789
445
  getCSVHeader(args: GetCSVHeaderCommandInput, cb: (err: any, data?: GetCSVHeaderCommandOutput) => void): void;
790
446
  getCSVHeader(args: GetCSVHeaderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCSVHeaderCommandOutput) => void): void;
791
447
  /**
792
- * @public
793
- * <p>Gets the device.</p>
448
+ * @see {@link GetDeviceCommand}
794
449
  */
795
450
  getDevice(args: GetDeviceCommandInput, options?: __HttpHandlerOptions): Promise<GetDeviceCommandOutput>;
796
451
  getDevice(args: GetDeviceCommandInput, cb: (err: any, data?: GetDeviceCommandOutput) => void): void;
797
452
  getDevice(args: GetDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeviceCommandOutput) => void): void;
798
453
  /**
799
- * @public
800
- * <p>Gets a group.</p>
801
- * <p>Calling this action requires developer credentials.</p>
454
+ * @see {@link GetGroupCommand}
802
455
  */
803
456
  getGroup(args: GetGroupCommandInput, options?: __HttpHandlerOptions): Promise<GetGroupCommandOutput>;
804
457
  getGroup(args: GetGroupCommandInput, cb: (err: any, data?: GetGroupCommandOutput) => void): void;
805
458
  getGroup(args: GetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupCommandOutput) => void): void;
806
459
  /**
807
- * @public
808
- * <p>Gets the specified IdP.</p>
460
+ * @see {@link GetIdentityProviderByIdentifierCommand}
809
461
  */
810
462
  getIdentityProviderByIdentifier(args: GetIdentityProviderByIdentifierCommandInput, options?: __HttpHandlerOptions): Promise<GetIdentityProviderByIdentifierCommandOutput>;
811
463
  getIdentityProviderByIdentifier(args: GetIdentityProviderByIdentifierCommandInput, cb: (err: any, data?: GetIdentityProviderByIdentifierCommandOutput) => void): void;
812
464
  getIdentityProviderByIdentifier(args: GetIdentityProviderByIdentifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIdentityProviderByIdentifierCommandOutput) => void): void;
813
465
  /**
814
- * @public
815
- * <p>This method takes a user pool ID, and returns the signing certificate. The issued certificate is valid for 10 years from the date of issue.</p>
816
- * <p>Amazon Cognito issues and assigns a new signing certificate annually. This process returns a new value in the response to <code>GetSigningCertificate</code>,
817
- * but doesn't invalidate the original certificate.</p>
466
+ * @see {@link GetSigningCertificateCommand}
818
467
  */
819
468
  getSigningCertificate(args: GetSigningCertificateCommandInput, options?: __HttpHandlerOptions): Promise<GetSigningCertificateCommandOutput>;
820
469
  getSigningCertificate(args: GetSigningCertificateCommandInput, cb: (err: any, data?: GetSigningCertificateCommandOutput) => void): void;
821
470
  getSigningCertificate(args: GetSigningCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSigningCertificateCommandOutput) => void): void;
822
471
  /**
823
- * @public
824
- * <p>Gets the user interface (UI) Customization information for a particular app client's
825
- * app UI, if any such information exists for the client. If nothing is set for the
826
- * particular client, but there is an existing pool level customization (the app
827
- * <code>clientId</code> is <code>ALL</code>), then that information is returned. If
828
- * nothing is present, then an empty shape is returned.</p>
472
+ * @see {@link GetUICustomizationCommand}
829
473
  */
830
474
  getUICustomization(args: GetUICustomizationCommandInput, options?: __HttpHandlerOptions): Promise<GetUICustomizationCommandOutput>;
831
475
  getUICustomization(args: GetUICustomizationCommandInput, cb: (err: any, data?: GetUICustomizationCommandOutput) => void): void;
832
476
  getUICustomization(args: GetUICustomizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUICustomizationCommandOutput) => void): void;
833
477
  /**
834
- * @public
835
- * <p>Gets the user attributes and metadata for a user.</p>
478
+ * @see {@link GetUserCommand}
836
479
  */
837
480
  getUser(args: GetUserCommandInput, options?: __HttpHandlerOptions): Promise<GetUserCommandOutput>;
838
481
  getUser(args: GetUserCommandInput, cb: (err: any, data?: GetUserCommandOutput) => void): void;
839
482
  getUser(args: GetUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserCommandOutput) => void): void;
840
483
  /**
841
- * @public
842
- * <p>Generates a user attribute verification code for the specified attribute name. Sends a
843
- * message to a user with a code that they must return in a VerifyUserAttribute
844
- * request.</p>
845
- *
846
- * <note>
847
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
848
- * require you to register an origination phone number before you can send SMS messages
849
- * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
850
- * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
851
- * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
852
- * receive SMS messages might not be able to sign up, activate their accounts, or sign
853
- * in.</p>
854
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
855
- * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
856
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
857
- * mode</a>
858
- * </i>, you can send messages only to verified phone
859
- * numbers. After you test your app while in the sandbox environment, you can move out
860
- * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
861
- * Developer Guide</i>.</p>
862
- * </note>
484
+ * @see {@link GetUserAttributeVerificationCodeCommand}
863
485
  */
864
486
  getUserAttributeVerificationCode(args: GetUserAttributeVerificationCodeCommandInput, options?: __HttpHandlerOptions): Promise<GetUserAttributeVerificationCodeCommandOutput>;
865
487
  getUserAttributeVerificationCode(args: GetUserAttributeVerificationCodeCommandInput, cb: (err: any, data?: GetUserAttributeVerificationCodeCommandOutput) => void): void;
866
488
  getUserAttributeVerificationCode(args: GetUserAttributeVerificationCodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserAttributeVerificationCodeCommandOutput) => void): void;
867
489
  /**
868
- * @public
869
- * <p>Gets the user pool multi-factor authentication (MFA) configuration.</p>
490
+ * @see {@link GetUserPoolMfaConfigCommand}
870
491
  */
871
492
  getUserPoolMfaConfig(args: GetUserPoolMfaConfigCommandInput, options?: __HttpHandlerOptions): Promise<GetUserPoolMfaConfigCommandOutput>;
872
493
  getUserPoolMfaConfig(args: GetUserPoolMfaConfigCommandInput, cb: (err: any, data?: GetUserPoolMfaConfigCommandOutput) => void): void;
873
494
  getUserPoolMfaConfig(args: GetUserPoolMfaConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserPoolMfaConfigCommandOutput) => void): void;
874
495
  /**
875
- * @public
876
- * <p>Signs out users from all devices. It also invalidates all refresh tokens that Amazon Cognito
877
- * has issued to a user. A user can still use a hosted UI cookie to retrieve new tokens
878
- * for the duration of the 1-hour cookie validity period.</p>
496
+ * @see {@link GlobalSignOutCommand}
879
497
  */
880
498
  globalSignOut(args: GlobalSignOutCommandInput, options?: __HttpHandlerOptions): Promise<GlobalSignOutCommandOutput>;
881
499
  globalSignOut(args: GlobalSignOutCommandInput, cb: (err: any, data?: GlobalSignOutCommandOutput) => void): void;
882
500
  globalSignOut(args: GlobalSignOutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GlobalSignOutCommandOutput) => void): void;
883
501
  /**
884
- * @public
885
- * <p>Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user
886
- * with a federated IdP with <code>InitiateAuth</code>. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html"> Adding user pool sign-in through a third party</a>.</p>
887
- *
888
- * <note>
889
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
890
- * require you to register an origination phone number before you can send SMS messages
891
- * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
892
- * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
893
- * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
894
- * receive SMS messages might not be able to sign up, activate their accounts, or sign
895
- * in.</p>
896
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
897
- * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
898
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
899
- * mode</a>
900
- * </i>, you can send messages only to verified phone
901
- * numbers. After you test your app while in the sandbox environment, you can move out
902
- * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
903
- * Developer Guide</i>.</p>
904
- * </note>
502
+ * @see {@link InitiateAuthCommand}
905
503
  */
906
504
  initiateAuth(args: InitiateAuthCommandInput, options?: __HttpHandlerOptions): Promise<InitiateAuthCommandOutput>;
907
505
  initiateAuth(args: InitiateAuthCommandInput, cb: (err: any, data?: InitiateAuthCommandOutput) => void): void;
908
506
  initiateAuth(args: InitiateAuthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InitiateAuthCommandOutput) => void): void;
909
507
  /**
910
- * @public
911
- * <p>Lists the sign-in devices that Amazon Cognito has registered to the current user.</p>
508
+ * @see {@link ListDevicesCommand}
912
509
  */
913
510
  listDevices(args: ListDevicesCommandInput, options?: __HttpHandlerOptions): Promise<ListDevicesCommandOutput>;
914
511
  listDevices(args: ListDevicesCommandInput, cb: (err: any, data?: ListDevicesCommandOutput) => void): void;
915
512
  listDevices(args: ListDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDevicesCommandOutput) => void): void;
916
513
  /**
917
- * @public
918
- * <p>Lists the groups associated with a user pool.</p>
919
- * <p>Calling this action requires developer credentials.</p>
514
+ * @see {@link ListGroupsCommand}
920
515
  */
921
516
  listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListGroupsCommandOutput>;
922
517
  listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
923
518
  listGroups(args: ListGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
924
519
  /**
925
- * @public
926
- * <p>Lists information about all IdPs for a user pool.</p>
520
+ * @see {@link ListIdentityProvidersCommand}
927
521
  */
928
522
  listIdentityProviders(args: ListIdentityProvidersCommandInput, options?: __HttpHandlerOptions): Promise<ListIdentityProvidersCommandOutput>;
929
523
  listIdentityProviders(args: ListIdentityProvidersCommandInput, cb: (err: any, data?: ListIdentityProvidersCommandOutput) => void): void;
930
524
  listIdentityProviders(args: ListIdentityProvidersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIdentityProvidersCommandOutput) => void): void;
931
525
  /**
932
- * @public
933
- * <p>Lists the resource servers for a user pool.</p>
526
+ * @see {@link ListResourceServersCommand}
934
527
  */
935
528
  listResourceServers(args: ListResourceServersCommandInput, options?: __HttpHandlerOptions): Promise<ListResourceServersCommandOutput>;
936
529
  listResourceServers(args: ListResourceServersCommandInput, cb: (err: any, data?: ListResourceServersCommandOutput) => void): void;
937
530
  listResourceServers(args: ListResourceServersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceServersCommandOutput) => void): void;
938
531
  /**
939
- * @public
940
- * <p>Lists the tags that are assigned to an Amazon Cognito user pool.</p>
941
- * <p>A tag is a label that you can apply to user pools to categorize and manage them in
942
- * different ways, such as by purpose, owner, environment, or other criteria.</p>
943
- * <p>You can use this action up to 10 times per second, per account.</p>
532
+ * @see {@link ListTagsForResourceCommand}
944
533
  */
945
534
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
946
535
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
947
536
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
948
537
  /**
949
- * @public
950
- * <p>Lists the user import jobs.</p>
538
+ * @see {@link ListUserImportJobsCommand}
951
539
  */
952
540
  listUserImportJobs(args: ListUserImportJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListUserImportJobsCommandOutput>;
953
541
  listUserImportJobs(args: ListUserImportJobsCommandInput, cb: (err: any, data?: ListUserImportJobsCommandOutput) => void): void;
954
542
  listUserImportJobs(args: ListUserImportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUserImportJobsCommandOutput) => void): void;
955
543
  /**
956
- * @public
957
- * <p>Lists the clients that have been created for the specified user pool.</p>
544
+ * @see {@link ListUserPoolClientsCommand}
958
545
  */
959
546
  listUserPoolClients(args: ListUserPoolClientsCommandInput, options?: __HttpHandlerOptions): Promise<ListUserPoolClientsCommandOutput>;
960
547
  listUserPoolClients(args: ListUserPoolClientsCommandInput, cb: (err: any, data?: ListUserPoolClientsCommandOutput) => void): void;
961
548
  listUserPoolClients(args: ListUserPoolClientsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUserPoolClientsCommandOutput) => void): void;
962
549
  /**
963
- * @public
964
- * <p>Lists the user pools associated with an Amazon Web Services account.</p>
550
+ * @see {@link ListUserPoolsCommand}
965
551
  */
966
552
  listUserPools(args: ListUserPoolsCommandInput, options?: __HttpHandlerOptions): Promise<ListUserPoolsCommandOutput>;
967
553
  listUserPools(args: ListUserPoolsCommandInput, cb: (err: any, data?: ListUserPoolsCommandOutput) => void): void;
968
554
  listUserPools(args: ListUserPoolsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUserPoolsCommandOutput) => void): void;
969
555
  /**
970
- * @public
971
- * <p>Lists the users in the Amazon Cognito user pool.</p>
556
+ * @see {@link ListUsersCommand}
972
557
  */
973
558
  listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise<ListUsersCommandOutput>;
974
559
  listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void;
975
560
  listUsers(args: ListUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersCommandOutput) => void): void;
976
561
  /**
977
- * @public
978
- * <p>Lists the users in the specified group.</p>
979
- * <p>Calling this action requires developer credentials.</p>
562
+ * @see {@link ListUsersInGroupCommand}
980
563
  */
981
564
  listUsersInGroup(args: ListUsersInGroupCommandInput, options?: __HttpHandlerOptions): Promise<ListUsersInGroupCommandOutput>;
982
565
  listUsersInGroup(args: ListUsersInGroupCommandInput, cb: (err: any, data?: ListUsersInGroupCommandOutput) => void): void;
983
566
  listUsersInGroup(args: ListUsersInGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersInGroupCommandOutput) => void): void;
984
567
  /**
985
- * @public
986
- * <p>Resends the confirmation (for confirmation of registration) to a specific user in the
987
- * user pool.</p>
988
- *
989
- * <note>
990
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
991
- * require you to register an origination phone number before you can send SMS messages
992
- * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
993
- * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
994
- * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
995
- * receive SMS messages might not be able to sign up, activate their accounts, or sign
996
- * in.</p>
997
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
998
- * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
999
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
1000
- * mode</a>
1001
- * </i>, you can send messages only to verified phone
1002
- * numbers. After you test your app while in the sandbox environment, you can move out
1003
- * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
1004
- * Developer Guide</i>.</p>
1005
- * </note>
568
+ * @see {@link ResendConfirmationCodeCommand}
1006
569
  */
1007
570
  resendConfirmationCode(args: ResendConfirmationCodeCommandInput, options?: __HttpHandlerOptions): Promise<ResendConfirmationCodeCommandOutput>;
1008
571
  resendConfirmationCode(args: ResendConfirmationCodeCommandInput, cb: (err: any, data?: ResendConfirmationCodeCommandOutput) => void): void;
1009
572
  resendConfirmationCode(args: ResendConfirmationCodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResendConfirmationCodeCommandOutput) => void): void;
1010
573
  /**
1011
- * @public
1012
- * <p>Responds to the authentication challenge.</p>
1013
- *
1014
- * <note>
1015
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
1016
- * require you to register an origination phone number before you can send SMS messages
1017
- * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
1018
- * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
1019
- * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
1020
- * receive SMS messages might not be able to sign up, activate their accounts, or sign
1021
- * in.</p>
1022
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
1023
- * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
1024
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
1025
- * mode</a>
1026
- * </i>, you can send messages only to verified phone
1027
- * numbers. After you test your app while in the sandbox environment, you can move out
1028
- * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
1029
- * Developer Guide</i>.</p>
1030
- * </note>
574
+ * @see {@link RespondToAuthChallengeCommand}
1031
575
  */
1032
576
  respondToAuthChallenge(args: RespondToAuthChallengeCommandInput, options?: __HttpHandlerOptions): Promise<RespondToAuthChallengeCommandOutput>;
1033
577
  respondToAuthChallenge(args: RespondToAuthChallengeCommandInput, cb: (err: any, data?: RespondToAuthChallengeCommandOutput) => void): void;
1034
578
  respondToAuthChallenge(args: RespondToAuthChallengeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RespondToAuthChallengeCommandOutput) => void): void;
1035
579
  /**
1036
- * @public
1037
- * <p>Revokes all of the access tokens generated by, and at the same time as, the specified
1038
- * refresh token. After a token is revoked, you can't use the revoked token to access
1039
- * Amazon Cognito user APIs, or to authorize access to your resource server.</p>
580
+ * @see {@link RevokeTokenCommand}
1040
581
  */
1041
582
  revokeToken(args: RevokeTokenCommandInput, options?: __HttpHandlerOptions): Promise<RevokeTokenCommandOutput>;
1042
583
  revokeToken(args: RevokeTokenCommandInput, cb: (err: any, data?: RevokeTokenCommandOutput) => void): void;
1043
584
  revokeToken(args: RevokeTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeTokenCommandOutput) => void): void;
1044
585
  /**
1045
- * @public
1046
- * <p>Configures actions on detected risks. To delete the risk configuration for
1047
- * <code>UserPoolId</code> or <code>ClientId</code>, pass null values for all four
1048
- * configuration types.</p>
1049
- * <p>To activate Amazon Cognito advanced security features, update the user pool to include the
1050
- * <code>UserPoolAddOns</code> key<code>AdvancedSecurityMode</code>.</p>
586
+ * @see {@link SetRiskConfigurationCommand}
1051
587
  */
1052
588
  setRiskConfiguration(args: SetRiskConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<SetRiskConfigurationCommandOutput>;
1053
589
  setRiskConfiguration(args: SetRiskConfigurationCommandInput, cb: (err: any, data?: SetRiskConfigurationCommandOutput) => void): void;
1054
590
  setRiskConfiguration(args: SetRiskConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetRiskConfigurationCommandOutput) => void): void;
1055
591
  /**
1056
- * @public
1057
- * <p>Sets the user interface (UI) customization information for a user pool's built-in app
1058
- * UI.</p>
1059
- * <p>You can specify app UI customization settings for a single client (with a specific
1060
- * <code>clientId</code>) or for all clients (by setting the <code>clientId</code> to
1061
- * <code>ALL</code>). If you specify <code>ALL</code>, the default configuration is
1062
- * used for every client that has no previously set UI customization. If you specify UI
1063
- * customization settings for a particular client, it will no longer return to the
1064
- * <code>ALL</code> configuration.</p>
1065
- * <note>
1066
- * <p>To use this API, your user pool must have a domain associated with it. Otherwise,
1067
- * there is no place to host the app's pages, and the service will throw an
1068
- * error.</p>
1069
- * </note>
592
+ * @see {@link SetUICustomizationCommand}
1070
593
  */
1071
594
  setUICustomization(args: SetUICustomizationCommandInput, options?: __HttpHandlerOptions): Promise<SetUICustomizationCommandOutput>;
1072
595
  setUICustomization(args: SetUICustomizationCommandInput, cb: (err: any, data?: SetUICustomizationCommandOutput) => void): void;
1073
596
  setUICustomization(args: SetUICustomizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetUICustomizationCommandOutput) => void): void;
1074
597
  /**
1075
- * @public
1076
- * <p>Set the user's multi-factor authentication (MFA) method preference, including which
1077
- * MFA factors are activated and if any are preferred. Only one factor can be set as
1078
- * preferred. The preferred MFA factor will be used to authenticate a user if multiple
1079
- * factors are activated. If multiple options are activated and no preference is set, a
1080
- * challenge to choose an MFA option will be returned during sign-in. If an MFA type is
1081
- * activated for a user, the user will be prompted for MFA during all sign-in attempts
1082
- * unless device tracking is turned on and the device has been trusted. If you want MFA to
1083
- * be applied selectively based on the assessed risk level of sign-in attempts, deactivate
1084
- * MFA for users and turn on Adaptive Authentication for the user pool.</p>
598
+ * @see {@link SetUserMFAPreferenceCommand}
1085
599
  */
1086
600
  setUserMFAPreference(args: SetUserMFAPreferenceCommandInput, options?: __HttpHandlerOptions): Promise<SetUserMFAPreferenceCommandOutput>;
1087
601
  setUserMFAPreference(args: SetUserMFAPreferenceCommandInput, cb: (err: any, data?: SetUserMFAPreferenceCommandOutput) => void): void;
1088
602
  setUserMFAPreference(args: SetUserMFAPreferenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetUserMFAPreferenceCommandOutput) => void): void;
1089
603
  /**
1090
- * @public
1091
- * <p>Sets the user pool multi-factor authentication (MFA) configuration.</p>
1092
- *
1093
- * <note>
1094
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
1095
- * require you to register an origination phone number before you can send SMS messages
1096
- * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
1097
- * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
1098
- * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
1099
- * receive SMS messages might not be able to sign up, activate their accounts, or sign
1100
- * in.</p>
1101
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
1102
- * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
1103
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
1104
- * mode</a>
1105
- * </i>, you can send messages only to verified phone
1106
- * numbers. After you test your app while in the sandbox environment, you can move out
1107
- * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
1108
- * Developer Guide</i>.</p>
1109
- * </note>
604
+ * @see {@link SetUserPoolMfaConfigCommand}
1110
605
  */
1111
606
  setUserPoolMfaConfig(args: SetUserPoolMfaConfigCommandInput, options?: __HttpHandlerOptions): Promise<SetUserPoolMfaConfigCommandOutput>;
1112
607
  setUserPoolMfaConfig(args: SetUserPoolMfaConfigCommandInput, cb: (err: any, data?: SetUserPoolMfaConfigCommandOutput) => void): void;
1113
608
  setUserPoolMfaConfig(args: SetUserPoolMfaConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetUserPoolMfaConfigCommandOutput) => void): void;
1114
609
  /**
1115
- * @public
1116
- * <p>
1117
- * <i>This action is no longer supported.</i> You can use it to configure
1118
- * only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software
1119
- * token MFA. To configure either type of MFA, use <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserMFAPreference.html">SetUserMFAPreference</a> instead.</p>
610
+ * @see {@link SetUserSettingsCommand}
1120
611
  */
1121
612
  setUserSettings(args: SetUserSettingsCommandInput, options?: __HttpHandlerOptions): Promise<SetUserSettingsCommandOutput>;
1122
613
  setUserSettings(args: SetUserSettingsCommandInput, cb: (err: any, data?: SetUserSettingsCommandOutput) => void): void;
1123
614
  setUserSettings(args: SetUserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetUserSettingsCommandOutput) => void): void;
1124
615
  /**
1125
- * @public
1126
- * <p>Registers the user in the specified user pool and creates a user name, password, and
1127
- * user attributes.</p>
1128
- *
1129
- * <note>
1130
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
1131
- * require you to register an origination phone number before you can send SMS messages
1132
- * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
1133
- * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
1134
- * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
1135
- * receive SMS messages might not be able to sign up, activate their accounts, or sign
1136
- * in.</p>
1137
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
1138
- * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
1139
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
1140
- * mode</a>
1141
- * </i>, you can send messages only to verified phone
1142
- * numbers. After you test your app while in the sandbox environment, you can move out
1143
- * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
1144
- * Developer Guide</i>.</p>
1145
- * </note>
616
+ * @see {@link SignUpCommand}
1146
617
  */
1147
618
  signUp(args: SignUpCommandInput, options?: __HttpHandlerOptions): Promise<SignUpCommandOutput>;
1148
619
  signUp(args: SignUpCommandInput, cb: (err: any, data?: SignUpCommandOutput) => void): void;
1149
620
  signUp(args: SignUpCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SignUpCommandOutput) => void): void;
1150
621
  /**
1151
- * @public
1152
- * <p>Starts the user import.</p>
622
+ * @see {@link StartUserImportJobCommand}
1153
623
  */
1154
624
  startUserImportJob(args: StartUserImportJobCommandInput, options?: __HttpHandlerOptions): Promise<StartUserImportJobCommandOutput>;
1155
625
  startUserImportJob(args: StartUserImportJobCommandInput, cb: (err: any, data?: StartUserImportJobCommandOutput) => void): void;
1156
626
  startUserImportJob(args: StartUserImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartUserImportJobCommandOutput) => void): void;
1157
627
  /**
1158
- * @public
1159
- * <p>Stops the user import job.</p>
628
+ * @see {@link StopUserImportJobCommand}
1160
629
  */
1161
630
  stopUserImportJob(args: StopUserImportJobCommandInput, options?: __HttpHandlerOptions): Promise<StopUserImportJobCommandOutput>;
1162
631
  stopUserImportJob(args: StopUserImportJobCommandInput, cb: (err: any, data?: StopUserImportJobCommandOutput) => void): void;
1163
632
  stopUserImportJob(args: StopUserImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopUserImportJobCommandOutput) => void): void;
1164
633
  /**
1165
- * @public
1166
- * <p>Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to
1167
- * categorize and manage user pools in different ways, such as by purpose, owner,
1168
- * environment, or other criteria.</p>
1169
- * <p>Each tag consists of a key and value, both of which you define. A key is a general
1170
- * category for more specific values. For example, if you have two versions of a user pool,
1171
- * one for testing and another for production, you might assign an <code>Environment</code>
1172
- * tag key to both user pools. The value of this key might be <code>Test</code> for one
1173
- * user pool, and <code>Production</code> for the other.</p>
1174
- * <p>Tags are useful for cost tracking and access control. You can activate your tags so
1175
- * that they appear on the Billing and Cost Management console, where you can track the
1176
- * costs associated with your user pools. In an Identity and Access Management policy, you can constrain
1177
- * permissions for user pools based on specific tags or tag values.</p>
1178
- * <p>You can use this action up to 5 times per second, per account. A user pool can have as
1179
- * many as 50 tags.</p>
634
+ * @see {@link TagResourceCommand}
1180
635
  */
1181
636
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
1182
637
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
1183
638
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
1184
639
  /**
1185
- * @public
1186
- * <p>Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5
1187
- * times per second, per account.</p>
640
+ * @see {@link UntagResourceCommand}
1188
641
  */
1189
642
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
1190
643
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
1191
644
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
1192
645
  /**
1193
- * @public
1194
- * <p>Provides the feedback for an authentication event, whether it was from a valid user or
1195
- * not. This feedback is used for improving the risk evaluation decision for the user pool
1196
- * as part of Amazon Cognito advanced security.</p>
646
+ * @see {@link UpdateAuthEventFeedbackCommand}
1197
647
  */
1198
648
  updateAuthEventFeedback(args: UpdateAuthEventFeedbackCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAuthEventFeedbackCommandOutput>;
1199
649
  updateAuthEventFeedback(args: UpdateAuthEventFeedbackCommandInput, cb: (err: any, data?: UpdateAuthEventFeedbackCommandOutput) => void): void;
1200
650
  updateAuthEventFeedback(args: UpdateAuthEventFeedbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAuthEventFeedbackCommandOutput) => void): void;
1201
651
  /**
1202
- * @public
1203
- * <p>Updates the device status.</p>
652
+ * @see {@link UpdateDeviceStatusCommand}
1204
653
  */
1205
654
  updateDeviceStatus(args: UpdateDeviceStatusCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDeviceStatusCommandOutput>;
1206
655
  updateDeviceStatus(args: UpdateDeviceStatusCommandInput, cb: (err: any, data?: UpdateDeviceStatusCommandOutput) => void): void;
1207
656
  updateDeviceStatus(args: UpdateDeviceStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDeviceStatusCommandOutput) => void): void;
1208
657
  /**
1209
- * @public
1210
- * <p>Updates the specified group with the specified attributes.</p>
1211
- * <p>Calling this action requires developer credentials.</p>
658
+ * @see {@link UpdateGroupCommand}
1212
659
  */
1213
660
  updateGroup(args: UpdateGroupCommandInput, options?: __HttpHandlerOptions): Promise<UpdateGroupCommandOutput>;
1214
661
  updateGroup(args: UpdateGroupCommandInput, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void;
1215
662
  updateGroup(args: UpdateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void;
1216
663
  /**
1217
- * @public
1218
- * <p>Updates IdP information for a user pool.</p>
664
+ * @see {@link UpdateIdentityProviderCommand}
1219
665
  */
1220
666
  updateIdentityProvider(args: UpdateIdentityProviderCommandInput, options?: __HttpHandlerOptions): Promise<UpdateIdentityProviderCommandOutput>;
1221
667
  updateIdentityProvider(args: UpdateIdentityProviderCommandInput, cb: (err: any, data?: UpdateIdentityProviderCommandOutput) => void): void;
1222
668
  updateIdentityProvider(args: UpdateIdentityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIdentityProviderCommandOutput) => void): void;
1223
669
  /**
1224
- * @public
1225
- * <p>Updates the name and scopes of resource server. All other fields are read-only.</p>
1226
- * <important>
1227
- * <p>If you don't provide a value for an attribute, it is set to the default
1228
- * value.</p>
1229
- * </important>
670
+ * @see {@link UpdateResourceServerCommand}
1230
671
  */
1231
672
  updateResourceServer(args: UpdateResourceServerCommandInput, options?: __HttpHandlerOptions): Promise<UpdateResourceServerCommandOutput>;
1232
673
  updateResourceServer(args: UpdateResourceServerCommandInput, cb: (err: any, data?: UpdateResourceServerCommandOutput) => void): void;
1233
674
  updateResourceServer(args: UpdateResourceServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResourceServerCommandOutput) => void): void;
1234
675
  /**
1235
- * @public
1236
- * <p>Allows a user to update a specific attribute (one at a time).</p>
1237
- *
1238
- * <note>
1239
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
1240
- * require you to register an origination phone number before you can send SMS messages
1241
- * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
1242
- * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
1243
- * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
1244
- * receive SMS messages might not be able to sign up, activate their accounts, or sign
1245
- * in.</p>
1246
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
1247
- * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
1248
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
1249
- * mode</a>
1250
- * </i>, you can send messages only to verified phone
1251
- * numbers. After you test your app while in the sandbox environment, you can move out
1252
- * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
1253
- * Developer Guide</i>.</p>
1254
- * </note>
676
+ * @see {@link UpdateUserAttributesCommand}
1255
677
  */
1256
678
  updateUserAttributes(args: UpdateUserAttributesCommandInput, options?: __HttpHandlerOptions): Promise<UpdateUserAttributesCommandOutput>;
1257
679
  updateUserAttributes(args: UpdateUserAttributesCommandInput, cb: (err: any, data?: UpdateUserAttributesCommandOutput) => void): void;
1258
680
  updateUserAttributes(args: UpdateUserAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserAttributesCommandOutput) => void): void;
1259
681
  /**
1260
- * @public
1261
- * <p>Updates the specified user pool with the specified attributes. You can get a list of
1262
- * the current user pool settings using <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>. If you don't provide a value for an attribute, it will be
1263
- * set to the default value.
1264
- * </p>
1265
- *
1266
- * <note>
1267
- * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
1268
- * require you to register an origination phone number before you can send SMS messages
1269
- * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
1270
- * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
1271
- * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
1272
- * receive SMS messages might not be able to sign up, activate their accounts, or sign
1273
- * in.</p>
1274
- * <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
1275
- * Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
1276
- * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
1277
- * mode</a>
1278
- * </i>, you can send messages only to verified phone
1279
- * numbers. After you test your app while in the sandbox environment, you can move out
1280
- * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
1281
- * Developer Guide</i>.</p>
1282
- * </note>
682
+ * @see {@link UpdateUserPoolCommand}
1283
683
  */
1284
684
  updateUserPool(args: UpdateUserPoolCommandInput, options?: __HttpHandlerOptions): Promise<UpdateUserPoolCommandOutput>;
1285
685
  updateUserPool(args: UpdateUserPoolCommandInput, cb: (err: any, data?: UpdateUserPoolCommandOutput) => void): void;
1286
686
  updateUserPool(args: UpdateUserPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserPoolCommandOutput) => void): void;
1287
687
  /**
1288
- * @public
1289
- * <p>Updates the specified user pool app client with the specified attributes. You can get
1290
- * a list of the current user pool app client settings using <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html">DescribeUserPoolClient</a>.</p>
1291
- * <important>
1292
- * <p>If you don't provide a value for an attribute, it will be set to the default
1293
- * value.</p>
1294
- * </important>
1295
- * <p>You can also use this operation to enable token revocation for user pool clients. For
1296
- * more information about revoking tokens, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
688
+ * @see {@link UpdateUserPoolClientCommand}
1297
689
  */
1298
690
  updateUserPoolClient(args: UpdateUserPoolClientCommandInput, options?: __HttpHandlerOptions): Promise<UpdateUserPoolClientCommandOutput>;
1299
691
  updateUserPoolClient(args: UpdateUserPoolClientCommandInput, cb: (err: any, data?: UpdateUserPoolClientCommandOutput) => void): void;
1300
692
  updateUserPoolClient(args: UpdateUserPoolClientCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserPoolClientCommandOutput) => void): void;
1301
693
  /**
1302
- * @public
1303
- * <p>Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user
1304
- * pool.</p>
1305
- * <p>You can use this operation to provide the Amazon Resource Name (ARN) of a new
1306
- * certificate to Amazon Cognito. You can't use it to change the domain for a user pool.</p>
1307
- * <p>A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and
1308
- * sign-in pages for your application. When you set up a custom domain, you provide a
1309
- * certificate that you manage with Certificate Manager (ACM). When necessary, you can use this
1310
- * operation to change the certificate that you applied to your custom domain.</p>
1311
- * <p>Usually, this is unnecessary following routine certificate renewal with ACM. When
1312
- * you renew your existing certificate in ACM, the ARN for your certificate remains the
1313
- * same, and your custom domain uses the new certificate automatically.</p>
1314
- * <p>However, if you replace your existing certificate with a new one, ACM gives the new
1315
- * certificate a new ARN. To apply the new certificate to your custom domain, you must
1316
- * provide this ARN to Amazon Cognito.</p>
1317
- * <p>When you add your new certificate in ACM, you must choose US East (N. Virginia) as
1318
- * the Amazon Web Services Region.</p>
1319
- * <p>After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new
1320
- * certificate to your custom domain.</p>
1321
- * <p>For more information about adding a custom domain to your user pool, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html">Using Your Own Domain for the Hosted UI</a>.</p>
694
+ * @see {@link UpdateUserPoolDomainCommand}
1322
695
  */
1323
696
  updateUserPoolDomain(args: UpdateUserPoolDomainCommandInput, options?: __HttpHandlerOptions): Promise<UpdateUserPoolDomainCommandOutput>;
1324
697
  updateUserPoolDomain(args: UpdateUserPoolDomainCommandInput, cb: (err: any, data?: UpdateUserPoolDomainCommandOutput) => void): void;
1325
698
  updateUserPoolDomain(args: UpdateUserPoolDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserPoolDomainCommandOutput) => void): void;
1326
699
  /**
1327
- * @public
1328
- * <p>Use this API to register a user's entered time-based one-time password (TOTP) code and
1329
- * mark the user's software token MFA status as "verified" if successful. The request takes
1330
- * an access token or a session string, but not both.</p>
700
+ * @see {@link VerifySoftwareTokenCommand}
1331
701
  */
1332
702
  verifySoftwareToken(args: VerifySoftwareTokenCommandInput, options?: __HttpHandlerOptions): Promise<VerifySoftwareTokenCommandOutput>;
1333
703
  verifySoftwareToken(args: VerifySoftwareTokenCommandInput, cb: (err: any, data?: VerifySoftwareTokenCommandOutput) => void): void;
1334
704
  verifySoftwareToken(args: VerifySoftwareTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifySoftwareTokenCommandOutput) => void): void;
1335
705
  /**
1336
- * @public
1337
- * <p>Verifies the specified user attributes in the user pool.</p>
1338
- * <p>
1339
- * If your user pool requires verification before Amazon Cognito updates the attribute value,
1340
- * VerifyUserAttribute updates the affected attribute to its pending value. For more information,
1341
- * see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserAttributeUpdateSettingsType.html">
1342
- * UserAttributeUpdateSettingsType</a>.
1343
- * </p>
706
+ * @see {@link VerifyUserAttributeCommand}
1344
707
  */
1345
708
  verifyUserAttribute(args: VerifyUserAttributeCommandInput, options?: __HttpHandlerOptions): Promise<VerifyUserAttributeCommandOutput>;
1346
709
  verifyUserAttribute(args: VerifyUserAttributeCommandInput, cb: (err: any, data?: VerifyUserAttributeCommandOutput) => void): void;
1347
710
  verifyUserAttribute(args: VerifyUserAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifyUserAttributeCommandOutput) => void): void;
1348
711
  }
712
+ /**
713
+ * @public
714
+ * <p>Using the Amazon Cognito user pools API, you can create a user pool to manage directories and
715
+ * users. You can authenticate a user to obtain tokens related to user identity and access
716
+ * policies.</p>
717
+ * <p>This API reference provides information about user pools in Amazon Cognito user pools.</p>
718
+ * <p>For more information, see the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html">Amazon Cognito
719
+ * Documentation</a>.</p>
720
+ */
721
+ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClient implements CognitoIdentityProvider {
722
+ }