@aws-sdk/client-cognito-identity-provider 3.95.0 → 3.98.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.
- package/CHANGELOG.md +11 -0
- package/README.md +5 -2
- package/dist-cjs/commands/StartUserImportJobCommand.js +1 -2
- package/dist-cjs/models/models_0.js +15 -15
- package/dist-cjs/models/models_1.js +7 -1
- package/dist-cjs/protocols/Aws_json1_1.js +51 -0
- package/dist-es/commands/StartUserImportJobCommand.js +1 -2
- package/dist-es/models/models_0.js +9 -9
- package/dist-es/models/models_1.js +4 -0
- package/dist-es/protocols/Aws_json1_1.js +87 -39
- package/dist-types/CognitoIdentityProvider.d.ts +261 -157
- package/dist-types/CognitoIdentityProviderClient.d.ts +5 -2
- package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +2 -1
- package/dist-types/commands/AdminCreateUserCommand.d.ts +9 -7
- package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +2 -1
- package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +27 -16
- package/dist-types/commands/AdminGetUserCommand.d.ts +2 -1
- package/dist-types/commands/AdminInitiateAuthCommand.d.ts +0 -1
- package/dist-types/commands/AdminLinkProviderForUserCommand.d.ts +17 -12
- package/dist-types/commands/AdminListUserAuthEventsCommand.d.ts +2 -1
- package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +10 -6
- package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +5 -3
- package/dist-types/commands/AdminSetUserPasswordCommand.d.ts +10 -5
- package/dist-types/commands/AdminSetUserSettingsCommand.d.ts +3 -3
- package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts +3 -2
- package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +6 -3
- package/dist-types/commands/AdminUserGlobalSignOutCommand.d.ts +6 -2
- package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +10 -6
- package/dist-types/commands/ConfirmDeviceCommand.d.ts +2 -1
- package/dist-types/commands/ConfirmSignUpCommand.d.ts +1 -1
- package/dist-types/commands/CreateIdentityProviderCommand.d.ts +1 -1
- package/dist-types/commands/CreateUserPoolClientCommand.d.ts +2 -2
- package/dist-types/commands/CreateUserPoolCommand.d.ts +2 -1
- package/dist-types/commands/DeleteIdentityProviderCommand.d.ts +1 -1
- package/dist-types/commands/DescribeIdentityProviderCommand.d.ts +1 -1
- package/dist-types/commands/DescribeUserPoolClientCommand.d.ts +2 -1
- package/dist-types/commands/ForgotPasswordCommand.d.ts +8 -8
- package/dist-types/commands/GetCSVHeaderCommand.d.ts +2 -1
- package/dist-types/commands/GetIdentityProviderByIdentifierCommand.d.ts +1 -1
- package/dist-types/commands/GetUICustomizationCommand.d.ts +5 -2
- package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +3 -1
- package/dist-types/commands/GlobalSignOutCommand.d.ts +5 -2
- package/dist-types/commands/InitiateAuthCommand.d.ts +2 -1
- package/dist-types/commands/ListDevicesCommand.d.ts +1 -1
- package/dist-types/commands/ListIdentityProvidersCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +2 -1
- package/dist-types/commands/RevokeTokenCommand.d.ts +3 -1
- package/dist-types/commands/SetRiskConfigurationCommand.d.ts +5 -2
- package/dist-types/commands/SetUICustomizationCommand.d.ts +13 -7
- package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +8 -5
- package/dist-types/commands/SetUserSettingsCommand.d.ts +3 -2
- package/dist-types/commands/SignUpCommand.d.ts +2 -1
- package/dist-types/commands/StartUserImportJobCommand.d.ts +1 -2
- package/dist-types/commands/TagResourceCommand.d.ts +14 -7
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts +3 -2
- package/dist-types/commands/UpdateIdentityProviderCommand.d.ts +1 -1
- package/dist-types/commands/UpdateResourceServerCommand.d.ts +4 -3
- package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +8 -7
- package/dist-types/commands/UpdateUserPoolCommand.d.ts +4 -3
- package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts +19 -12
- package/dist-types/commands/VerifySoftwareTokenCommand.d.ts +3 -2
- package/dist-types/commands/VerifyUserAttributeCommand.d.ts +6 -0
- package/dist-types/models/models_0.d.ts +1940 -1245
- package/dist-types/models/models_1.d.ts +247 -123
- package/dist-types/ts3.4/commands/StartUserImportJobCommand.d.ts +1 -2
- package/dist-types/ts3.4/models/models_0.d.ts +17 -15
- package/dist-types/ts3.4/models/models_1.d.ts +14 -1
- package/package.json +1 -1
|
@@ -102,9 +102,12 @@ import { UpdateUserPoolDomainCommandInput, UpdateUserPoolDomainCommandOutput } f
|
|
|
102
102
|
import { VerifySoftwareTokenCommandInput, VerifySoftwareTokenCommandOutput } from "./commands/VerifySoftwareTokenCommand";
|
|
103
103
|
import { VerifyUserAttributeCommandInput, VerifyUserAttributeCommandOutput } from "./commands/VerifyUserAttributeCommand";
|
|
104
104
|
/**
|
|
105
|
-
* <p>Using the Amazon Cognito user pools API, you can create a user pool to manage directories and
|
|
105
|
+
* <p>Using the Amazon Cognito user pools API, you can create a user pool to manage directories and
|
|
106
|
+
* users. You can authenticate a user to obtain tokens related to user identity and access
|
|
107
|
+
* policies.</p>
|
|
106
108
|
* <p>This API reference provides information about user pools in Amazon Cognito user pools.</p>
|
|
107
|
-
* <p>For more information, see the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html">Amazon Cognito
|
|
109
|
+
* <p>For more information, see the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html">Amazon Cognito
|
|
110
|
+
* Documentation</a>.</p>
|
|
108
111
|
*/
|
|
109
112
|
export declare class CognitoIdentityProvider extends CognitoIdentityProviderClient {
|
|
110
113
|
/**
|
|
@@ -121,7 +124,8 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
121
124
|
adminAddUserToGroup(args: AdminAddUserToGroupCommandInput, cb: (err: any, data?: AdminAddUserToGroupCommandOutput) => void): void;
|
|
122
125
|
adminAddUserToGroup(args: AdminAddUserToGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminAddUserToGroupCommandOutput) => void): void;
|
|
123
126
|
/**
|
|
124
|
-
* <p>Confirms user registration as an admin without using a confirmation code. Works on any
|
|
127
|
+
* <p>Confirms user registration as an admin without using a confirmation code. Works on any
|
|
128
|
+
* user.</p>
|
|
125
129
|
* <p>Calling this action requires developer credentials.</p>
|
|
126
130
|
*/
|
|
127
131
|
adminConfirmSignUp(args: AdminConfirmSignUpCommandInput, options?: __HttpHandlerOptions): Promise<AdminConfirmSignUpCommandOutput>;
|
|
@@ -129,9 +133,8 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
129
133
|
adminConfirmSignUp(args: AdminConfirmSignUpCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminConfirmSignUpCommandOutput) => void): void;
|
|
130
134
|
/**
|
|
131
135
|
* <p>Creates a new user in the specified user pool.</p>
|
|
132
|
-
* <p>If <code>MessageAction</code> isn't set, the default is to send a welcome message via
|
|
133
|
-
*
|
|
134
|
-
*
|
|
136
|
+
* <p>If <code>MessageAction</code> isn't set, the default is to send a welcome message via
|
|
137
|
+
* email or phone (SMS).</p>
|
|
135
138
|
*
|
|
136
139
|
* <note>
|
|
137
140
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
@@ -151,10 +154,13 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
151
154
|
* Developer Guide</i>.</p>
|
|
152
155
|
* </note>
|
|
153
156
|
*
|
|
154
|
-
* <p>This message is based on a template that you configured in your call to create or
|
|
155
|
-
* user
|
|
156
|
-
*
|
|
157
|
-
* <p>
|
|
157
|
+
* <p>This message is based on a template that you configured in your call to create or
|
|
158
|
+
* update a user pool. This template includes your custom sign-up instructions and
|
|
159
|
+
* placeholders for user name and temporary password.</p>
|
|
160
|
+
* <p>Alternatively, you can call <code>AdminCreateUser</code> with <code>SUPPRESS</code>
|
|
161
|
+
* for the <code>MessageAction</code> parameter, and Amazon Cognito won't send any email. </p>
|
|
162
|
+
* <p>In either case, the user will be in the <code>FORCE_CHANGE_PASSWORD</code> state until
|
|
163
|
+
* they sign in and change their password.</p>
|
|
158
164
|
* <p>
|
|
159
165
|
* <code>AdminCreateUser</code> requires developer credentials.</p>
|
|
160
166
|
*/
|
|
@@ -169,7 +175,8 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
169
175
|
adminDeleteUser(args: AdminDeleteUserCommandInput, cb: (err: any, data?: AdminDeleteUserCommandOutput) => void): void;
|
|
170
176
|
adminDeleteUser(args: AdminDeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminDeleteUserCommandOutput) => void): void;
|
|
171
177
|
/**
|
|
172
|
-
* <p>Deletes the user attributes in a user pool as an administrator. Works on any
|
|
178
|
+
* <p>Deletes the user attributes in a user pool as an administrator. Works on any
|
|
179
|
+
* user.</p>
|
|
173
180
|
* <p>Calling this action requires developer credentials.</p>
|
|
174
181
|
*/
|
|
175
182
|
adminDeleteUserAttributes(args: AdminDeleteUserAttributesCommandInput, options?: __HttpHandlerOptions): Promise<AdminDeleteUserAttributesCommandOutput>;
|
|
@@ -177,22 +184,33 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
177
184
|
adminDeleteUserAttributes(args: AdminDeleteUserAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminDeleteUserAttributesCommandOutput) => void): void;
|
|
178
185
|
/**
|
|
179
186
|
* <p>Prevents the user from signing in with the specified external (SAML or social)
|
|
180
|
-
* identity provider. If the user that you want to
|
|
181
|
-
* username + password user, they can't use their password to sign in. If the user
|
|
182
|
-
* deactivate is a linked external
|
|
183
|
-
*
|
|
184
|
-
*
|
|
185
|
-
*
|
|
186
|
-
* <p>This action is enabled only for admin access and requires developer
|
|
187
|
-
*
|
|
188
|
-
* <p>
|
|
189
|
-
*
|
|
190
|
-
* <p>
|
|
191
|
-
*
|
|
192
|
-
*
|
|
193
|
-
*
|
|
194
|
-
*
|
|
195
|
-
*
|
|
187
|
+
* identity provider (IdP). If the user that you want to deactivate is a Amazon Cognito user pools
|
|
188
|
+
* native username + password user, they can't use their password to sign in. If the user
|
|
189
|
+
* to deactivate is a linked external IdP user, any link between that user and an existing
|
|
190
|
+
* user is removed. When the external user signs in again, and the user is no longer
|
|
191
|
+
* attached to the previously linked <code>DestinationUser</code>, the user must create a
|
|
192
|
+
* new user account. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html">AdminLinkProviderForUser</a>.</p>
|
|
193
|
+
* <p>This action is enabled only for admin access and requires developer
|
|
194
|
+
* credentials.</p>
|
|
195
|
+
* <p>The <code>ProviderName</code> must match the value specified when creating an IdP for
|
|
196
|
+
* the pool. </p>
|
|
197
|
+
* <p>To deactivate a native username + password user, the <code>ProviderName</code> value
|
|
198
|
+
* must be <code>Cognito</code> and the <code>ProviderAttributeName</code> must be
|
|
199
|
+
* <code>Cognito_Subject</code>. The <code>ProviderAttributeValue</code> must be the
|
|
200
|
+
* name that is used in the user pool for the user.</p>
|
|
201
|
+
* <p>The <code>ProviderAttributeName</code> must always be <code>Cognito_Subject</code> for
|
|
202
|
+
* social IdPs. The <code>ProviderAttributeValue</code> must always be the exact subject
|
|
203
|
+
* that was used when the user was originally linked as a source user.</p>
|
|
204
|
+
* <p>For de-linking a SAML identity, there are two scenarios. If the linked identity has
|
|
205
|
+
* not yet been used to sign in, the <code>ProviderAttributeName</code> and
|
|
206
|
+
* <code>ProviderAttributeValue</code> must be the same values that were used for the
|
|
207
|
+
* <code>SourceUser</code> when the identities were originally linked using <code>
|
|
208
|
+
* AdminLinkProviderForUser</code> call. (If the linking was done with
|
|
209
|
+
* <code>ProviderAttributeName</code> set to <code>Cognito_Subject</code>, the same
|
|
210
|
+
* applies here). However, if the user has already signed in, the
|
|
211
|
+
* <code>ProviderAttributeName</code> must be <code>Cognito_Subject</code> and
|
|
212
|
+
* <code>ProviderAttributeValue</code> must be the subject of the SAML
|
|
213
|
+
* assertion.</p>
|
|
196
214
|
*/
|
|
197
215
|
adminDisableProviderForUser(args: AdminDisableProviderForUserCommandInput, options?: __HttpHandlerOptions): Promise<AdminDisableProviderForUserCommandOutput>;
|
|
198
216
|
adminDisableProviderForUser(args: AdminDisableProviderForUserCommandInput, cb: (err: any, data?: AdminDisableProviderForUserCommandOutput) => void): void;
|
|
@@ -226,7 +244,8 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
226
244
|
adminGetDevice(args: AdminGetDeviceCommandInput, cb: (err: any, data?: AdminGetDeviceCommandOutput) => void): void;
|
|
227
245
|
adminGetDevice(args: AdminGetDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminGetDeviceCommandOutput) => void): void;
|
|
228
246
|
/**
|
|
229
|
-
* <p>Gets the specified user by user name in a user pool as an administrator. Works on any
|
|
247
|
+
* <p>Gets the specified user by user name in a user pool as an administrator. Works on any
|
|
248
|
+
* user.</p>
|
|
230
249
|
* <p>Calling this action requires developer credentials.</p>
|
|
231
250
|
*/
|
|
232
251
|
adminGetUser(args: AdminGetUserCommandInput, options?: __HttpHandlerOptions): Promise<AdminGetUserCommandOutput>;
|
|
@@ -235,7 +254,6 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
235
254
|
/**
|
|
236
255
|
* <p>Initiates the authentication flow, as an administrator.</p>
|
|
237
256
|
*
|
|
238
|
-
*
|
|
239
257
|
* <note>
|
|
240
258
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
241
259
|
* require you to register an origination phone number before you can send SMS messages
|
|
@@ -260,18 +278,23 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
260
278
|
adminInitiateAuth(args: AdminInitiateAuthCommandInput, cb: (err: any, data?: AdminInitiateAuthCommandOutput) => void): void;
|
|
261
279
|
adminInitiateAuth(args: AdminInitiateAuthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminInitiateAuthCommandOutput) => void): void;
|
|
262
280
|
/**
|
|
263
|
-
* <p>Links an existing user account in a user pool (<code>DestinationUser</code>) to an
|
|
264
|
-
*
|
|
265
|
-
*
|
|
266
|
-
*
|
|
267
|
-
* identity
|
|
268
|
-
*
|
|
269
|
-
*
|
|
270
|
-
*
|
|
271
|
-
*
|
|
272
|
-
*
|
|
273
|
-
*
|
|
274
|
-
*
|
|
281
|
+
* <p>Links an existing user account in a user pool (<code>DestinationUser</code>) to an
|
|
282
|
+
* identity from an external IdP (<code>SourceUser</code>) based on a specified attribute
|
|
283
|
+
* name and value from the external IdP. This allows you to create a link from the existing
|
|
284
|
+
* user account to an external federated user identity that has not yet been used to sign
|
|
285
|
+
* in. You can then use the federated user identity to sign in as the existing user
|
|
286
|
+
* account. </p>
|
|
287
|
+
* <p> For example, if there is an existing user with a username and password, this API
|
|
288
|
+
* links that user to a federated user identity. When the user signs in with a federated
|
|
289
|
+
* user identity, they sign in as the existing user account.</p>
|
|
290
|
+
* <note>
|
|
291
|
+
* <p>The maximum number of federated identities linked to a user is five.</p>
|
|
292
|
+
* </note>
|
|
293
|
+
* <important>
|
|
294
|
+
* <p>Because this API allows a user with an external federated identity to sign in as
|
|
295
|
+
* an existing user in the user pool, it is critical that it only be used with external
|
|
296
|
+
* IdPs and provider attributes that have been trusted by the application owner.</p>
|
|
297
|
+
* </important>
|
|
275
298
|
*
|
|
276
299
|
* <p>This action is administrative and requires developer credentials.</p>
|
|
277
300
|
*/
|
|
@@ -293,7 +316,8 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
293
316
|
adminListGroupsForUser(args: AdminListGroupsForUserCommandInput, cb: (err: any, data?: AdminListGroupsForUserCommandOutput) => void): void;
|
|
294
317
|
adminListGroupsForUser(args: AdminListGroupsForUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminListGroupsForUserCommandOutput) => void): void;
|
|
295
318
|
/**
|
|
296
|
-
* <p>A history of user activity and any risks detected as part of Amazon Cognito advanced
|
|
319
|
+
* <p>A history of user activity and any risks detected as part of Amazon Cognito advanced
|
|
320
|
+
* security.</p>
|
|
297
321
|
*/
|
|
298
322
|
adminListUserAuthEvents(args: AdminListUserAuthEventsCommandInput, options?: __HttpHandlerOptions): Promise<AdminListUserAuthEventsCommandOutput>;
|
|
299
323
|
adminListUserAuthEvents(args: AdminListUserAuthEventsCommandInput, cb: (err: any, data?: AdminListUserAuthEventsCommandOutput) => void): void;
|
|
@@ -306,12 +330,16 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
306
330
|
adminRemoveUserFromGroup(args: AdminRemoveUserFromGroupCommandInput, cb: (err: any, data?: AdminRemoveUserFromGroupCommandOutput) => void): void;
|
|
307
331
|
adminRemoveUserFromGroup(args: AdminRemoveUserFromGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminRemoveUserFromGroupCommandOutput) => void): void;
|
|
308
332
|
/**
|
|
309
|
-
* <p>Resets the specified user's password in a user pool as an administrator. Works on any
|
|
310
|
-
*
|
|
311
|
-
*
|
|
312
|
-
*
|
|
313
|
-
*
|
|
314
|
-
*
|
|
333
|
+
* <p>Resets the specified user's password in a user pool as an administrator. Works on any
|
|
334
|
+
* user.</p>
|
|
335
|
+
* <p>When a developer calls this API, the current password is invalidated, so it must be
|
|
336
|
+
* changed. If a user tries to sign in after the API is called, the app will get a
|
|
337
|
+
* PasswordResetRequiredException exception back and should direct the user down the flow
|
|
338
|
+
* to reset the password, which is the same as the forgot password flow. In addition, if
|
|
339
|
+
* the user pool has phone verification selected and a verified phone number exists for the
|
|
340
|
+
* user, or if email verification is selected and a verified email exists for the user,
|
|
341
|
+
* calling this API will also result in sending a message to the end user with the code to
|
|
342
|
+
* change their password.</p>
|
|
315
343
|
*
|
|
316
344
|
* <note>
|
|
317
345
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
@@ -363,35 +391,43 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
363
391
|
adminRespondToAuthChallenge(args: AdminRespondToAuthChallengeCommandInput, cb: (err: any, data?: AdminRespondToAuthChallengeCommandOutput) => void): void;
|
|
364
392
|
adminRespondToAuthChallenge(args: AdminRespondToAuthChallengeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminRespondToAuthChallengeCommandOutput) => void): void;
|
|
365
393
|
/**
|
|
366
|
-
* <p>The user's multi-factor authentication (MFA) preference, including which MFA options
|
|
367
|
-
*
|
|
368
|
-
* be
|
|
394
|
+
* <p>The user's multi-factor authentication (MFA) preference, including which MFA options
|
|
395
|
+
* are activated, and if any are preferred. Only one factor can be set as preferred. The
|
|
396
|
+
* preferred MFA factor will be used to authenticate a user if multiple factors are
|
|
397
|
+
* activated. If multiple options are activated and no preference is set, a challenge to
|
|
398
|
+
* choose an MFA option will be returned during sign-in.</p>
|
|
369
399
|
*/
|
|
370
400
|
adminSetUserMFAPreference(args: AdminSetUserMFAPreferenceCommandInput, options?: __HttpHandlerOptions): Promise<AdminSetUserMFAPreferenceCommandOutput>;
|
|
371
401
|
adminSetUserMFAPreference(args: AdminSetUserMFAPreferenceCommandInput, cb: (err: any, data?: AdminSetUserMFAPreferenceCommandOutput) => void): void;
|
|
372
402
|
adminSetUserMFAPreference(args: AdminSetUserMFAPreferenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminSetUserMFAPreferenceCommandOutput) => void): void;
|
|
373
403
|
/**
|
|
374
|
-
* <p>Sets the specified user's password in a user pool as an administrator. Works on any
|
|
375
|
-
*
|
|
376
|
-
*
|
|
377
|
-
*
|
|
378
|
-
*
|
|
404
|
+
* <p>Sets the specified user's password in a user pool as an administrator. Works on any
|
|
405
|
+
* user. </p>
|
|
406
|
+
* <p>The password can be temporary or permanent. If it is temporary, the user status enters
|
|
407
|
+
* the <code>FORCE_CHANGE_PASSWORD</code> state. When the user next tries to sign in, the
|
|
408
|
+
* InitiateAuth/AdminInitiateAuth response will contain the
|
|
409
|
+
* <code>NEW_PASSWORD_REQUIRED</code> challenge. If the user doesn't sign in before it
|
|
410
|
+
* expires, the user won't be able to sign in, and an administrator must reset their
|
|
411
|
+
* password. </p>
|
|
412
|
+
* <p>Once the user has set a new password, or the password is permanent, the user status is
|
|
413
|
+
* set to <code>Confirmed</code>.</p>
|
|
379
414
|
*/
|
|
380
415
|
adminSetUserPassword(args: AdminSetUserPasswordCommandInput, options?: __HttpHandlerOptions): Promise<AdminSetUserPasswordCommandOutput>;
|
|
381
416
|
adminSetUserPassword(args: AdminSetUserPasswordCommandInput, cb: (err: any, data?: AdminSetUserPasswordCommandOutput) => void): void;
|
|
382
417
|
adminSetUserPassword(args: AdminSetUserPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminSetUserPasswordCommandOutput) => void): void;
|
|
383
418
|
/**
|
|
384
419
|
* <p>
|
|
385
|
-
* <i>This action is no longer supported.</i> You can use it to configure
|
|
386
|
-
*
|
|
387
|
-
* use <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserMFAPreference.html">AdminSetUserMFAPreference</a> instead.</p>
|
|
420
|
+
* <i>This action is no longer supported.</i> You can use it to configure
|
|
421
|
+
* only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software
|
|
422
|
+
* 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>
|
|
388
423
|
*/
|
|
389
424
|
adminSetUserSettings(args: AdminSetUserSettingsCommandInput, options?: __HttpHandlerOptions): Promise<AdminSetUserSettingsCommandOutput>;
|
|
390
425
|
adminSetUserSettings(args: AdminSetUserSettingsCommandInput, cb: (err: any, data?: AdminSetUserSettingsCommandOutput) => void): void;
|
|
391
426
|
adminSetUserSettings(args: AdminSetUserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminSetUserSettingsCommandOutput) => void): void;
|
|
392
427
|
/**
|
|
393
|
-
* <p>Provides feedback for an authentication event indicating if it was from a valid user.
|
|
394
|
-
*
|
|
428
|
+
* <p>Provides feedback for an authentication event indicating if it was from a valid user.
|
|
429
|
+
* This feedback is used for improving the risk evaluation decision for the user pool as
|
|
430
|
+
* part of Amazon Cognito advanced security.</p>
|
|
395
431
|
*/
|
|
396
432
|
adminUpdateAuthEventFeedback(args: AdminUpdateAuthEventFeedbackCommandInput, options?: __HttpHandlerOptions): Promise<AdminUpdateAuthEventFeedbackCommandOutput>;
|
|
397
433
|
adminUpdateAuthEventFeedback(args: AdminUpdateAuthEventFeedbackCommandInput, cb: (err: any, data?: AdminUpdateAuthEventFeedbackCommandOutput) => void): void;
|
|
@@ -404,9 +440,12 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
404
440
|
adminUpdateDeviceStatus(args: AdminUpdateDeviceStatusCommandInput, cb: (err: any, data?: AdminUpdateDeviceStatusCommandOutput) => void): void;
|
|
405
441
|
adminUpdateDeviceStatus(args: AdminUpdateDeviceStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminUpdateDeviceStatusCommandOutput) => void): void;
|
|
406
442
|
/**
|
|
407
|
-
* <p>Updates the specified user's attributes, including developer attributes, as an
|
|
408
|
-
*
|
|
409
|
-
* <p>
|
|
443
|
+
* <p>Updates the specified user's attributes, including developer attributes, as an
|
|
444
|
+
* administrator. Works on any user.</p>
|
|
445
|
+
* <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the
|
|
446
|
+
* attribute name.</p>
|
|
447
|
+
* <p>In addition to updating user attributes, this API can also be used to mark phone and
|
|
448
|
+
* email as verified.</p>
|
|
410
449
|
*
|
|
411
450
|
* <note>
|
|
412
451
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
@@ -432,20 +471,28 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
432
471
|
adminUpdateUserAttributes(args: AdminUpdateUserAttributesCommandInput, cb: (err: any, data?: AdminUpdateUserAttributesCommandOutput) => void): void;
|
|
433
472
|
adminUpdateUserAttributes(args: AdminUpdateUserAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminUpdateUserAttributesCommandOutput) => void): void;
|
|
434
473
|
/**
|
|
435
|
-
* <p>Signs out
|
|
436
|
-
*
|
|
474
|
+
* <p>Signs out a user from all devices. You must sign <code>AdminUserGlobalSignOut</code> requests
|
|
475
|
+
* with Amazon Web Services credentials. It also invalidates all refresh tokens that Amazon Cognito has issued to
|
|
476
|
+
* a user. The user's current access and ID tokens remain valid until they expire. By
|
|
477
|
+
* default, access and ID tokens expire one hour after they're issued. A user can still use
|
|
478
|
+
* a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period
|
|
479
|
+
* of 1 hour.</p>
|
|
437
480
|
* <p>Calling this action requires developer credentials.</p>
|
|
438
481
|
*/
|
|
439
482
|
adminUserGlobalSignOut(args: AdminUserGlobalSignOutCommandInput, options?: __HttpHandlerOptions): Promise<AdminUserGlobalSignOutCommandOutput>;
|
|
440
483
|
adminUserGlobalSignOut(args: AdminUserGlobalSignOutCommandInput, cb: (err: any, data?: AdminUserGlobalSignOutCommandOutput) => void): void;
|
|
441
484
|
adminUserGlobalSignOut(args: AdminUserGlobalSignOutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminUserGlobalSignOutCommandOutput) => void): void;
|
|
442
485
|
/**
|
|
443
|
-
* <p>Returns a unique generated shared secret key code for the user account. The request
|
|
444
|
-
*
|
|
445
|
-
*
|
|
446
|
-
*
|
|
447
|
-
*
|
|
448
|
-
*
|
|
486
|
+
* <p>Returns a unique generated shared secret key code for the user account. The request
|
|
487
|
+
* takes an access token or a session string, but not both.</p>
|
|
488
|
+
* <note>
|
|
489
|
+
* <p>Calling AssociateSoftwareToken immediately disassociates the existing software
|
|
490
|
+
* token from the user account. If the user doesn't subsequently verify the software
|
|
491
|
+
* token, their account is set up to authenticate without MFA. If MFA config is set to
|
|
492
|
+
* Optional at the user pool level, the user can then log in without MFA. However, if
|
|
493
|
+
* MFA is set to Required for the user pool, the user is asked to set up a new software
|
|
494
|
+
* token MFA during sign-in.</p>
|
|
495
|
+
* </note>
|
|
449
496
|
*/
|
|
450
497
|
associateSoftwareToken(args: AssociateSoftwareTokenCommandInput, options?: __HttpHandlerOptions): Promise<AssociateSoftwareTokenCommandOutput>;
|
|
451
498
|
associateSoftwareToken(args: AssociateSoftwareTokenCommandInput, cb: (err: any, data?: AssociateSoftwareTokenCommandOutput) => void): void;
|
|
@@ -457,7 +504,8 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
457
504
|
changePassword(args: ChangePasswordCommandInput, cb: (err: any, data?: ChangePasswordCommandOutput) => void): void;
|
|
458
505
|
changePassword(args: ChangePasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ChangePasswordCommandOutput) => void): void;
|
|
459
506
|
/**
|
|
460
|
-
* <p>Confirms tracking of the device. This API call is the call that begins device
|
|
507
|
+
* <p>Confirms tracking of the device. This API call is the call that begins device
|
|
508
|
+
* tracking.</p>
|
|
461
509
|
*/
|
|
462
510
|
confirmDevice(args: ConfirmDeviceCommandInput, options?: __HttpHandlerOptions): Promise<ConfirmDeviceCommandOutput>;
|
|
463
511
|
confirmDevice(args: ConfirmDeviceCommandInput, cb: (err: any, data?: ConfirmDeviceCommandOutput) => void): void;
|
|
@@ -469,7 +517,7 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
469
517
|
confirmForgotPassword(args: ConfirmForgotPasswordCommandInput, cb: (err: any, data?: ConfirmForgotPasswordCommandOutput) => void): void;
|
|
470
518
|
confirmForgotPassword(args: ConfirmForgotPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfirmForgotPasswordCommandOutput) => void): void;
|
|
471
519
|
/**
|
|
472
|
-
* <p>Confirms registration of a
|
|
520
|
+
* <p>Confirms registration of a new user.</p>
|
|
473
521
|
*/
|
|
474
522
|
confirmSignUp(args: ConfirmSignUpCommandInput, options?: __HttpHandlerOptions): Promise<ConfirmSignUpCommandOutput>;
|
|
475
523
|
confirmSignUp(args: ConfirmSignUpCommandInput, cb: (err: any, data?: ConfirmSignUpCommandOutput) => void): void;
|
|
@@ -482,7 +530,7 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
482
530
|
createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void;
|
|
483
531
|
createGroup(args: CreateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupCommandOutput) => void): void;
|
|
484
532
|
/**
|
|
485
|
-
* <p>Creates an
|
|
533
|
+
* <p>Creates an IdP for a user pool.</p>
|
|
486
534
|
*/
|
|
487
535
|
createIdentityProvider(args: CreateIdentityProviderCommandInput, options?: __HttpHandlerOptions): Promise<CreateIdentityProviderCommandOutput>;
|
|
488
536
|
createIdentityProvider(args: CreateIdentityProviderCommandInput, cb: (err: any, data?: CreateIdentityProviderCommandOutput) => void): void;
|
|
@@ -500,7 +548,8 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
500
548
|
createUserImportJob(args: CreateUserImportJobCommandInput, cb: (err: any, data?: CreateUserImportJobCommandOutput) => void): void;
|
|
501
549
|
createUserImportJob(args: CreateUserImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserImportJobCommandOutput) => void): void;
|
|
502
550
|
/**
|
|
503
|
-
* <p>Creates a new Amazon Cognito user pool and sets the password policy for the
|
|
551
|
+
* <p>Creates a new Amazon Cognito user pool and sets the password policy for the
|
|
552
|
+
* pool.</p>
|
|
504
553
|
*
|
|
505
554
|
* <note>
|
|
506
555
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
@@ -525,8 +574,8 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
525
574
|
createUserPool(args: CreateUserPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserPoolCommandOutput) => void): void;
|
|
526
575
|
/**
|
|
527
576
|
* <p>Creates the user pool client.</p>
|
|
528
|
-
* <p>When you create a new user pool client, token revocation is automatically activated.
|
|
529
|
-
* see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
|
|
577
|
+
* <p>When you create a new user pool client, token revocation is automatically activated.
|
|
578
|
+
* 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>
|
|
530
579
|
*/
|
|
531
580
|
createUserPoolClient(args: CreateUserPoolClientCommandInput, options?: __HttpHandlerOptions): Promise<CreateUserPoolClientCommandOutput>;
|
|
532
581
|
createUserPoolClient(args: CreateUserPoolClientCommandInput, cb: (err: any, data?: CreateUserPoolClientCommandOutput) => void): void;
|
|
@@ -545,7 +594,7 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
545
594
|
deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void;
|
|
546
595
|
deleteGroup(args: DeleteGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void;
|
|
547
596
|
/**
|
|
548
|
-
* <p>Deletes an
|
|
597
|
+
* <p>Deletes an IdP for a user pool.</p>
|
|
549
598
|
*/
|
|
550
599
|
deleteIdentityProvider(args: DeleteIdentityProviderCommandInput, options?: __HttpHandlerOptions): Promise<DeleteIdentityProviderCommandOutput>;
|
|
551
600
|
deleteIdentityProvider(args: DeleteIdentityProviderCommandInput, cb: (err: any, data?: DeleteIdentityProviderCommandOutput) => void): void;
|
|
@@ -587,7 +636,7 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
587
636
|
deleteUserPoolDomain(args: DeleteUserPoolDomainCommandInput, cb: (err: any, data?: DeleteUserPoolDomainCommandOutput) => void): void;
|
|
588
637
|
deleteUserPoolDomain(args: DeleteUserPoolDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserPoolDomainCommandOutput) => void): void;
|
|
589
638
|
/**
|
|
590
|
-
* <p>Gets information about a specific
|
|
639
|
+
* <p>Gets information about a specific IdP.</p>
|
|
591
640
|
*/
|
|
592
641
|
describeIdentityProvider(args: DescribeIdentityProviderCommandInput, options?: __HttpHandlerOptions): Promise<DescribeIdentityProviderCommandOutput>;
|
|
593
642
|
describeIdentityProvider(args: DescribeIdentityProviderCommandInput, cb: (err: any, data?: DescribeIdentityProviderCommandOutput) => void): void;
|
|
@@ -617,7 +666,8 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
617
666
|
describeUserPool(args: DescribeUserPoolCommandInput, cb: (err: any, data?: DescribeUserPoolCommandOutput) => void): void;
|
|
618
667
|
describeUserPool(args: DescribeUserPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserPoolCommandOutput) => void): void;
|
|
619
668
|
/**
|
|
620
|
-
* <p>Client method for returning the configuration information and metadata of the
|
|
669
|
+
* <p>Client method for returning the configuration information and metadata of the
|
|
670
|
+
* specified user pool app client.</p>
|
|
621
671
|
*/
|
|
622
672
|
describeUserPoolClient(args: DescribeUserPoolClientCommandInput, options?: __HttpHandlerOptions): Promise<DescribeUserPoolClientCommandOutput>;
|
|
623
673
|
describeUserPoolClient(args: DescribeUserPoolClientCommandInput, cb: (err: any, data?: DescribeUserPoolClientCommandOutput) => void): void;
|
|
@@ -635,14 +685,14 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
635
685
|
forgetDevice(args: ForgetDeviceCommandInput, cb: (err: any, data?: ForgetDeviceCommandOutput) => void): void;
|
|
636
686
|
forgetDevice(args: ForgetDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ForgetDeviceCommandOutput) => void): void;
|
|
637
687
|
/**
|
|
638
|
-
* <p>Calling this API causes a message to be sent to the end user with a confirmation code
|
|
639
|
-
*
|
|
640
|
-
*
|
|
641
|
-
* see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-recover-a-user-account.html">Recovering
|
|
642
|
-
*
|
|
643
|
-
*
|
|
644
|
-
*
|
|
645
|
-
*
|
|
688
|
+
* <p>Calling this API causes a message to be sent to the end user with a confirmation code
|
|
689
|
+
* that is required to change the user's password. For the <code>Username</code> parameter,
|
|
690
|
+
* you can use the username or user alias. The method used to send the confirmation code is
|
|
691
|
+
* 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
|
|
692
|
+
* User Accounts</a> in the <i>Amazon Cognito Developer Guide</i>. If
|
|
693
|
+
* neither a verified phone number nor a verified email exists, an
|
|
694
|
+
* <code>InvalidParameterException</code> is thrown. To use the confirmation code for
|
|
695
|
+
* resetting the password, call <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html">ConfirmForgotPassword</a>. </p>
|
|
646
696
|
*
|
|
647
697
|
* <note>
|
|
648
698
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
@@ -666,7 +716,8 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
666
716
|
forgotPassword(args: ForgotPasswordCommandInput, cb: (err: any, data?: ForgotPasswordCommandOutput) => void): void;
|
|
667
717
|
forgotPassword(args: ForgotPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ForgotPasswordCommandOutput) => void): void;
|
|
668
718
|
/**
|
|
669
|
-
* <p>Gets the header information for the comma-separated value (CSV) file to be used as
|
|
719
|
+
* <p>Gets the header information for the comma-separated value (CSV) file to be used as
|
|
720
|
+
* input for the user import job.</p>
|
|
670
721
|
*/
|
|
671
722
|
getCSVHeader(args: GetCSVHeaderCommandInput, options?: __HttpHandlerOptions): Promise<GetCSVHeaderCommandOutput>;
|
|
672
723
|
getCSVHeader(args: GetCSVHeaderCommandInput, cb: (err: any, data?: GetCSVHeaderCommandOutput) => void): void;
|
|
@@ -685,7 +736,7 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
685
736
|
getGroup(args: GetGroupCommandInput, cb: (err: any, data?: GetGroupCommandOutput) => void): void;
|
|
686
737
|
getGroup(args: GetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupCommandOutput) => void): void;
|
|
687
738
|
/**
|
|
688
|
-
* <p>Gets the specified
|
|
739
|
+
* <p>Gets the specified IdP.</p>
|
|
689
740
|
*/
|
|
690
741
|
getIdentityProviderByIdentifier(args: GetIdentityProviderByIdentifierCommandInput, options?: __HttpHandlerOptions): Promise<GetIdentityProviderByIdentifierCommandOutput>;
|
|
691
742
|
getIdentityProviderByIdentifier(args: GetIdentityProviderByIdentifierCommandInput, cb: (err: any, data?: GetIdentityProviderByIdentifierCommandOutput) => void): void;
|
|
@@ -697,8 +748,11 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
697
748
|
getSigningCertificate(args: GetSigningCertificateCommandInput, cb: (err: any, data?: GetSigningCertificateCommandOutput) => void): void;
|
|
698
749
|
getSigningCertificate(args: GetSigningCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSigningCertificateCommandOutput) => void): void;
|
|
699
750
|
/**
|
|
700
|
-
* <p>Gets the user interface (UI) Customization information for a particular app client's
|
|
701
|
-
*
|
|
751
|
+
* <p>Gets the user interface (UI) Customization information for a particular app client's
|
|
752
|
+
* app UI, if any such information exists for the client. If nothing is set for the
|
|
753
|
+
* particular client, but there is an existing pool level customization (the app
|
|
754
|
+
* <code>clientId</code> is <code>ALL</code>), then that information is returned. If
|
|
755
|
+
* nothing is present, then an empty shape is returned.</p>
|
|
702
756
|
*/
|
|
703
757
|
getUICustomization(args: GetUICustomizationCommandInput, options?: __HttpHandlerOptions): Promise<GetUICustomizationCommandOutput>;
|
|
704
758
|
getUICustomization(args: GetUICustomizationCommandInput, cb: (err: any, data?: GetUICustomizationCommandOutput) => void): void;
|
|
@@ -710,7 +764,9 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
710
764
|
getUser(args: GetUserCommandInput, cb: (err: any, data?: GetUserCommandOutput) => void): void;
|
|
711
765
|
getUser(args: GetUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserCommandOutput) => void): void;
|
|
712
766
|
/**
|
|
713
|
-
* <p>
|
|
767
|
+
* <p>Generates a user attribute verification code for the specified attribute name. Sends a
|
|
768
|
+
* message to a user with a code that they must return in a VerifyUserAttribute
|
|
769
|
+
* request.</p>
|
|
714
770
|
*
|
|
715
771
|
* <note>
|
|
716
772
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
@@ -740,14 +796,18 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
740
796
|
getUserPoolMfaConfig(args: GetUserPoolMfaConfigCommandInput, cb: (err: any, data?: GetUserPoolMfaConfigCommandOutput) => void): void;
|
|
741
797
|
getUserPoolMfaConfig(args: GetUserPoolMfaConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserPoolMfaConfigCommandOutput) => void): void;
|
|
742
798
|
/**
|
|
743
|
-
* <p>Signs out users from all devices. It also invalidates all refresh tokens
|
|
744
|
-
*
|
|
799
|
+
* <p>Signs out users from all devices. It also invalidates all refresh tokens that Amazon Cognito
|
|
800
|
+
* has issued to a user. The user's current access and ID tokens remain valid until their
|
|
801
|
+
* expiry. By default, access and ID tokens expire one hour after Amazon Cognito issues them. A user
|
|
802
|
+
* can still use a hosted UI cookie to retrieve new tokens for the duration of the cookie
|
|
803
|
+
* validity period of 1 hour.</p>
|
|
745
804
|
*/
|
|
746
805
|
globalSignOut(args: GlobalSignOutCommandInput, options?: __HttpHandlerOptions): Promise<GlobalSignOutCommandOutput>;
|
|
747
806
|
globalSignOut(args: GlobalSignOutCommandInput, cb: (err: any, data?: GlobalSignOutCommandOutput) => void): void;
|
|
748
807
|
globalSignOut(args: GlobalSignOutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GlobalSignOutCommandOutput) => void): void;
|
|
749
808
|
/**
|
|
750
|
-
* <p>Initiates the
|
|
809
|
+
* <p>Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user
|
|
810
|
+
* 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>
|
|
751
811
|
*
|
|
752
812
|
* <note>
|
|
753
813
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
@@ -771,7 +831,7 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
771
831
|
initiateAuth(args: InitiateAuthCommandInput, cb: (err: any, data?: InitiateAuthCommandOutput) => void): void;
|
|
772
832
|
initiateAuth(args: InitiateAuthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InitiateAuthCommandOutput) => void): void;
|
|
773
833
|
/**
|
|
774
|
-
* <p>Lists the devices.</p>
|
|
834
|
+
* <p>Lists the sign-in devices that Amazon Cognito has registered to the current user.</p>
|
|
775
835
|
*/
|
|
776
836
|
listDevices(args: ListDevicesCommandInput, options?: __HttpHandlerOptions): Promise<ListDevicesCommandOutput>;
|
|
777
837
|
listDevices(args: ListDevicesCommandInput, cb: (err: any, data?: ListDevicesCommandOutput) => void): void;
|
|
@@ -784,7 +844,7 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
784
844
|
listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
|
|
785
845
|
listGroups(args: ListGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
|
|
786
846
|
/**
|
|
787
|
-
* <p>Lists information about all
|
|
847
|
+
* <p>Lists information about all IdPs for a user pool.</p>
|
|
788
848
|
*/
|
|
789
849
|
listIdentityProviders(args: ListIdentityProvidersCommandInput, options?: __HttpHandlerOptions): Promise<ListIdentityProvidersCommandOutput>;
|
|
790
850
|
listIdentityProviders(args: ListIdentityProvidersCommandInput, cb: (err: any, data?: ListIdentityProvidersCommandOutput) => void): void;
|
|
@@ -797,7 +857,8 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
797
857
|
listResourceServers(args: ListResourceServersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceServersCommandOutput) => void): void;
|
|
798
858
|
/**
|
|
799
859
|
* <p>Lists the tags that are assigned to an Amazon Cognito user pool.</p>
|
|
800
|
-
* <p>A tag is a label that you can apply to user pools to categorize and manage them in
|
|
860
|
+
* <p>A tag is a label that you can apply to user pools to categorize and manage them in
|
|
861
|
+
* different ways, such as by purpose, owner, environment, or other criteria.</p>
|
|
801
862
|
* <p>You can use this action up to 10 times per second, per account.</p>
|
|
802
863
|
*/
|
|
803
864
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
@@ -835,7 +896,8 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
835
896
|
listUsersInGroup(args: ListUsersInGroupCommandInput, cb: (err: any, data?: ListUsersInGroupCommandOutput) => void): void;
|
|
836
897
|
listUsersInGroup(args: ListUsersInGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersInGroupCommandOutput) => void): void;
|
|
837
898
|
/**
|
|
838
|
-
* <p>Resends the confirmation (for confirmation of registration) to a specific user in the
|
|
899
|
+
* <p>Resends the confirmation (for confirmation of registration) to a specific user in the
|
|
900
|
+
* user pool.</p>
|
|
839
901
|
*
|
|
840
902
|
* <note>
|
|
841
903
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
@@ -883,36 +945,50 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
883
945
|
respondToAuthChallenge(args: RespondToAuthChallengeCommandInput, cb: (err: any, data?: RespondToAuthChallengeCommandOutput) => void): void;
|
|
884
946
|
respondToAuthChallenge(args: RespondToAuthChallengeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RespondToAuthChallengeCommandOutput) => void): void;
|
|
885
947
|
/**
|
|
886
|
-
* <p>Revokes all of the access tokens generated by the specified refresh token. After the
|
|
948
|
+
* <p>Revokes all of the access tokens generated by the specified refresh token. After the
|
|
949
|
+
* token is revoked, you can't use the revoked token to access Amazon Cognito authenticated
|
|
950
|
+
* APIs.</p>
|
|
887
951
|
*/
|
|
888
952
|
revokeToken(args: RevokeTokenCommandInput, options?: __HttpHandlerOptions): Promise<RevokeTokenCommandOutput>;
|
|
889
953
|
revokeToken(args: RevokeTokenCommandInput, cb: (err: any, data?: RevokeTokenCommandOutput) => void): void;
|
|
890
954
|
revokeToken(args: RevokeTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeTokenCommandOutput) => void): void;
|
|
891
955
|
/**
|
|
892
|
-
* <p>Configures actions on detected risks. To delete the risk configuration for
|
|
893
|
-
*
|
|
956
|
+
* <p>Configures actions on detected risks. To delete the risk configuration for
|
|
957
|
+
* <code>UserPoolId</code> or <code>ClientId</code>, pass null values for all four
|
|
958
|
+
* configuration types.</p>
|
|
959
|
+
* <p>To activate Amazon Cognito advanced security features, update the user pool to include the
|
|
960
|
+
* <code>UserPoolAddOns</code> key<code>AdvancedSecurityMode</code>.</p>
|
|
894
961
|
*/
|
|
895
962
|
setRiskConfiguration(args: SetRiskConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<SetRiskConfigurationCommandOutput>;
|
|
896
963
|
setRiskConfiguration(args: SetRiskConfigurationCommandInput, cb: (err: any, data?: SetRiskConfigurationCommandOutput) => void): void;
|
|
897
964
|
setRiskConfiguration(args: SetRiskConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetRiskConfigurationCommandOutput) => void): void;
|
|
898
965
|
/**
|
|
899
|
-
* <p>Sets the user interface (UI) customization information for a user pool's built-in app
|
|
900
|
-
*
|
|
901
|
-
*
|
|
902
|
-
*
|
|
903
|
-
*
|
|
904
|
-
*
|
|
905
|
-
*
|
|
966
|
+
* <p>Sets the user interface (UI) customization information for a user pool's built-in app
|
|
967
|
+
* UI.</p>
|
|
968
|
+
* <p>You can specify app UI customization settings for a single client (with a specific
|
|
969
|
+
* <code>clientId</code>) or for all clients (by setting the <code>clientId</code> to
|
|
970
|
+
* <code>ALL</code>). If you specify <code>ALL</code>, the default configuration is
|
|
971
|
+
* used for every client that has no previously set UI customization. If you specify UI
|
|
972
|
+
* customization settings for a particular client, it will no longer return to the
|
|
973
|
+
* <code>ALL</code> configuration.</p>
|
|
974
|
+
* <note>
|
|
975
|
+
* <p>To use this API, your user pool must have a domain associated with it. Otherwise,
|
|
976
|
+
* there is no place to host the app's pages, and the service will throw an
|
|
977
|
+
* error.</p>
|
|
978
|
+
* </note>
|
|
906
979
|
*/
|
|
907
980
|
setUICustomization(args: SetUICustomizationCommandInput, options?: __HttpHandlerOptions): Promise<SetUICustomizationCommandOutput>;
|
|
908
981
|
setUICustomization(args: SetUICustomizationCommandInput, cb: (err: any, data?: SetUICustomizationCommandOutput) => void): void;
|
|
909
982
|
setUICustomization(args: SetUICustomizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetUICustomizationCommandOutput) => void): void;
|
|
910
983
|
/**
|
|
911
|
-
* <p>Set the user's multi-factor authentication (MFA) method preference, including which
|
|
912
|
-
*
|
|
913
|
-
*
|
|
914
|
-
*
|
|
915
|
-
*
|
|
984
|
+
* <p>Set the user's multi-factor authentication (MFA) method preference, including which
|
|
985
|
+
* MFA factors are activated and if any are preferred. Only one factor can be set as
|
|
986
|
+
* preferred. The preferred MFA factor will be used to authenticate a user if multiple
|
|
987
|
+
* factors are activated. If multiple options are activated and no preference is set, a
|
|
988
|
+
* challenge to choose an MFA option will be returned during sign-in. If an MFA type is
|
|
989
|
+
* activated for a user, the user will be prompted for MFA during all sign-in attempts
|
|
990
|
+
* unless device tracking is turned on and the device has been trusted. If you want MFA to
|
|
991
|
+
* be applied selectively based on the assessed risk level of sign-in attempts, deactivate
|
|
916
992
|
* MFA for users and turn on Adaptive Authentication for the user pool.</p>
|
|
917
993
|
*/
|
|
918
994
|
setUserMFAPreference(args: SetUserMFAPreferenceCommandInput, options?: __HttpHandlerOptions): Promise<SetUserMFAPreferenceCommandOutput>;
|
|
@@ -944,14 +1020,16 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
944
1020
|
setUserPoolMfaConfig(args: SetUserPoolMfaConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetUserPoolMfaConfigCommandOutput) => void): void;
|
|
945
1021
|
/**
|
|
946
1022
|
* <p>
|
|
947
|
-
* <i>This action is no longer supported.</i> You can use it to configure
|
|
948
|
-
*
|
|
1023
|
+
* <i>This action is no longer supported.</i> You can use it to configure
|
|
1024
|
+
* only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software
|
|
1025
|
+
* 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>
|
|
949
1026
|
*/
|
|
950
1027
|
setUserSettings(args: SetUserSettingsCommandInput, options?: __HttpHandlerOptions): Promise<SetUserSettingsCommandOutput>;
|
|
951
1028
|
setUserSettings(args: SetUserSettingsCommandInput, cb: (err: any, data?: SetUserSettingsCommandOutput) => void): void;
|
|
952
1029
|
setUserSettings(args: SetUserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetUserSettingsCommandOutput) => void): void;
|
|
953
1030
|
/**
|
|
954
|
-
* <p>Registers the user in the specified user pool and creates a user name, password, and
|
|
1031
|
+
* <p>Registers the user in the specified user pool and creates a user name, password, and
|
|
1032
|
+
* user attributes.</p>
|
|
955
1033
|
*
|
|
956
1034
|
* <note>
|
|
957
1035
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
@@ -987,26 +1065,35 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
987
1065
|
stopUserImportJob(args: StopUserImportJobCommandInput, cb: (err: any, data?: StopUserImportJobCommandOutput) => void): void;
|
|
988
1066
|
stopUserImportJob(args: StopUserImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopUserImportJobCommandOutput) => void): void;
|
|
989
1067
|
/**
|
|
990
|
-
* <p>Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to
|
|
991
|
-
*
|
|
992
|
-
*
|
|
993
|
-
*
|
|
994
|
-
*
|
|
995
|
-
*
|
|
996
|
-
*
|
|
1068
|
+
* <p>Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to
|
|
1069
|
+
* categorize and manage user pools in different ways, such as by purpose, owner,
|
|
1070
|
+
* environment, or other criteria.</p>
|
|
1071
|
+
* <p>Each tag consists of a key and value, both of which you define. A key is a general
|
|
1072
|
+
* category for more specific values. For example, if you have two versions of a user pool,
|
|
1073
|
+
* one for testing and another for production, you might assign an <code>Environment</code>
|
|
1074
|
+
* tag key to both user pools. The value of this key might be <code>Test</code> for one
|
|
1075
|
+
* user pool, and <code>Production</code> for the other.</p>
|
|
1076
|
+
* <p>Tags are useful for cost tracking and access control. You can activate your tags so
|
|
1077
|
+
* that they appear on the Billing and Cost Management console, where you can track the
|
|
1078
|
+
* costs associated with your user pools. In an Identity and Access Management policy, you can constrain
|
|
1079
|
+
* permissions for user pools based on specific tags or tag values.</p>
|
|
1080
|
+
* <p>You can use this action up to 5 times per second, per account. A user pool can have as
|
|
1081
|
+
* many as 50 tags.</p>
|
|
997
1082
|
*/
|
|
998
1083
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
999
1084
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
1000
1085
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
1001
1086
|
/**
|
|
1002
|
-
* <p>Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5
|
|
1087
|
+
* <p>Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5
|
|
1088
|
+
* times per second, per account.</p>
|
|
1003
1089
|
*/
|
|
1004
1090
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
1005
1091
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
1006
1092
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
1007
1093
|
/**
|
|
1008
|
-
* <p>Provides the feedback for an authentication event, whether it was from a valid user or
|
|
1009
|
-
*
|
|
1094
|
+
* <p>Provides the feedback for an authentication event, whether it was from a valid user or
|
|
1095
|
+
* not. This feedback is used for improving the risk evaluation decision for the user pool
|
|
1096
|
+
* as part of Amazon Cognito advanced security.</p>
|
|
1010
1097
|
*/
|
|
1011
1098
|
updateAuthEventFeedback(args: UpdateAuthEventFeedbackCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAuthEventFeedbackCommandOutput>;
|
|
1012
1099
|
updateAuthEventFeedback(args: UpdateAuthEventFeedbackCommandInput, cb: (err: any, data?: UpdateAuthEventFeedbackCommandOutput) => void): void;
|
|
@@ -1025,16 +1112,17 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
1025
1112
|
updateGroup(args: UpdateGroupCommandInput, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void;
|
|
1026
1113
|
updateGroup(args: UpdateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void;
|
|
1027
1114
|
/**
|
|
1028
|
-
* <p>Updates
|
|
1115
|
+
* <p>Updates IdP information for a user pool.</p>
|
|
1029
1116
|
*/
|
|
1030
1117
|
updateIdentityProvider(args: UpdateIdentityProviderCommandInput, options?: __HttpHandlerOptions): Promise<UpdateIdentityProviderCommandOutput>;
|
|
1031
1118
|
updateIdentityProvider(args: UpdateIdentityProviderCommandInput, cb: (err: any, data?: UpdateIdentityProviderCommandOutput) => void): void;
|
|
1032
1119
|
updateIdentityProvider(args: UpdateIdentityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIdentityProviderCommandOutput) => void): void;
|
|
1033
1120
|
/**
|
|
1034
1121
|
* <p>Updates the name and scopes of resource server. All other fields are read-only.</p>
|
|
1035
|
-
*
|
|
1036
|
-
* <p>If you don't provide a value for an attribute, it is set to the default
|
|
1037
|
-
*
|
|
1122
|
+
* <important>
|
|
1123
|
+
* <p>If you don't provide a value for an attribute, it is set to the default
|
|
1124
|
+
* value.</p>
|
|
1125
|
+
* </important>
|
|
1038
1126
|
*/
|
|
1039
1127
|
updateResourceServer(args: UpdateResourceServerCommandInput, options?: __HttpHandlerOptions): Promise<UpdateResourceServerCommandOutput>;
|
|
1040
1128
|
updateResourceServer(args: UpdateResourceServerCommandInput, cb: (err: any, data?: UpdateResourceServerCommandOutput) => void): void;
|
|
@@ -1064,9 +1152,10 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
1064
1152
|
updateUserAttributes(args: UpdateUserAttributesCommandInput, cb: (err: any, data?: UpdateUserAttributesCommandOutput) => void): void;
|
|
1065
1153
|
updateUserAttributes(args: UpdateUserAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserAttributesCommandOutput) => void): void;
|
|
1066
1154
|
/**
|
|
1067
|
-
* <p>Updates the specified user pool with the specified attributes. You can get a list of
|
|
1068
|
-
* <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>.
|
|
1069
|
-
*
|
|
1155
|
+
* <p>Updates the specified user pool with the specified attributes. You can get a list of
|
|
1156
|
+
* 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
|
|
1157
|
+
* set to the default value.
|
|
1158
|
+
* </p>
|
|
1070
1159
|
*
|
|
1071
1160
|
* <note>
|
|
1072
1161
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
@@ -1090,43 +1179,58 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
1090
1179
|
updateUserPool(args: UpdateUserPoolCommandInput, cb: (err: any, data?: UpdateUserPoolCommandOutput) => void): void;
|
|
1091
1180
|
updateUserPool(args: UpdateUserPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserPoolCommandOutput) => void): void;
|
|
1092
1181
|
/**
|
|
1093
|
-
* <p>Updates the specified user pool app client with the specified attributes. You can get
|
|
1094
|
-
* <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html">DescribeUserPoolClient</a>.</p>
|
|
1095
|
-
*
|
|
1096
|
-
* <p>If you don't provide a value for an attribute, it will be set to the default
|
|
1097
|
-
*
|
|
1098
|
-
*
|
|
1099
|
-
*
|
|
1182
|
+
* <p>Updates the specified user pool app client with the specified attributes. You can get
|
|
1183
|
+
* 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>
|
|
1184
|
+
* <important>
|
|
1185
|
+
* <p>If you don't provide a value for an attribute, it will be set to the default
|
|
1186
|
+
* value.</p>
|
|
1187
|
+
* </important>
|
|
1188
|
+
* <p>You can also use this operation to enable token revocation for user pool clients. For
|
|
1189
|
+
* 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>
|
|
1100
1190
|
*/
|
|
1101
1191
|
updateUserPoolClient(args: UpdateUserPoolClientCommandInput, options?: __HttpHandlerOptions): Promise<UpdateUserPoolClientCommandOutput>;
|
|
1102
1192
|
updateUserPoolClient(args: UpdateUserPoolClientCommandInput, cb: (err: any, data?: UpdateUserPoolClientCommandOutput) => void): void;
|
|
1103
1193
|
updateUserPoolClient(args: UpdateUserPoolClientCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserPoolClientCommandOutput) => void): void;
|
|
1104
1194
|
/**
|
|
1105
|
-
* <p>Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user
|
|
1106
|
-
*
|
|
1107
|
-
* <p>
|
|
1108
|
-
*
|
|
1109
|
-
* <p>
|
|
1110
|
-
*
|
|
1111
|
-
*
|
|
1112
|
-
*
|
|
1113
|
-
* <p>
|
|
1114
|
-
*
|
|
1115
|
-
*
|
|
1116
|
-
*
|
|
1195
|
+
* <p>Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user
|
|
1196
|
+
* pool.</p>
|
|
1197
|
+
* <p>You can use this operation to provide the Amazon Resource Name (ARN) of a new
|
|
1198
|
+
* certificate to Amazon Cognito. You can't use it to change the domain for a user pool.</p>
|
|
1199
|
+
* <p>A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and
|
|
1200
|
+
* sign-in pages for your application. When you set up a custom domain, you provide a
|
|
1201
|
+
* certificate that you manage with Certificate Manager (ACM). When necessary, you can use this
|
|
1202
|
+
* operation to change the certificate that you applied to your custom domain.</p>
|
|
1203
|
+
* <p>Usually, this is unnecessary following routine certificate renewal with ACM. When
|
|
1204
|
+
* you renew your existing certificate in ACM, the ARN for your certificate remains the
|
|
1205
|
+
* same, and your custom domain uses the new certificate automatically.</p>
|
|
1206
|
+
* <p>However, if you replace your existing certificate with a new one, ACM gives the new
|
|
1207
|
+
* certificate a new ARN. To apply the new certificate to your custom domain, you must
|
|
1208
|
+
* provide this ARN to Amazon Cognito.</p>
|
|
1209
|
+
* <p>When you add your new certificate in ACM, you must choose US East (N. Virginia) as
|
|
1210
|
+
* the Amazon Web Services Region.</p>
|
|
1211
|
+
* <p>After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new
|
|
1212
|
+
* certificate to your custom domain.</p>
|
|
1213
|
+
* <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>
|
|
1117
1214
|
*/
|
|
1118
1215
|
updateUserPoolDomain(args: UpdateUserPoolDomainCommandInput, options?: __HttpHandlerOptions): Promise<UpdateUserPoolDomainCommandOutput>;
|
|
1119
1216
|
updateUserPoolDomain(args: UpdateUserPoolDomainCommandInput, cb: (err: any, data?: UpdateUserPoolDomainCommandOutput) => void): void;
|
|
1120
1217
|
updateUserPoolDomain(args: UpdateUserPoolDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserPoolDomainCommandOutput) => void): void;
|
|
1121
1218
|
/**
|
|
1122
|
-
* <p>Use this API to register a user's entered time-based one-time password (TOTP) code and
|
|
1123
|
-
* token
|
|
1219
|
+
* <p>Use this API to register a user's entered time-based one-time password (TOTP) code and
|
|
1220
|
+
* mark the user's software token MFA status as "verified" if successful. The request takes
|
|
1221
|
+
* an access token or a session string, but not both.</p>
|
|
1124
1222
|
*/
|
|
1125
1223
|
verifySoftwareToken(args: VerifySoftwareTokenCommandInput, options?: __HttpHandlerOptions): Promise<VerifySoftwareTokenCommandOutput>;
|
|
1126
1224
|
verifySoftwareToken(args: VerifySoftwareTokenCommandInput, cb: (err: any, data?: VerifySoftwareTokenCommandOutput) => void): void;
|
|
1127
1225
|
verifySoftwareToken(args: VerifySoftwareTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifySoftwareTokenCommandOutput) => void): void;
|
|
1128
1226
|
/**
|
|
1129
1227
|
* <p>Verifies the specified user attributes in the user pool.</p>
|
|
1228
|
+
* <p>
|
|
1229
|
+
* If your user pool requires verification before Amazon Cognito updates the attribute value,
|
|
1230
|
+
* VerifyUserAttribute updates the affected attribute to its pending value. For more information,
|
|
1231
|
+
* see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserAttributeUpdateSettingsType.html">
|
|
1232
|
+
* UserAttributeUpdateSettingsType</a>.
|
|
1233
|
+
* </p>
|
|
1130
1234
|
*/
|
|
1131
1235
|
verifyUserAttribute(args: VerifyUserAttributeCommandInput, options?: __HttpHandlerOptions): Promise<VerifyUserAttributeCommandOutput>;
|
|
1132
1236
|
verifyUserAttribute(args: VerifyUserAttributeCommandInput, cb: (err: any, data?: VerifyUserAttributeCommandOutput) => void): void;
|