@aws-sdk/client-cognito-identity-provider 3.53.0 → 3.55.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +27 -0
- package/dist-cjs/CognitoIdentityProviderClient.js +12 -12
- package/dist-cjs/commands/AddCustomAttributesCommand.js +4 -4
- package/dist-cjs/commands/AdminAddUserToGroupCommand.js +4 -4
- package/dist-cjs/commands/AdminConfirmSignUpCommand.js +4 -4
- package/dist-cjs/commands/AdminCreateUserCommand.js +4 -4
- package/dist-cjs/commands/AdminDeleteUserAttributesCommand.js +4 -4
- package/dist-cjs/commands/AdminDeleteUserCommand.js +4 -4
- package/dist-cjs/commands/AdminDisableProviderForUserCommand.js +4 -4
- package/dist-cjs/commands/AdminDisableUserCommand.js +4 -4
- package/dist-cjs/commands/AdminEnableUserCommand.js +4 -4
- package/dist-cjs/commands/AdminForgetDeviceCommand.js +4 -4
- package/dist-cjs/commands/AdminGetDeviceCommand.js +4 -4
- package/dist-cjs/commands/AdminGetUserCommand.js +4 -4
- package/dist-cjs/commands/AdminInitiateAuthCommand.js +4 -4
- package/dist-cjs/commands/AdminLinkProviderForUserCommand.js +4 -4
- package/dist-cjs/commands/AdminListDevicesCommand.js +4 -4
- package/dist-cjs/commands/AdminListGroupsForUserCommand.js +4 -4
- package/dist-cjs/commands/AdminListUserAuthEventsCommand.js +4 -4
- package/dist-cjs/commands/AdminRemoveUserFromGroupCommand.js +4 -4
- package/dist-cjs/commands/AdminResetUserPasswordCommand.js +4 -4
- package/dist-cjs/commands/AdminRespondToAuthChallengeCommand.js +4 -4
- package/dist-cjs/commands/AdminSetUserMFAPreferenceCommand.js +4 -4
- package/dist-cjs/commands/AdminSetUserPasswordCommand.js +4 -4
- package/dist-cjs/commands/AdminSetUserSettingsCommand.js +4 -4
- package/dist-cjs/commands/AdminUpdateAuthEventFeedbackCommand.js +4 -4
- package/dist-cjs/commands/AdminUpdateDeviceStatusCommand.js +4 -4
- package/dist-cjs/commands/AdminUpdateUserAttributesCommand.js +4 -4
- package/dist-cjs/commands/AdminUserGlobalSignOutCommand.js +4 -4
- package/dist-cjs/commands/AssociateSoftwareTokenCommand.js +4 -4
- package/dist-cjs/commands/ChangePasswordCommand.js +3 -3
- package/dist-cjs/commands/ConfirmDeviceCommand.js +4 -4
- package/dist-cjs/commands/ConfirmForgotPasswordCommand.js +3 -3
- package/dist-cjs/commands/ConfirmSignUpCommand.js +3 -3
- package/dist-cjs/commands/CreateGroupCommand.js +4 -4
- package/dist-cjs/commands/CreateIdentityProviderCommand.js +4 -4
- package/dist-cjs/commands/CreateResourceServerCommand.js +4 -4
- package/dist-cjs/commands/CreateUserImportJobCommand.js +4 -4
- package/dist-cjs/commands/CreateUserPoolClientCommand.js +4 -4
- package/dist-cjs/commands/CreateUserPoolCommand.js +4 -4
- package/dist-cjs/commands/CreateUserPoolDomainCommand.js +4 -4
- package/dist-cjs/commands/DeleteGroupCommand.js +4 -4
- package/dist-cjs/commands/DeleteIdentityProviderCommand.js +4 -4
- package/dist-cjs/commands/DeleteResourceServerCommand.js +4 -4
- package/dist-cjs/commands/DeleteUserAttributesCommand.js +3 -3
- package/dist-cjs/commands/DeleteUserCommand.js +3 -3
- package/dist-cjs/commands/DeleteUserPoolClientCommand.js +4 -4
- package/dist-cjs/commands/DeleteUserPoolCommand.js +4 -4
- package/dist-cjs/commands/DeleteUserPoolDomainCommand.js +4 -4
- package/dist-cjs/commands/DescribeIdentityProviderCommand.js +4 -4
- package/dist-cjs/commands/DescribeResourceServerCommand.js +4 -4
- package/dist-cjs/commands/DescribeRiskConfigurationCommand.js +4 -4
- package/dist-cjs/commands/DescribeUserImportJobCommand.js +4 -4
- package/dist-cjs/commands/DescribeUserPoolClientCommand.js +4 -4
- package/dist-cjs/commands/DescribeUserPoolCommand.js +4 -4
- package/dist-cjs/commands/DescribeUserPoolDomainCommand.js +4 -4
- package/dist-cjs/commands/ForgetDeviceCommand.js +4 -4
- package/dist-cjs/commands/ForgotPasswordCommand.js +3 -3
- package/dist-cjs/commands/GetCSVHeaderCommand.js +4 -4
- package/dist-cjs/commands/GetDeviceCommand.js +4 -4
- package/dist-cjs/commands/GetGroupCommand.js +4 -4
- package/dist-cjs/commands/GetIdentityProviderByIdentifierCommand.js +4 -4
- package/dist-cjs/commands/GetSigningCertificateCommand.js +4 -4
- package/dist-cjs/commands/GetUICustomizationCommand.js +4 -4
- package/dist-cjs/commands/GetUserAttributeVerificationCodeCommand.js +3 -3
- package/dist-cjs/commands/GetUserCommand.js +3 -3
- package/dist-cjs/commands/GetUserPoolMfaConfigCommand.js +4 -4
- package/dist-cjs/commands/GlobalSignOutCommand.js +4 -4
- package/dist-cjs/commands/InitiateAuthCommand.js +3 -3
- package/dist-cjs/commands/ListDevicesCommand.js +4 -4
- package/dist-cjs/commands/ListGroupsCommand.js +4 -4
- package/dist-cjs/commands/ListIdentityProvidersCommand.js +4 -4
- package/dist-cjs/commands/ListResourceServersCommand.js +4 -4
- package/dist-cjs/commands/ListTagsForResourceCommand.js +4 -4
- package/dist-cjs/commands/ListUserImportJobsCommand.js +4 -4
- package/dist-cjs/commands/ListUserPoolClientsCommand.js +4 -4
- package/dist-cjs/commands/ListUserPoolsCommand.js +4 -4
- package/dist-cjs/commands/ListUsersCommand.js +4 -4
- package/dist-cjs/commands/ListUsersInGroupCommand.js +4 -4
- package/dist-cjs/commands/ResendConfirmationCodeCommand.js +3 -3
- package/dist-cjs/commands/RespondToAuthChallengeCommand.js +3 -3
- package/dist-cjs/commands/RevokeTokenCommand.js +4 -4
- package/dist-cjs/commands/SetRiskConfigurationCommand.js +4 -4
- package/dist-cjs/commands/SetUICustomizationCommand.js +4 -4
- package/dist-cjs/commands/SetUserMFAPreferenceCommand.js +4 -4
- package/dist-cjs/commands/SetUserPoolMfaConfigCommand.js +4 -4
- package/dist-cjs/commands/SetUserSettingsCommand.js +3 -3
- package/dist-cjs/commands/SignUpCommand.js +3 -3
- package/dist-cjs/commands/StartUserImportJobCommand.js +4 -4
- package/dist-cjs/commands/StopUserImportJobCommand.js +4 -4
- package/dist-cjs/commands/TagResourceCommand.js +4 -4
- package/dist-cjs/commands/UntagResourceCommand.js +4 -4
- package/dist-cjs/commands/UpdateAuthEventFeedbackCommand.js +4 -4
- package/dist-cjs/commands/UpdateDeviceStatusCommand.js +4 -4
- package/dist-cjs/commands/UpdateGroupCommand.js +4 -4
- package/dist-cjs/commands/UpdateIdentityProviderCommand.js +4 -4
- package/dist-cjs/commands/UpdateResourceServerCommand.js +4 -4
- package/dist-cjs/commands/UpdateUserAttributesCommand.js +3 -3
- package/dist-cjs/commands/UpdateUserPoolClientCommand.js +4 -4
- package/dist-cjs/commands/UpdateUserPoolCommand.js +4 -4
- package/dist-cjs/commands/UpdateUserPoolDomainCommand.js +4 -4
- package/dist-cjs/commands/VerifySoftwareTokenCommand.js +4 -4
- package/dist-cjs/commands/VerifyUserAttributeCommand.js +3 -3
- package/dist-cjs/endpoints.js +1 -1
- package/dist-cjs/protocols/Aws_json1_1.js +447 -448
- package/dist-cjs/runtimeConfig.browser.js +4 -4
- package/dist-cjs/runtimeConfig.js +9 -9
- package/dist-cjs/runtimeConfig.native.js +1 -1
- package/dist-es/CognitoIdentityProvider.js +101 -101
- package/dist-es/pagination/AdminListGroupsForUserPaginator.js +4 -4
- package/dist-es/pagination/AdminListUserAuthEventsPaginator.js +4 -4
- package/dist-es/pagination/ListGroupsPaginator.js +4 -4
- package/dist-es/pagination/ListIdentityProvidersPaginator.js +4 -4
- package/dist-es/pagination/ListResourceServersPaginator.js +4 -4
- package/dist-es/pagination/ListUserPoolClientsPaginator.js +4 -4
- package/dist-es/pagination/ListUserPoolsPaginator.js +4 -4
- package/dist-es/pagination/ListUsersInGroupPaginator.js +4 -4
- package/dist-es/pagination/ListUsersPaginator.js +4 -4
- package/dist-es/protocols/Aws_json1_1.js +7 -10
- package/dist-types/CognitoIdentityProvider.d.ts +261 -250
- package/dist-types/CognitoIdentityProviderClient.d.ts +2 -2
- package/dist-types/commands/AdminCreateUserCommand.d.ts +18 -16
- package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +7 -4
- package/dist-types/commands/AdminInitiateAuthCommand.d.ts +17 -16
- package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +17 -17
- package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +17 -16
- package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +17 -16
- package/dist-types/commands/CreateUserPoolCommand.d.ts +17 -17
- package/dist-types/commands/ForgotPasswordCommand.d.ts +17 -17
- package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +17 -17
- package/dist-types/commands/InitiateAuthCommand.d.ts +17 -16
- package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +17 -17
- package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +17 -16
- package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +15 -14
- package/dist-types/commands/SignUpCommand.d.ts +17 -17
- package/dist-types/commands/UpdateUserAttributesCommand.d.ts +17 -17
- package/dist-types/commands/UpdateUserPoolCommand.d.ts +17 -17
- package/dist-types/models/models_0.d.ts +352 -213
- package/dist-types/models/models_1.d.ts +21 -12
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +3 -3
- package/dist-types/ts3.4/CognitoIdentityProviderClient.d.ts +2 -2
- package/dist-types/ts3.4/models/models_0.d.ts +2 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +3 -3
- package/package.json +34 -34
|
@@ -132,22 +132,24 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
132
132
|
* <p>If <code>MessageAction</code> isn't set, the default is to send a welcome message via email or phone (SMS).</p>
|
|
133
133
|
*
|
|
134
134
|
*
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
*
|
|
142
|
-
* might
|
|
143
|
-
*
|
|
144
|
-
*
|
|
145
|
-
*
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
*
|
|
149
|
-
*
|
|
150
|
-
*
|
|
135
|
+
*
|
|
136
|
+
* <note>
|
|
137
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
138
|
+
* require you to register an origination phone number before you can send SMS messages
|
|
139
|
+
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
140
|
+
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
|
|
141
|
+
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
142
|
+
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
143
|
+
* in.</p>
|
|
144
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
|
|
145
|
+
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
146
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
147
|
+
* mode</a>
|
|
148
|
+
* </i>, you can send messages only to verified phone
|
|
149
|
+
* numbers. After you test your app while in the sandbox environment, you can move out
|
|
150
|
+
* 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
|
|
151
|
+
* Developer Guide</i>.</p>
|
|
152
|
+
* </note>
|
|
151
153
|
*
|
|
152
154
|
* <p>This message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for
|
|
153
155
|
* user name and temporary password.</p>
|
|
@@ -174,10 +176,13 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
174
176
|
adminDeleteUserAttributes(args: AdminDeleteUserAttributesCommandInput, cb: (err: any, data?: AdminDeleteUserAttributesCommandOutput) => void): void;
|
|
175
177
|
adminDeleteUserAttributes(args: AdminDeleteUserAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminDeleteUserAttributesCommandOutput) => void): void;
|
|
176
178
|
/**
|
|
177
|
-
* <p>
|
|
178
|
-
*
|
|
179
|
-
*
|
|
180
|
-
*
|
|
179
|
+
* <p>Prevents the user from signing in with the specified external (SAML or social)
|
|
180
|
+
* identity provider. If the user that you want to deactivate is a Amazon Cognito user pools native
|
|
181
|
+
* username + password user, they can't use their password to sign in. If the user to
|
|
182
|
+
* deactivate is a linked external identity provider (IdP) user, any link between that user
|
|
183
|
+
* and an existing user is removed. When the external user signs in again, and the user is
|
|
184
|
+
* no longer attached to the previously linked <code>DestinationUser</code>, the user must
|
|
185
|
+
* create a new user account. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html">AdminLinkProviderForUser</a>.</p>
|
|
181
186
|
* <p>This action is enabled only for admin access and requires developer credentials.</p>
|
|
182
187
|
* <p>The <code>ProviderName</code> must match the value specified when creating an IdP for the pool. </p>
|
|
183
188
|
* <p>To deactivate a native username + password user, the <code>ProviderName</code> value must be <code>Cognito</code> and the <code>ProviderAttributeName</code> must be <code>Cognito_Subject</code>.
|
|
@@ -231,22 +236,23 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
231
236
|
* <p>Initiates the authentication flow, as an administrator.</p>
|
|
232
237
|
*
|
|
233
238
|
*
|
|
234
|
-
*
|
|
235
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
236
|
-
*
|
|
237
|
-
*
|
|
238
|
-
*
|
|
239
|
-
*
|
|
240
|
-
*
|
|
241
|
-
*
|
|
242
|
-
*
|
|
243
|
-
*
|
|
244
|
-
*
|
|
245
|
-
*
|
|
246
|
-
*
|
|
247
|
-
*
|
|
248
|
-
*
|
|
249
|
-
*
|
|
239
|
+
* <note>
|
|
240
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
241
|
+
* require you to register an origination phone number before you can send SMS messages
|
|
242
|
+
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
243
|
+
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
|
|
244
|
+
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
245
|
+
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
246
|
+
* in.</p>
|
|
247
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
|
|
248
|
+
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
249
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
250
|
+
* mode</a>
|
|
251
|
+
* </i>, you can send messages only to verified phone
|
|
252
|
+
* numbers. After you test your app while in the sandbox environment, you can move out
|
|
253
|
+
* 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
|
|
254
|
+
* Developer Guide</i>.</p>
|
|
255
|
+
* </note>
|
|
250
256
|
*
|
|
251
257
|
* <p>Calling this action requires developer credentials.</p>
|
|
252
258
|
*/
|
|
@@ -307,23 +313,23 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
307
313
|
* email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user
|
|
308
314
|
* with the code to change their password.</p>
|
|
309
315
|
*
|
|
310
|
-
*
|
|
311
|
-
*
|
|
312
|
-
*
|
|
313
|
-
*
|
|
314
|
-
*
|
|
315
|
-
*
|
|
316
|
-
*
|
|
317
|
-
*
|
|
318
|
-
*
|
|
319
|
-
* <i>
|
|
320
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
321
|
-
*
|
|
322
|
-
*
|
|
323
|
-
*
|
|
324
|
-
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
|
|
325
|
-
*
|
|
326
|
-
*
|
|
316
|
+
* <note>
|
|
317
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
318
|
+
* require you to register an origination phone number before you can send SMS messages
|
|
319
|
+
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
320
|
+
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
|
|
321
|
+
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
322
|
+
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
323
|
+
* in.</p>
|
|
324
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
|
|
325
|
+
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
326
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
327
|
+
* mode</a>
|
|
328
|
+
* </i>, you can send messages only to verified phone
|
|
329
|
+
* numbers. After you test your app while in the sandbox environment, you can move out
|
|
330
|
+
* 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
|
|
331
|
+
* Developer Guide</i>.</p>
|
|
332
|
+
* </note>
|
|
327
333
|
*
|
|
328
334
|
* <p>Calling this action requires developer credentials.</p>
|
|
329
335
|
*/
|
|
@@ -333,22 +339,23 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
333
339
|
/**
|
|
334
340
|
* <p>Responds to an authentication challenge, as an administrator.</p>
|
|
335
341
|
*
|
|
336
|
-
*
|
|
337
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
338
|
-
*
|
|
339
|
-
*
|
|
340
|
-
*
|
|
341
|
-
*
|
|
342
|
-
*
|
|
343
|
-
*
|
|
344
|
-
*
|
|
345
|
-
*
|
|
346
|
-
*
|
|
347
|
-
*
|
|
348
|
-
*
|
|
349
|
-
*
|
|
350
|
-
*
|
|
351
|
-
*
|
|
342
|
+
* <note>
|
|
343
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
344
|
+
* require you to register an origination phone number before you can send SMS messages
|
|
345
|
+
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
346
|
+
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
|
|
347
|
+
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
348
|
+
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
349
|
+
* in.</p>
|
|
350
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
|
|
351
|
+
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
352
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
353
|
+
* mode</a>
|
|
354
|
+
* </i>, you can send messages only to verified phone
|
|
355
|
+
* numbers. After you test your app while in the sandbox environment, you can move out
|
|
356
|
+
* 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
|
|
357
|
+
* Developer Guide</i>.</p>
|
|
358
|
+
* </note>
|
|
352
359
|
*
|
|
353
360
|
* <p>Calling this action requires developer credentials.</p>
|
|
354
361
|
*/
|
|
@@ -401,22 +408,23 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
401
408
|
* <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>
|
|
402
409
|
* <p>In addition to updating user attributes, this API can also be used to mark phone and email as verified.</p>
|
|
403
410
|
*
|
|
404
|
-
*
|
|
405
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
406
|
-
*
|
|
407
|
-
*
|
|
408
|
-
*
|
|
409
|
-
*
|
|
410
|
-
*
|
|
411
|
-
*
|
|
412
|
-
*
|
|
413
|
-
*
|
|
414
|
-
*
|
|
415
|
-
*
|
|
416
|
-
*
|
|
417
|
-
*
|
|
418
|
-
*
|
|
419
|
-
*
|
|
411
|
+
* <note>
|
|
412
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
413
|
+
* require you to register an origination phone number before you can send SMS messages
|
|
414
|
+
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
415
|
+
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
|
|
416
|
+
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
417
|
+
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
418
|
+
* in.</p>
|
|
419
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
|
|
420
|
+
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
421
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
422
|
+
* mode</a>
|
|
423
|
+
* </i>, you can send messages only to verified phone
|
|
424
|
+
* numbers. After you test your app while in the sandbox environment, you can move out
|
|
425
|
+
* 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
|
|
426
|
+
* Developer Guide</i>.</p>
|
|
427
|
+
* </note>
|
|
420
428
|
*
|
|
421
429
|
* <p>Calling this action requires developer credentials.</p>
|
|
422
430
|
*/
|
|
@@ -494,23 +502,23 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
494
502
|
/**
|
|
495
503
|
* <p>Creates a new Amazon Cognito user pool and sets the password policy for the pool.</p>
|
|
496
504
|
*
|
|
497
|
-
*
|
|
498
|
-
*
|
|
499
|
-
*
|
|
500
|
-
*
|
|
501
|
-
*
|
|
502
|
-
*
|
|
503
|
-
*
|
|
504
|
-
*
|
|
505
|
-
*
|
|
506
|
-
* <i>
|
|
507
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
508
|
-
*
|
|
509
|
-
*
|
|
510
|
-
*
|
|
511
|
-
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
|
|
512
|
-
*
|
|
513
|
-
*
|
|
505
|
+
* <note>
|
|
506
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
507
|
+
* require you to register an origination phone number before you can send SMS messages
|
|
508
|
+
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
509
|
+
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
|
|
510
|
+
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
511
|
+
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
512
|
+
* in.</p>
|
|
513
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
|
|
514
|
+
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
515
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
516
|
+
* mode</a>
|
|
517
|
+
* </i>, you can send messages only to verified phone
|
|
518
|
+
* numbers. After you test your app while in the sandbox environment, you can move out
|
|
519
|
+
* 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
|
|
520
|
+
* Developer Guide</i>.</p>
|
|
521
|
+
* </note>
|
|
514
522
|
*/
|
|
515
523
|
createUserPool(args: CreateUserPoolCommandInput, options?: __HttpHandlerOptions): Promise<CreateUserPoolCommandOutput>;
|
|
516
524
|
createUserPool(args: CreateUserPoolCommandInput, cb: (err: any, data?: CreateUserPoolCommandOutput) => void): void;
|
|
@@ -636,23 +644,23 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
636
644
|
* call <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html">ConfirmForgotPassword</a>.
|
|
637
645
|
* </p>
|
|
638
646
|
*
|
|
639
|
-
*
|
|
640
|
-
*
|
|
641
|
-
*
|
|
642
|
-
*
|
|
643
|
-
*
|
|
644
|
-
*
|
|
645
|
-
*
|
|
646
|
-
*
|
|
647
|
-
*
|
|
648
|
-
* <i>
|
|
649
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
650
|
-
*
|
|
651
|
-
*
|
|
652
|
-
*
|
|
653
|
-
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
|
|
654
|
-
*
|
|
655
|
-
*
|
|
647
|
+
* <note>
|
|
648
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
649
|
+
* require you to register an origination phone number before you can send SMS messages
|
|
650
|
+
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
651
|
+
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
|
|
652
|
+
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
653
|
+
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
654
|
+
* in.</p>
|
|
655
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
|
|
656
|
+
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
657
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
658
|
+
* mode</a>
|
|
659
|
+
* </i>, you can send messages only to verified phone
|
|
660
|
+
* numbers. After you test your app while in the sandbox environment, you can move out
|
|
661
|
+
* 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
|
|
662
|
+
* Developer Guide</i>.</p>
|
|
663
|
+
* </note>
|
|
656
664
|
*/
|
|
657
665
|
forgotPassword(args: ForgotPasswordCommandInput, options?: __HttpHandlerOptions): Promise<ForgotPasswordCommandOutput>;
|
|
658
666
|
forgotPassword(args: ForgotPasswordCommandInput, cb: (err: any, data?: ForgotPasswordCommandOutput) => void): void;
|
|
@@ -704,23 +712,23 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
704
712
|
/**
|
|
705
713
|
* <p>Gets the user attribute verification code for the specified attribute name.</p>
|
|
706
714
|
*
|
|
707
|
-
*
|
|
708
|
-
*
|
|
709
|
-
*
|
|
710
|
-
*
|
|
711
|
-
*
|
|
712
|
-
*
|
|
713
|
-
*
|
|
714
|
-
*
|
|
715
|
-
*
|
|
716
|
-
* <i>
|
|
717
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
718
|
-
*
|
|
719
|
-
*
|
|
720
|
-
*
|
|
721
|
-
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
|
|
722
|
-
*
|
|
723
|
-
*
|
|
715
|
+
* <note>
|
|
716
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
717
|
+
* require you to register an origination phone number before you can send SMS messages
|
|
718
|
+
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
719
|
+
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
|
|
720
|
+
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
721
|
+
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
722
|
+
* in.</p>
|
|
723
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
|
|
724
|
+
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
725
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
726
|
+
* mode</a>
|
|
727
|
+
* </i>, you can send messages only to verified phone
|
|
728
|
+
* numbers. After you test your app while in the sandbox environment, you can move out
|
|
729
|
+
* 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
|
|
730
|
+
* Developer Guide</i>.</p>
|
|
731
|
+
* </note>
|
|
724
732
|
*/
|
|
725
733
|
getUserAttributeVerificationCode(args: GetUserAttributeVerificationCodeCommandInput, options?: __HttpHandlerOptions): Promise<GetUserAttributeVerificationCodeCommandOutput>;
|
|
726
734
|
getUserAttributeVerificationCode(args: GetUserAttributeVerificationCodeCommandInput, cb: (err: any, data?: GetUserAttributeVerificationCodeCommandOutput) => void): void;
|
|
@@ -741,22 +749,23 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
741
749
|
/**
|
|
742
750
|
* <p>Initiates the authentication flow.</p>
|
|
743
751
|
*
|
|
744
|
-
*
|
|
745
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
746
|
-
*
|
|
747
|
-
*
|
|
748
|
-
*
|
|
749
|
-
*
|
|
750
|
-
*
|
|
751
|
-
*
|
|
752
|
-
*
|
|
753
|
-
*
|
|
754
|
-
*
|
|
755
|
-
*
|
|
756
|
-
*
|
|
757
|
-
*
|
|
758
|
-
*
|
|
759
|
-
*
|
|
752
|
+
* <note>
|
|
753
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
754
|
+
* require you to register an origination phone number before you can send SMS messages
|
|
755
|
+
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
756
|
+
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
|
|
757
|
+
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
758
|
+
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
759
|
+
* in.</p>
|
|
760
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
|
|
761
|
+
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
762
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
763
|
+
* mode</a>
|
|
764
|
+
* </i>, you can send messages only to verified phone
|
|
765
|
+
* numbers. After you test your app while in the sandbox environment, you can move out
|
|
766
|
+
* 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
|
|
767
|
+
* Developer Guide</i>.</p>
|
|
768
|
+
* </note>
|
|
760
769
|
*/
|
|
761
770
|
initiateAuth(args: InitiateAuthCommandInput, options?: __HttpHandlerOptions): Promise<InitiateAuthCommandOutput>;
|
|
762
771
|
initiateAuth(args: InitiateAuthCommandInput, cb: (err: any, data?: InitiateAuthCommandOutput) => void): void;
|
|
@@ -828,23 +837,23 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
828
837
|
/**
|
|
829
838
|
* <p>Resends the confirmation (for confirmation of registration) to a specific user in the user pool.</p>
|
|
830
839
|
*
|
|
831
|
-
*
|
|
832
|
-
*
|
|
833
|
-
*
|
|
834
|
-
*
|
|
835
|
-
*
|
|
836
|
-
*
|
|
837
|
-
*
|
|
838
|
-
*
|
|
839
|
-
*
|
|
840
|
-
* <i>
|
|
841
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
842
|
-
*
|
|
843
|
-
*
|
|
844
|
-
*
|
|
845
|
-
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
|
|
846
|
-
*
|
|
847
|
-
*
|
|
840
|
+
* <note>
|
|
841
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
842
|
+
* require you to register an origination phone number before you can send SMS messages
|
|
843
|
+
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
844
|
+
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
|
|
845
|
+
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
846
|
+
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
847
|
+
* in.</p>
|
|
848
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
|
|
849
|
+
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
850
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
851
|
+
* mode</a>
|
|
852
|
+
* </i>, you can send messages only to verified phone
|
|
853
|
+
* numbers. After you test your app while in the sandbox environment, you can move out
|
|
854
|
+
* 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
|
|
855
|
+
* Developer Guide</i>.</p>
|
|
856
|
+
* </note>
|
|
848
857
|
*/
|
|
849
858
|
resendConfirmationCode(args: ResendConfirmationCodeCommandInput, options?: __HttpHandlerOptions): Promise<ResendConfirmationCodeCommandOutput>;
|
|
850
859
|
resendConfirmationCode(args: ResendConfirmationCodeCommandInput, cb: (err: any, data?: ResendConfirmationCodeCommandOutput) => void): void;
|
|
@@ -852,22 +861,23 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
852
861
|
/**
|
|
853
862
|
* <p>Responds to the authentication challenge.</p>
|
|
854
863
|
*
|
|
855
|
-
*
|
|
856
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
857
|
-
*
|
|
858
|
-
*
|
|
859
|
-
*
|
|
860
|
-
*
|
|
861
|
-
*
|
|
862
|
-
*
|
|
863
|
-
*
|
|
864
|
-
*
|
|
865
|
-
*
|
|
866
|
-
*
|
|
867
|
-
*
|
|
868
|
-
*
|
|
869
|
-
*
|
|
870
|
-
*
|
|
864
|
+
* <note>
|
|
865
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
866
|
+
* require you to register an origination phone number before you can send SMS messages
|
|
867
|
+
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
868
|
+
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
|
|
869
|
+
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
870
|
+
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
871
|
+
* in.</p>
|
|
872
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
|
|
873
|
+
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
874
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
875
|
+
* mode</a>
|
|
876
|
+
* </i>, you can send messages only to verified phone
|
|
877
|
+
* numbers. After you test your app while in the sandbox environment, you can move out
|
|
878
|
+
* 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
|
|
879
|
+
* Developer Guide</i>.</p>
|
|
880
|
+
* </note>
|
|
871
881
|
*/
|
|
872
882
|
respondToAuthChallenge(args: RespondToAuthChallengeCommandInput, options?: __HttpHandlerOptions): Promise<RespondToAuthChallengeCommandOutput>;
|
|
873
883
|
respondToAuthChallenge(args: RespondToAuthChallengeCommandInput, cb: (err: any, data?: RespondToAuthChallengeCommandOutput) => void): void;
|
|
@@ -912,20 +922,21 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
912
922
|
* <p>Sets the user pool multi-factor authentication (MFA) configuration.</p>
|
|
913
923
|
*
|
|
914
924
|
* <note>
|
|
915
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
916
|
-
*
|
|
917
|
-
*
|
|
918
|
-
*
|
|
919
|
-
*
|
|
920
|
-
*
|
|
921
|
-
*
|
|
922
|
-
*
|
|
923
|
-
*
|
|
924
|
-
*
|
|
925
|
-
*
|
|
926
|
-
*
|
|
927
|
-
*
|
|
928
|
-
*
|
|
925
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
926
|
+
* require you to register an origination phone number before you can send SMS messages
|
|
927
|
+
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
928
|
+
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
|
|
929
|
+
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
930
|
+
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
931
|
+
* in.</p>
|
|
932
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
|
|
933
|
+
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
934
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
935
|
+
* mode</a>
|
|
936
|
+
* </i>, you can send messages only to verified phone
|
|
937
|
+
* numbers. After you test your app while in the sandbox environment, you can move out
|
|
938
|
+
* 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
|
|
939
|
+
* Developer Guide</i>.</p>
|
|
929
940
|
* </note>
|
|
930
941
|
*/
|
|
931
942
|
setUserPoolMfaConfig(args: SetUserPoolMfaConfigCommandInput, options?: __HttpHandlerOptions): Promise<SetUserPoolMfaConfigCommandOutput>;
|
|
@@ -942,23 +953,23 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
942
953
|
/**
|
|
943
954
|
* <p>Registers the user in the specified user pool and creates a user name, password, and user attributes.</p>
|
|
944
955
|
*
|
|
945
|
-
*
|
|
946
|
-
*
|
|
947
|
-
*
|
|
948
|
-
*
|
|
949
|
-
*
|
|
950
|
-
*
|
|
951
|
-
*
|
|
952
|
-
*
|
|
953
|
-
*
|
|
954
|
-
* <i>
|
|
955
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
956
|
-
*
|
|
957
|
-
*
|
|
958
|
-
*
|
|
959
|
-
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
|
|
960
|
-
*
|
|
961
|
-
*
|
|
956
|
+
* <note>
|
|
957
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
958
|
+
* require you to register an origination phone number before you can send SMS messages
|
|
959
|
+
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
960
|
+
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
|
|
961
|
+
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
962
|
+
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
963
|
+
* in.</p>
|
|
964
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
|
|
965
|
+
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
966
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
967
|
+
* mode</a>
|
|
968
|
+
* </i>, you can send messages only to verified phone
|
|
969
|
+
* numbers. After you test your app while in the sandbox environment, you can move out
|
|
970
|
+
* 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
|
|
971
|
+
* Developer Guide</i>.</p>
|
|
972
|
+
* </note>
|
|
962
973
|
*/
|
|
963
974
|
signUp(args: SignUpCommandInput, options?: __HttpHandlerOptions): Promise<SignUpCommandOutput>;
|
|
964
975
|
signUp(args: SignUpCommandInput, cb: (err: any, data?: SignUpCommandOutput) => void): void;
|
|
@@ -1031,23 +1042,23 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
1031
1042
|
/**
|
|
1032
1043
|
* <p>Allows a user to update a specific attribute (one at a time).</p>
|
|
1033
1044
|
*
|
|
1034
|
-
*
|
|
1035
|
-
*
|
|
1036
|
-
*
|
|
1037
|
-
*
|
|
1038
|
-
*
|
|
1039
|
-
*
|
|
1040
|
-
*
|
|
1041
|
-
*
|
|
1042
|
-
*
|
|
1043
|
-
* <i>
|
|
1044
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
1045
|
-
*
|
|
1046
|
-
*
|
|
1047
|
-
*
|
|
1048
|
-
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
|
|
1049
|
-
*
|
|
1050
|
-
*
|
|
1045
|
+
* <note>
|
|
1046
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
1047
|
+
* require you to register an origination phone number before you can send SMS messages
|
|
1048
|
+
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
1049
|
+
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
|
|
1050
|
+
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
1051
|
+
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
1052
|
+
* in.</p>
|
|
1053
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
|
|
1054
|
+
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
1055
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
1056
|
+
* mode</a>
|
|
1057
|
+
* </i>, you can send messages only to verified phone
|
|
1058
|
+
* numbers. After you test your app while in the sandbox environment, you can move out
|
|
1059
|
+
* 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
|
|
1060
|
+
* Developer Guide</i>.</p>
|
|
1061
|
+
* </note>
|
|
1051
1062
|
*/
|
|
1052
1063
|
updateUserAttributes(args: UpdateUserAttributesCommandInput, options?: __HttpHandlerOptions): Promise<UpdateUserAttributesCommandOutput>;
|
|
1053
1064
|
updateUserAttributes(args: UpdateUserAttributesCommandInput, cb: (err: any, data?: UpdateUserAttributesCommandOutput) => void): void;
|
|
@@ -1057,23 +1068,23 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
1057
1068
|
* <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>.
|
|
1058
1069
|
* If you don't provide a value for an attribute, it will be set to the default value.</p>
|
|
1059
1070
|
*
|
|
1060
|
-
*
|
|
1061
|
-
*
|
|
1062
|
-
*
|
|
1063
|
-
*
|
|
1064
|
-
*
|
|
1065
|
-
*
|
|
1066
|
-
*
|
|
1067
|
-
*
|
|
1068
|
-
*
|
|
1069
|
-
* <i>
|
|
1070
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
1071
|
-
*
|
|
1072
|
-
*
|
|
1073
|
-
*
|
|
1074
|
-
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
|
|
1075
|
-
*
|
|
1076
|
-
*
|
|
1071
|
+
* <note>
|
|
1072
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
1073
|
+
* require you to register an origination phone number before you can send SMS messages
|
|
1074
|
+
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
|
|
1075
|
+
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
|
|
1076
|
+
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
1077
|
+
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
1078
|
+
* in.</p>
|
|
1079
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
|
|
1080
|
+
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
1081
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
1082
|
+
* mode</a>
|
|
1083
|
+
* </i>, you can send messages only to verified phone
|
|
1084
|
+
* numbers. After you test your app while in the sandbox environment, you can move out
|
|
1085
|
+
* 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
|
|
1086
|
+
* Developer Guide</i>.</p>
|
|
1087
|
+
* </note>
|
|
1077
1088
|
*/
|
|
1078
1089
|
updateUserPool(args: UpdateUserPoolCommandInput, options?: __HttpHandlerOptions): Promise<UpdateUserPoolCommandOutput>;
|
|
1079
1090
|
updateUserPool(args: UpdateUserPoolCommandInput, cb: (err: any, data?: UpdateUserPoolCommandOutput) => void): void;
|