@aws-sdk/client-cognito-identity-provider 3.48.0 → 3.52.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 +35 -0
- package/README.md +3 -7
- package/dist-types/CognitoIdentityProvider.d.ts +367 -457
- package/dist-types/CognitoIdentityProviderClient.d.ts +3 -7
- package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +1 -2
- package/dist-types/commands/AdminCreateUserCommand.d.ts +20 -23
- package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +1 -2
- package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +14 -28
- package/dist-types/commands/AdminGetUserCommand.d.ts +1 -2
- package/dist-types/commands/AdminInitiateAuthCommand.d.ts +14 -14
- package/dist-types/commands/AdminLinkProviderForUserCommand.d.ts +12 -19
- package/dist-types/commands/AdminListUserAuthEventsCommand.d.ts +1 -2
- package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +20 -24
- package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +14 -14
- package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +3 -5
- package/dist-types/commands/AdminSetUserPasswordCommand.d.ts +5 -10
- package/dist-types/commands/AdminSetUserSettingsCommand.d.ts +3 -3
- package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts +2 -3
- package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +17 -20
- package/dist-types/commands/AdminUserGlobalSignOutCommand.d.ts +2 -3
- package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +6 -10
- package/dist-types/commands/ConfirmDeviceCommand.d.ts +1 -2
- package/dist-types/commands/ConfirmSignUpCommand.d.ts +1 -2
- package/dist-types/commands/CreateResourceServerCommand.d.ts +1 -1
- package/dist-types/commands/CreateUserPoolClientCommand.d.ts +2 -2
- package/dist-types/commands/CreateUserPoolCommand.d.ts +16 -16
- package/dist-types/commands/DescribeUserPoolClientCommand.d.ts +1 -2
- package/dist-types/commands/ForgotPasswordCommand.d.ts +23 -22
- package/dist-types/commands/GetCSVHeaderCommand.d.ts +1 -2
- package/dist-types/commands/GetUICustomizationCommand.d.ts +2 -4
- package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +15 -14
- package/dist-types/commands/GlobalSignOutCommand.d.ts +2 -3
- package/dist-types/commands/InitiateAuthCommand.d.ts +14 -14
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -2
- package/dist-types/commands/ListUserPoolsCommand.d.ts +1 -1
- package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +16 -16
- package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +14 -14
- package/dist-types/commands/RevokeTokenCommand.d.ts +1 -2
- package/dist-types/commands/SetRiskConfigurationCommand.d.ts +2 -5
- package/dist-types/commands/SetUICustomizationCommand.d.ts +7 -12
- package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +6 -9
- package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +17 -17
- package/dist-types/commands/SetUserSettingsCommand.d.ts +2 -3
- package/dist-types/commands/SignUpCommand.d.ts +16 -16
- package/dist-types/commands/TagResourceCommand.d.ts +7 -14
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -2
- package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts +2 -3
- package/dist-types/commands/UpdateResourceServerCommand.d.ts +3 -4
- package/dist-types/commands/UpdateUserAttributesCommand.d.ts +15 -14
- package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +7 -8
- package/dist-types/commands/UpdateUserPoolCommand.d.ts +18 -17
- package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts +11 -20
- package/dist-types/commands/VerifySoftwareTokenCommand.d.ts +2 -3
- package/dist-types/models/models_0.d.ts +1409 -2027
- package/dist-types/models/models_1.d.ts +125 -192
- package/package.json +40 -34
|
@@ -102,13 +102,9 @@ 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
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
* <p>This API reference provides information about user pools in Amazon Cognito User
|
|
109
|
-
* Pools.</p>
|
|
110
|
-
* <p>For more information, see the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html">Amazon Cognito
|
|
111
|
-
* Documentation</a>.</p>
|
|
105
|
+
* <p>Using the Amazon Cognito user pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.</p>
|
|
106
|
+
* <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 Documentation</a>.</p>
|
|
112
108
|
*/
|
|
113
109
|
export declare class CognitoIdentityProvider extends CognitoIdentityProviderClient {
|
|
114
110
|
/**
|
|
@@ -125,8 +121,7 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
125
121
|
adminAddUserToGroup(args: AdminAddUserToGroupCommandInput, cb: (err: any, data?: AdminAddUserToGroupCommandOutput) => void): void;
|
|
126
122
|
adminAddUserToGroup(args: AdminAddUserToGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminAddUserToGroupCommandOutput) => void): void;
|
|
127
123
|
/**
|
|
128
|
-
* <p>Confirms user registration as an admin without using a confirmation code. Works on any
|
|
129
|
-
* user.</p>
|
|
124
|
+
* <p>Confirms user registration as an admin without using a confirmation code. Works on any user.</p>
|
|
130
125
|
* <p>Calling this action requires developer credentials.</p>
|
|
131
126
|
*/
|
|
132
127
|
adminConfirmSignUp(args: AdminConfirmSignUpCommandInput, options?: __HttpHandlerOptions): Promise<AdminConfirmSignUpCommandOutput>;
|
|
@@ -134,33 +129,30 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
134
129
|
adminConfirmSignUp(args: AdminConfirmSignUpCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminConfirmSignUpCommandOutput) => void): void;
|
|
135
130
|
/**
|
|
136
131
|
* <p>Creates a new user in the specified user pool.</p>
|
|
137
|
-
* <p>If <code>MessageAction</code>
|
|
138
|
-
*
|
|
132
|
+
* <p>If <code>MessageAction</code> isn't set, the default is to send a welcome message via email or phone (SMS).</p>
|
|
133
|
+
*
|
|
139
134
|
*
|
|
140
135
|
* <note>
|
|
141
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021,
|
|
142
|
-
*
|
|
143
|
-
*
|
|
144
|
-
*
|
|
145
|
-
*
|
|
146
|
-
*
|
|
147
|
-
* in
|
|
148
|
-
*
|
|
149
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
150
|
-
*
|
|
151
|
-
*
|
|
152
|
-
*
|
|
153
|
-
*
|
|
154
|
-
*
|
|
136
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
|
|
137
|
+
* origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
|
|
138
|
+
* register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
|
|
139
|
+
* automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
|
|
140
|
+
* or sign in.</p>
|
|
141
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
|
|
142
|
+
* might place your account in SMS sandbox. In
|
|
143
|
+
* <i>
|
|
144
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
|
|
145
|
+
* </i>, you will have
|
|
146
|
+
* limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
|
|
147
|
+
* out of the SMS sandbox and into production. For more information, see
|
|
148
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
|
|
149
|
+
* message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
155
150
|
* </note>
|
|
156
151
|
*
|
|
157
|
-
* <p>This message is based on a template that you configured in your call to create or
|
|
158
|
-
*
|
|
159
|
-
*
|
|
160
|
-
* <p>
|
|
161
|
-
* <code>MessageAction</code> parameter, and Amazon Cognito will not 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>
|
|
152
|
+
* <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
|
+
* user name and temporary password.</p>
|
|
154
|
+
* <p>Alternatively, you can call <code>AdminCreateUser</code> with <code>SUPPRESS</code> for the <code>MessageAction</code> parameter, and Amazon Cognito won't send any email. </p>
|
|
155
|
+
* <p>In either case, the user will be in the <code>FORCE_CHANGE_PASSWORD</code> state until they sign in and change their password.</p>
|
|
164
156
|
* <p>
|
|
165
157
|
* <code>AdminCreateUser</code> requires developer credentials.</p>
|
|
166
158
|
*/
|
|
@@ -175,42 +167,27 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
175
167
|
adminDeleteUser(args: AdminDeleteUserCommandInput, cb: (err: any, data?: AdminDeleteUserCommandOutput) => void): void;
|
|
176
168
|
adminDeleteUser(args: AdminDeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminDeleteUserCommandOutput) => void): void;
|
|
177
169
|
/**
|
|
178
|
-
* <p>Deletes the user attributes in a user pool as an administrator. Works on any
|
|
179
|
-
* user.</p>
|
|
170
|
+
* <p>Deletes the user attributes in a user pool as an administrator. Works on any user.</p>
|
|
180
171
|
* <p>Calling this action requires developer credentials.</p>
|
|
181
172
|
*/
|
|
182
173
|
adminDeleteUserAttributes(args: AdminDeleteUserAttributesCommandInput, options?: __HttpHandlerOptions): Promise<AdminDeleteUserAttributesCommandOutput>;
|
|
183
174
|
adminDeleteUserAttributes(args: AdminDeleteUserAttributesCommandInput, cb: (err: any, data?: AdminDeleteUserAttributesCommandOutput) => void): void;
|
|
184
175
|
adminDeleteUserAttributes(args: AdminDeleteUserAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminDeleteUserAttributesCommandOutput) => void): void;
|
|
185
176
|
/**
|
|
186
|
-
* <p>Disables the user from signing in with the specified external (SAML or social)
|
|
187
|
-
*
|
|
188
|
-
*
|
|
189
|
-
*
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
*
|
|
193
|
-
*
|
|
194
|
-
*
|
|
195
|
-
*
|
|
196
|
-
*
|
|
197
|
-
*
|
|
198
|
-
*
|
|
199
|
-
*
|
|
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 identity providers. The <code>ProviderAttributeValue</code> must always be the
|
|
203
|
-
* exact subject 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>
|
|
177
|
+
* <p>Disables the user from signing in with the specified external (SAML or social) identity provider. If the user to disable is a Amazon Cognito User Pools native username + password user,
|
|
178
|
+
* they aren't permitted to use their password to sign in. If the user to deactivate is a linked external identity provider (IdP) user, any link between that user and an existing
|
|
179
|
+
* user is removed. The next time the external user (no longer attached to the previously linked <code>DestinationUser</code>) signs in, they must create a new user account.
|
|
180
|
+
* See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html">AdminLinkProviderForUser</a>.</p>
|
|
181
|
+
* <p>This action is enabled only for admin access and requires developer credentials.</p>
|
|
182
|
+
* <p>The <code>ProviderName</code> must match the value specified when creating an IdP for the pool. </p>
|
|
183
|
+
* <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>.
|
|
184
|
+
* The <code>ProviderAttributeValue</code> must be the name that is used in the user pool for the user.</p>
|
|
185
|
+
* <p>The <code>ProviderAttributeName</code> must always be <code>Cognito_Subject</code> for social identity providers. The <code>ProviderAttributeValue</code> must always be the exact
|
|
186
|
+
* subject that was used when the user was originally linked as a source user.</p>
|
|
187
|
+
* <p>For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign in, the <code>ProviderAttributeName</code> and <code>ProviderAttributeValue</code>
|
|
188
|
+
* must be the same values that were used for the <code>SourceUser</code> when the identities were originally linked using <code> AdminLinkProviderForUser</code> call. (If the linking was done
|
|
189
|
+
* with <code>ProviderAttributeName</code> set to <code>Cognito_Subject</code>, the same applies here). However, if the user has already signed in, the <code>ProviderAttributeName</code> must
|
|
190
|
+
* be <code>Cognito_Subject</code> and <code>ProviderAttributeValue</code> must be the subject of the SAML assertion.</p>
|
|
214
191
|
*/
|
|
215
192
|
adminDisableProviderForUser(args: AdminDisableProviderForUserCommandInput, options?: __HttpHandlerOptions): Promise<AdminDisableProviderForUserCommandOutput>;
|
|
216
193
|
adminDisableProviderForUser(args: AdminDisableProviderForUserCommandInput, cb: (err: any, data?: AdminDisableProviderForUserCommandOutput) => void): void;
|
|
@@ -244,8 +221,7 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
244
221
|
adminGetDevice(args: AdminGetDeviceCommandInput, cb: (err: any, data?: AdminGetDeviceCommandOutput) => void): void;
|
|
245
222
|
adminGetDevice(args: AdminGetDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminGetDeviceCommandOutput) => void): void;
|
|
246
223
|
/**
|
|
247
|
-
* <p>Gets the specified user by user name in a user pool as an administrator. Works on any
|
|
248
|
-
* user.</p>
|
|
224
|
+
* <p>Gets the specified user by user name in a user pool as an administrator. Works on any user.</p>
|
|
249
225
|
* <p>Calling this action requires developer credentials.</p>
|
|
250
226
|
*/
|
|
251
227
|
adminGetUser(args: AdminGetUserCommandInput, options?: __HttpHandlerOptions): Promise<AdminGetUserCommandOutput>;
|
|
@@ -256,20 +232,20 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
256
232
|
*
|
|
257
233
|
*
|
|
258
234
|
* <note>
|
|
259
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021,
|
|
260
|
-
*
|
|
261
|
-
*
|
|
262
|
-
*
|
|
263
|
-
*
|
|
264
|
-
*
|
|
265
|
-
* in
|
|
266
|
-
*
|
|
267
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
268
|
-
*
|
|
269
|
-
*
|
|
270
|
-
*
|
|
271
|
-
*
|
|
272
|
-
*
|
|
235
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
|
|
236
|
+
* origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
|
|
237
|
+
* register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
|
|
238
|
+
* automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
|
|
239
|
+
* or sign in.</p>
|
|
240
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
|
|
241
|
+
* might place your account in SMS sandbox. In
|
|
242
|
+
* <i>
|
|
243
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
|
|
244
|
+
* </i>, you will have
|
|
245
|
+
* limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
|
|
246
|
+
* out of the SMS sandbox and into production. For more information, see
|
|
247
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
|
|
248
|
+
* message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
273
249
|
* </note>
|
|
274
250
|
*
|
|
275
251
|
* <p>Calling this action requires developer credentials.</p>
|
|
@@ -278,27 +254,20 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
278
254
|
adminInitiateAuth(args: AdminInitiateAuthCommandInput, cb: (err: any, data?: AdminInitiateAuthCommandOutput) => void): void;
|
|
279
255
|
adminInitiateAuth(args: AdminInitiateAuthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminInitiateAuthCommandOutput) => void): void;
|
|
280
256
|
/**
|
|
281
|
-
* <p>Links an existing user account in a user pool (<code>DestinationUser</code>) to an
|
|
282
|
-
*
|
|
283
|
-
*
|
|
284
|
-
*
|
|
285
|
-
*
|
|
286
|
-
*
|
|
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, so that when the federated user identity
|
|
289
|
-
* is used, the user signs in as the existing user account. </p>
|
|
290
|
-
* <note>
|
|
257
|
+
* <p>Links an existing user account in a user pool (<code>DestinationUser</code>) to an identity from an external identity provider (<code>SourceUser</code>) based on a specified
|
|
258
|
+
* attribute name and value from the external identity provider. This allows you to create a link from the existing user account to an external federated user identity that has not
|
|
259
|
+
* yet been used to sign in. You can then use the federated user identity to sign in as the existing user account. </p>
|
|
260
|
+
* <p> For example, if there is an existing user with a username and password, this API links that user to a federated user identity. When the user signs in with a federated user
|
|
261
|
+
* identity, they sign in as the existing user account.</p>
|
|
262
|
+
* <note>
|
|
291
263
|
* <p>The maximum number of federated identities linked to a user is 5.</p>
|
|
292
|
-
*
|
|
293
|
-
*
|
|
294
|
-
* <p>Because this API allows a user with an external federated identity to sign in as
|
|
295
|
-
*
|
|
296
|
-
*
|
|
297
|
-
* owner.</p>
|
|
298
|
-
* </important>
|
|
264
|
+
* </note>
|
|
265
|
+
* <important>
|
|
266
|
+
* <p>Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external
|
|
267
|
+
* identity providers and provider attributes that have been trusted by the application owner.</p>
|
|
268
|
+
* </important>
|
|
299
269
|
*
|
|
300
|
-
* <p>This action is
|
|
301
|
-
* credentials.</p>
|
|
270
|
+
* <p>This action is administrative and requires developer credentials.</p>
|
|
302
271
|
*/
|
|
303
272
|
adminLinkProviderForUser(args: AdminLinkProviderForUserCommandInput, options?: __HttpHandlerOptions): Promise<AdminLinkProviderForUserCommandOutput>;
|
|
304
273
|
adminLinkProviderForUser(args: AdminLinkProviderForUserCommandInput, cb: (err: any, data?: AdminLinkProviderForUserCommandOutput) => void): void;
|
|
@@ -318,8 +287,7 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
318
287
|
adminListGroupsForUser(args: AdminListGroupsForUserCommandInput, cb: (err: any, data?: AdminListGroupsForUserCommandOutput) => void): void;
|
|
319
288
|
adminListGroupsForUser(args: AdminListGroupsForUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminListGroupsForUserCommandOutput) => void): void;
|
|
320
289
|
/**
|
|
321
|
-
* <p>
|
|
322
|
-
* advanced security.</p>
|
|
290
|
+
* <p>A history of user activity and any risks detected as part of Amazon Cognito advanced security.</p>
|
|
323
291
|
*/
|
|
324
292
|
adminListUserAuthEvents(args: AdminListUserAuthEventsCommandInput, options?: __HttpHandlerOptions): Promise<AdminListUserAuthEventsCommandOutput>;
|
|
325
293
|
adminListUserAuthEvents(args: AdminListUserAuthEventsCommandInput, cb: (err: any, data?: AdminListUserAuthEventsCommandOutput) => void): void;
|
|
@@ -332,33 +300,29 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
332
300
|
adminRemoveUserFromGroup(args: AdminRemoveUserFromGroupCommandInput, cb: (err: any, data?: AdminRemoveUserFromGroupCommandOutput) => void): void;
|
|
333
301
|
adminRemoveUserFromGroup(args: AdminRemoveUserFromGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminRemoveUserFromGroupCommandOutput) => void): void;
|
|
334
302
|
/**
|
|
335
|
-
* <p>Resets the specified user's password in a user pool as an administrator. Works on any
|
|
336
|
-
*
|
|
337
|
-
*
|
|
338
|
-
*
|
|
339
|
-
*
|
|
340
|
-
*
|
|
341
|
-
* the user pool has phone verification selected and a verified phone number exists for the
|
|
342
|
-
* user, or if email verification is selected and a verified email exists for the user,
|
|
343
|
-
* calling this API will also result in sending a message to the end user with the code to
|
|
344
|
-
* change their password.</p>
|
|
303
|
+
* <p>Resets the specified user's password in a user pool as an administrator. Works on any user.</p>
|
|
304
|
+
* <p>When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called,
|
|
305
|
+
* the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same
|
|
306
|
+
* as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if
|
|
307
|
+
* 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
|
+
* with the code to change their password.</p>
|
|
345
309
|
*
|
|
346
310
|
*
|
|
347
311
|
* <note>
|
|
348
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021,
|
|
349
|
-
*
|
|
350
|
-
*
|
|
351
|
-
*
|
|
352
|
-
*
|
|
353
|
-
*
|
|
354
|
-
* in
|
|
355
|
-
*
|
|
356
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
357
|
-
*
|
|
358
|
-
*
|
|
359
|
-
*
|
|
360
|
-
*
|
|
361
|
-
*
|
|
312
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
|
|
313
|
+
* origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
|
|
314
|
+
* register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
|
|
315
|
+
* automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
|
|
316
|
+
* or sign in.</p>
|
|
317
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
|
|
318
|
+
* might place your account in SMS sandbox. In
|
|
319
|
+
* <i>
|
|
320
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
|
|
321
|
+
* </i>, you will have
|
|
322
|
+
* limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
|
|
323
|
+
* out of the SMS sandbox and into production. For more information, see
|
|
324
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
|
|
325
|
+
* message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
362
326
|
* </note>
|
|
363
327
|
*
|
|
364
328
|
* <p>Calling this action requires developer credentials.</p>
|
|
@@ -370,20 +334,20 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
370
334
|
* <p>Responds to an authentication challenge, as an administrator.</p>
|
|
371
335
|
*
|
|
372
336
|
* <note>
|
|
373
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021,
|
|
374
|
-
*
|
|
375
|
-
*
|
|
376
|
-
*
|
|
377
|
-
*
|
|
378
|
-
*
|
|
379
|
-
* in
|
|
380
|
-
*
|
|
381
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
382
|
-
*
|
|
383
|
-
*
|
|
384
|
-
*
|
|
385
|
-
*
|
|
386
|
-
*
|
|
337
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
|
|
338
|
+
* origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
|
|
339
|
+
* register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
|
|
340
|
+
* automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
|
|
341
|
+
* or sign in.</p>
|
|
342
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
|
|
343
|
+
* might place your account in SMS sandbox. In
|
|
344
|
+
* <i>
|
|
345
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
|
|
346
|
+
* </i>, you will have
|
|
347
|
+
* limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
|
|
348
|
+
* out of the SMS sandbox and into production. For more information, see
|
|
349
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
|
|
350
|
+
* message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
387
351
|
* </note>
|
|
388
352
|
*
|
|
389
353
|
* <p>Calling this action requires developer credentials.</p>
|
|
@@ -392,43 +356,35 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
392
356
|
adminRespondToAuthChallenge(args: AdminRespondToAuthChallengeCommandInput, cb: (err: any, data?: AdminRespondToAuthChallengeCommandOutput) => void): void;
|
|
393
357
|
adminRespondToAuthChallenge(args: AdminRespondToAuthChallengeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminRespondToAuthChallengeCommandOutput) => void): void;
|
|
394
358
|
/**
|
|
395
|
-
* <p>
|
|
396
|
-
*
|
|
397
|
-
*
|
|
398
|
-
* enabled. If multiple options are enabled and no preference is set, a challenge to choose
|
|
399
|
-
* an MFA option will be returned during sign in.</p>
|
|
359
|
+
* <p>The user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred. Only one factor can be set as preferred. The preferred
|
|
360
|
+
* MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will
|
|
361
|
+
* be returned during sign-in.</p>
|
|
400
362
|
*/
|
|
401
363
|
adminSetUserMFAPreference(args: AdminSetUserMFAPreferenceCommandInput, options?: __HttpHandlerOptions): Promise<AdminSetUserMFAPreferenceCommandOutput>;
|
|
402
364
|
adminSetUserMFAPreference(args: AdminSetUserMFAPreferenceCommandInput, cb: (err: any, data?: AdminSetUserMFAPreferenceCommandOutput) => void): void;
|
|
403
365
|
adminSetUserMFAPreference(args: AdminSetUserMFAPreferenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminSetUserMFAPreferenceCommandOutput) => void): void;
|
|
404
366
|
/**
|
|
405
|
-
* <p>Sets the specified user's password in a user pool as an administrator. Works on any
|
|
406
|
-
*
|
|
407
|
-
*
|
|
408
|
-
*
|
|
409
|
-
*
|
|
410
|
-
* <code>NEW_PASSWORD_REQUIRED</code> challenge. If the user does not sign in before it
|
|
411
|
-
* expires, the user will not be able to sign in and their password will need to be reset
|
|
412
|
-
* by an administrator. </p>
|
|
413
|
-
* <p>Once the user has set a new password, or the password is permanent, the user status
|
|
414
|
-
* will be set to <code>Confirmed</code>.</p>
|
|
367
|
+
* <p>Sets the specified user's password in a user pool as an administrator. Works on any user. </p>
|
|
368
|
+
* <p>The password can be temporary or permanent. If it is temporary, the user status enters the <code>FORCE_CHANGE_PASSWORD</code> state. When the user next tries to sign in,
|
|
369
|
+
* the InitiateAuth/AdminInitiateAuth response will contain the <code>NEW_PASSWORD_REQUIRED</code> challenge. If the user doesn't sign in before it expires, the user won't be
|
|
370
|
+
* able to sign in, and an administrator must reset their password. </p>
|
|
371
|
+
* <p>Once the user has set a new password, or the password is permanent, the user status is set to <code>Confirmed</code>.</p>
|
|
415
372
|
*/
|
|
416
373
|
adminSetUserPassword(args: AdminSetUserPasswordCommandInput, options?: __HttpHandlerOptions): Promise<AdminSetUserPasswordCommandOutput>;
|
|
417
374
|
adminSetUserPassword(args: AdminSetUserPasswordCommandInput, cb: (err: any, data?: AdminSetUserPasswordCommandOutput) => void): void;
|
|
418
375
|
adminSetUserPassword(args: AdminSetUserPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminSetUserPasswordCommandOutput) => void): void;
|
|
419
376
|
/**
|
|
420
377
|
* <p>
|
|
421
|
-
* <i>This action is no longer supported.</i> You can use it to configure
|
|
422
|
-
*
|
|
423
|
-
*
|
|
378
|
+
* <i>This action is no longer supported.</i> You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP)
|
|
379
|
+
* software token MFA. To configure either type of MFA,
|
|
380
|
+
* use <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserMFAPreference.html">AdminSetUserMFAPreference</a> instead.</p>
|
|
424
381
|
*/
|
|
425
382
|
adminSetUserSettings(args: AdminSetUserSettingsCommandInput, options?: __HttpHandlerOptions): Promise<AdminSetUserSettingsCommandOutput>;
|
|
426
383
|
adminSetUserSettings(args: AdminSetUserSettingsCommandInput, cb: (err: any, data?: AdminSetUserSettingsCommandOutput) => void): void;
|
|
427
384
|
adminSetUserSettings(args: AdminSetUserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminSetUserSettingsCommandOutput) => void): void;
|
|
428
385
|
/**
|
|
429
|
-
* <p>Provides feedback for an authentication event
|
|
430
|
-
*
|
|
431
|
-
* part of Amazon Cognito advanced security.</p>
|
|
386
|
+
* <p>Provides feedback for an authentication event indicating if it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool
|
|
387
|
+
* as part of Amazon Cognito advanced security.</p>
|
|
432
388
|
*/
|
|
433
389
|
adminUpdateAuthEventFeedback(args: AdminUpdateAuthEventFeedbackCommandInput, options?: __HttpHandlerOptions): Promise<AdminUpdateAuthEventFeedbackCommandOutput>;
|
|
434
390
|
adminUpdateAuthEventFeedback(args: AdminUpdateAuthEventFeedbackCommandInput, cb: (err: any, data?: AdminUpdateAuthEventFeedbackCommandOutput) => void): void;
|
|
@@ -441,28 +397,25 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
441
397
|
adminUpdateDeviceStatus(args: AdminUpdateDeviceStatusCommandInput, cb: (err: any, data?: AdminUpdateDeviceStatusCommandOutput) => void): void;
|
|
442
398
|
adminUpdateDeviceStatus(args: AdminUpdateDeviceStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminUpdateDeviceStatusCommandOutput) => void): void;
|
|
443
399
|
/**
|
|
444
|
-
* <p>Updates the specified user's attributes, including developer attributes, as an
|
|
445
|
-
*
|
|
446
|
-
* <p>
|
|
447
|
-
* attribute name.</p>
|
|
448
|
-
* <p>In addition to updating user attributes, this API can also be used to mark phone and
|
|
449
|
-
* email as verified.</p>
|
|
400
|
+
* <p>Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.</p>
|
|
401
|
+
* <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>
|
|
402
|
+
* <p>In addition to updating user attributes, this API can also be used to mark phone and email as verified.</p>
|
|
450
403
|
*
|
|
451
404
|
* <note>
|
|
452
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021,
|
|
453
|
-
*
|
|
454
|
-
*
|
|
455
|
-
*
|
|
456
|
-
*
|
|
457
|
-
*
|
|
458
|
-
* in
|
|
459
|
-
*
|
|
460
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
461
|
-
*
|
|
462
|
-
*
|
|
463
|
-
*
|
|
464
|
-
*
|
|
465
|
-
*
|
|
405
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
|
|
406
|
+
* origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
|
|
407
|
+
* register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
|
|
408
|
+
* automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
|
|
409
|
+
* or sign in.</p>
|
|
410
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
|
|
411
|
+
* might place your account in SMS sandbox. In
|
|
412
|
+
* <i>
|
|
413
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
|
|
414
|
+
* </i>, you will have
|
|
415
|
+
* limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
|
|
416
|
+
* out of the SMS sandbox and into production. For more information, see
|
|
417
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
|
|
418
|
+
* message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
466
419
|
* </note>
|
|
467
420
|
*
|
|
468
421
|
* <p>Calling this action requires developer credentials.</p>
|
|
@@ -471,25 +424,20 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
471
424
|
adminUpdateUserAttributes(args: AdminUpdateUserAttributesCommandInput, cb: (err: any, data?: AdminUpdateUserAttributesCommandOutput) => void): void;
|
|
472
425
|
adminUpdateUserAttributes(args: AdminUpdateUserAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminUpdateUserAttributesCommandOutput) => void): void;
|
|
473
426
|
/**
|
|
474
|
-
* <p>Signs out users from all devices, as an administrator. It also invalidates all refresh
|
|
475
|
-
* tokens
|
|
476
|
-
* their expiry. Access and Id tokens expire one hour after they are issued.</p>
|
|
427
|
+
* <p>Signs out users from all devices, as an administrator. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and
|
|
428
|
+
* Id tokens expire one hour after they're issued.</p>
|
|
477
429
|
* <p>Calling this action requires developer credentials.</p>
|
|
478
430
|
*/
|
|
479
431
|
adminUserGlobalSignOut(args: AdminUserGlobalSignOutCommandInput, options?: __HttpHandlerOptions): Promise<AdminUserGlobalSignOutCommandOutput>;
|
|
480
432
|
adminUserGlobalSignOut(args: AdminUserGlobalSignOutCommandInput, cb: (err: any, data?: AdminUserGlobalSignOutCommandOutput) => void): void;
|
|
481
433
|
adminUserGlobalSignOut(args: AdminUserGlobalSignOutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminUserGlobalSignOutCommandOutput) => void): void;
|
|
482
434
|
/**
|
|
483
|
-
* <p>Returns a unique generated shared secret key code for the user account. The request
|
|
484
|
-
*
|
|
485
|
-
*
|
|
486
|
-
*
|
|
487
|
-
*
|
|
488
|
-
*
|
|
489
|
-
* config is set to Optional at the user pool level, the user can then login without
|
|
490
|
-
* MFA. However, if MFA is set to Required for the user pool, the user will be asked to
|
|
491
|
-
* setup a new software token MFA during sign in.</p>
|
|
492
|
-
* </note>
|
|
435
|
+
* <p>Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both.</p>
|
|
436
|
+
* <note>
|
|
437
|
+
* <p>Calling AssociateSoftwareToken immediately disassociates the existing software token from the user account. If the user doesn't subsequently verify the software token,
|
|
438
|
+
* their account is set up to authenticate without MFA. If MFA config is set to Optional at the user pool level, the user can then log in without MFA. However, if MFA is
|
|
439
|
+
* set to Required for the user pool, the user is asked to set up a new software token MFA during sign-in.</p>
|
|
440
|
+
* </note>
|
|
493
441
|
*/
|
|
494
442
|
associateSoftwareToken(args: AssociateSoftwareTokenCommandInput, options?: __HttpHandlerOptions): Promise<AssociateSoftwareTokenCommandOutput>;
|
|
495
443
|
associateSoftwareToken(args: AssociateSoftwareTokenCommandInput, cb: (err: any, data?: AssociateSoftwareTokenCommandOutput) => void): void;
|
|
@@ -501,8 +449,7 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
501
449
|
changePassword(args: ChangePasswordCommandInput, cb: (err: any, data?: ChangePasswordCommandOutput) => void): void;
|
|
502
450
|
changePassword(args: ChangePasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ChangePasswordCommandOutput) => void): void;
|
|
503
451
|
/**
|
|
504
|
-
* <p>Confirms tracking of the device. This API call is the call that begins device
|
|
505
|
-
* tracking.</p>
|
|
452
|
+
* <p>Confirms tracking of the device. This API call is the call that begins device tracking.</p>
|
|
506
453
|
*/
|
|
507
454
|
confirmDevice(args: ConfirmDeviceCommandInput, options?: __HttpHandlerOptions): Promise<ConfirmDeviceCommandOutput>;
|
|
508
455
|
confirmDevice(args: ConfirmDeviceCommandInput, cb: (err: any, data?: ConfirmDeviceCommandOutput) => void): void;
|
|
@@ -514,8 +461,7 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
514
461
|
confirmForgotPassword(args: ConfirmForgotPasswordCommandInput, cb: (err: any, data?: ConfirmForgotPasswordCommandOutput) => void): void;
|
|
515
462
|
confirmForgotPassword(args: ConfirmForgotPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfirmForgotPasswordCommandOutput) => void): void;
|
|
516
463
|
/**
|
|
517
|
-
* <p>Confirms registration of a user and handles the existing alias from a previous
|
|
518
|
-
* user.</p>
|
|
464
|
+
* <p>Confirms registration of a user and handles the existing alias from a previous user.</p>
|
|
519
465
|
*/
|
|
520
466
|
confirmSignUp(args: ConfirmSignUpCommandInput, options?: __HttpHandlerOptions): Promise<ConfirmSignUpCommandOutput>;
|
|
521
467
|
confirmSignUp(args: ConfirmSignUpCommandInput, cb: (err: any, data?: ConfirmSignUpCommandOutput) => void): void;
|
|
@@ -534,7 +480,7 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
534
480
|
createIdentityProvider(args: CreateIdentityProviderCommandInput, cb: (err: any, data?: CreateIdentityProviderCommandOutput) => void): void;
|
|
535
481
|
createIdentityProvider(args: CreateIdentityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIdentityProviderCommandOutput) => void): void;
|
|
536
482
|
/**
|
|
537
|
-
* <p>Creates a new OAuth2.0 resource server and defines custom scopes
|
|
483
|
+
* <p>Creates a new OAuth2.0 resource server and defines custom scopes within it.</p>
|
|
538
484
|
*/
|
|
539
485
|
createResourceServer(args: CreateResourceServerCommandInput, options?: __HttpHandlerOptions): Promise<CreateResourceServerCommandOutput>;
|
|
540
486
|
createResourceServer(args: CreateResourceServerCommandInput, cb: (err: any, data?: CreateResourceServerCommandOutput) => void): void;
|
|
@@ -546,24 +492,24 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
546
492
|
createUserImportJob(args: CreateUserImportJobCommandInput, cb: (err: any, data?: CreateUserImportJobCommandOutput) => void): void;
|
|
547
493
|
createUserImportJob(args: CreateUserImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserImportJobCommandOutput) => void): void;
|
|
548
494
|
/**
|
|
549
|
-
* <p>Creates a new Amazon Cognito user pool and sets the password policy for the
|
|
550
|
-
*
|
|
495
|
+
* <p>Creates a new Amazon Cognito user pool and sets the password policy for the pool.</p>
|
|
496
|
+
*
|
|
551
497
|
*
|
|
552
498
|
* <note>
|
|
553
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021,
|
|
554
|
-
*
|
|
555
|
-
*
|
|
556
|
-
*
|
|
557
|
-
*
|
|
558
|
-
*
|
|
559
|
-
* in
|
|
560
|
-
*
|
|
561
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
562
|
-
*
|
|
563
|
-
*
|
|
564
|
-
*
|
|
565
|
-
*
|
|
566
|
-
*
|
|
499
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
|
|
500
|
+
* origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
|
|
501
|
+
* register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
|
|
502
|
+
* automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
|
|
503
|
+
* or sign in.</p>
|
|
504
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
|
|
505
|
+
* might place your account in SMS sandbox. In
|
|
506
|
+
* <i>
|
|
507
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
|
|
508
|
+
* </i>, you will have
|
|
509
|
+
* limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
|
|
510
|
+
* out of the SMS sandbox and into production. For more information, see
|
|
511
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
|
|
512
|
+
* message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
567
513
|
* </note>
|
|
568
514
|
*/
|
|
569
515
|
createUserPool(args: CreateUserPoolCommandInput, options?: __HttpHandlerOptions): Promise<CreateUserPoolCommandOutput>;
|
|
@@ -571,8 +517,8 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
571
517
|
createUserPool(args: CreateUserPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserPoolCommandOutput) => void): void;
|
|
572
518
|
/**
|
|
573
519
|
* <p>Creates the user pool client.</p>
|
|
574
|
-
* <p>When you create a new user pool client, token revocation is automatically
|
|
575
|
-
*
|
|
520
|
+
* <p>When you create a new user pool client, token revocation is automatically activated. For more information about revoking tokens,
|
|
521
|
+
* see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
|
|
576
522
|
*/
|
|
577
523
|
createUserPoolClient(args: CreateUserPoolClientCommandInput, options?: __HttpHandlerOptions): Promise<CreateUserPoolClientCommandOutput>;
|
|
578
524
|
createUserPoolClient(args: CreateUserPoolClientCommandInput, cb: (err: any, data?: CreateUserPoolClientCommandOutput) => void): void;
|
|
@@ -663,8 +609,7 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
663
609
|
describeUserPool(args: DescribeUserPoolCommandInput, cb: (err: any, data?: DescribeUserPoolCommandOutput) => void): void;
|
|
664
610
|
describeUserPool(args: DescribeUserPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserPoolCommandOutput) => void): void;
|
|
665
611
|
/**
|
|
666
|
-
* <p>Client method for returning the configuration information and metadata of the
|
|
667
|
-
* specified user pool app client.</p>
|
|
612
|
+
* <p>Client method for returning the configuration information and metadata of the specified user pool app client.</p>
|
|
668
613
|
*/
|
|
669
614
|
describeUserPoolClient(args: DescribeUserPoolClientCommandInput, options?: __HttpHandlerOptions): Promise<DescribeUserPoolClientCommandOutput>;
|
|
670
615
|
describeUserPoolClient(args: DescribeUserPoolClientCommandInput, cb: (err: any, data?: DescribeUserPoolClientCommandOutput) => void): void;
|
|
@@ -682,38 +627,38 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
682
627
|
forgetDevice(args: ForgetDeviceCommandInput, cb: (err: any, data?: ForgetDeviceCommandOutput) => void): void;
|
|
683
628
|
forgetDevice(args: ForgetDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ForgetDeviceCommandOutput) => void): void;
|
|
684
629
|
/**
|
|
685
|
-
* <p>Calling this API causes a message to be sent to the end user with a confirmation code
|
|
686
|
-
*
|
|
687
|
-
*
|
|
688
|
-
*
|
|
689
|
-
*
|
|
690
|
-
*
|
|
691
|
-
*
|
|
692
|
-
*
|
|
630
|
+
* <p>Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the
|
|
631
|
+
* <code>Username</code> parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the
|
|
632
|
+
* specified AccountRecoverySetting. For more information,
|
|
633
|
+
* see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-recover-a-user-account.html">Recovering User Accounts</a>
|
|
634
|
+
* in the <i>Amazon Cognito Developer Guide</i>. If neither a verified phone number nor a verified email exists,
|
|
635
|
+
* an <code>InvalidParameterException</code> is thrown. To use the confirmation code for resetting the password,
|
|
636
|
+
* call <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html">ConfirmForgotPassword</a>.
|
|
637
|
+
* </p>
|
|
638
|
+
*
|
|
693
639
|
*
|
|
694
640
|
* <note>
|
|
695
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021,
|
|
696
|
-
*
|
|
697
|
-
*
|
|
698
|
-
*
|
|
699
|
-
*
|
|
700
|
-
*
|
|
701
|
-
* in
|
|
702
|
-
*
|
|
703
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
704
|
-
*
|
|
705
|
-
*
|
|
706
|
-
*
|
|
707
|
-
*
|
|
708
|
-
*
|
|
641
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
|
|
642
|
+
* origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
|
|
643
|
+
* register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
|
|
644
|
+
* automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
|
|
645
|
+
* or sign in.</p>
|
|
646
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
|
|
647
|
+
* might place your account in SMS sandbox. In
|
|
648
|
+
* <i>
|
|
649
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
|
|
650
|
+
* </i>, you will have
|
|
651
|
+
* limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
|
|
652
|
+
* out of the SMS sandbox and into production. For more information, see
|
|
653
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
|
|
654
|
+
* message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
709
655
|
* </note>
|
|
710
656
|
*/
|
|
711
657
|
forgotPassword(args: ForgotPasswordCommandInput, options?: __HttpHandlerOptions): Promise<ForgotPasswordCommandOutput>;
|
|
712
658
|
forgotPassword(args: ForgotPasswordCommandInput, cb: (err: any, data?: ForgotPasswordCommandOutput) => void): void;
|
|
713
659
|
forgotPassword(args: ForgotPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ForgotPasswordCommandOutput) => void): void;
|
|
714
660
|
/**
|
|
715
|
-
* <p>Gets the header information for the
|
|
716
|
-
* job.</p>
|
|
661
|
+
* <p>Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job.</p>
|
|
717
662
|
*/
|
|
718
663
|
getCSVHeader(args: GetCSVHeaderCommandInput, options?: __HttpHandlerOptions): Promise<GetCSVHeaderCommandOutput>;
|
|
719
664
|
getCSVHeader(args: GetCSVHeaderCommandInput, cb: (err: any, data?: GetCSVHeaderCommandOutput) => void): void;
|
|
@@ -744,10 +689,8 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
744
689
|
getSigningCertificate(args: GetSigningCertificateCommandInput, cb: (err: any, data?: GetSigningCertificateCommandOutput) => void): void;
|
|
745
690
|
getSigningCertificate(args: GetSigningCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSigningCertificateCommandOutput) => void): void;
|
|
746
691
|
/**
|
|
747
|
-
* <p>Gets the UI Customization information for a particular app client's app UI, if
|
|
748
|
-
*
|
|
749
|
-
* pool level customization (app <code>clientId</code> will be <code>ALL</code>), then that
|
|
750
|
-
* is returned. If nothing is present, then an empty shape is returned.</p>
|
|
692
|
+
* <p>Gets the user interface (UI) Customization information for a particular app client's app UI, if any such information exists for the client. If nothing is set for the particular client,
|
|
693
|
+
* but there is an existing pool level customization (the app <code>clientId</code> is <code>ALL</code>), then that information is returned. If nothing is present, then an empty shape is returned.</p>
|
|
751
694
|
*/
|
|
752
695
|
getUICustomization(args: GetUICustomizationCommandInput, options?: __HttpHandlerOptions): Promise<GetUICustomizationCommandOutput>;
|
|
753
696
|
getUICustomization(args: GetUICustomizationCommandInput, cb: (err: any, data?: GetUICustomizationCommandOutput) => void): void;
|
|
@@ -761,21 +704,22 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
761
704
|
/**
|
|
762
705
|
* <p>Gets the user attribute verification code for the specified attribute name.</p>
|
|
763
706
|
*
|
|
707
|
+
*
|
|
764
708
|
* <note>
|
|
765
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021,
|
|
766
|
-
*
|
|
767
|
-
*
|
|
768
|
-
*
|
|
769
|
-
*
|
|
770
|
-
*
|
|
771
|
-
* in
|
|
772
|
-
*
|
|
773
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
774
|
-
*
|
|
775
|
-
*
|
|
776
|
-
*
|
|
777
|
-
*
|
|
778
|
-
*
|
|
709
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
|
|
710
|
+
* origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
|
|
711
|
+
* register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
|
|
712
|
+
* automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
|
|
713
|
+
* or sign in.</p>
|
|
714
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
|
|
715
|
+
* might place your account in SMS sandbox. In
|
|
716
|
+
* <i>
|
|
717
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
|
|
718
|
+
* </i>, you will have
|
|
719
|
+
* limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
|
|
720
|
+
* out of the SMS sandbox and into production. For more information, see
|
|
721
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
|
|
722
|
+
* message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
779
723
|
* </note>
|
|
780
724
|
*/
|
|
781
725
|
getUserAttributeVerificationCode(args: GetUserAttributeVerificationCodeCommandInput, options?: __HttpHandlerOptions): Promise<GetUserAttributeVerificationCodeCommandOutput>;
|
|
@@ -788,9 +732,8 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
788
732
|
getUserPoolMfaConfig(args: GetUserPoolMfaConfigCommandInput, cb: (err: any, data?: GetUserPoolMfaConfigCommandOutput) => void): void;
|
|
789
733
|
getUserPoolMfaConfig(args: GetUserPoolMfaConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserPoolMfaConfigCommandOutput) => void): void;
|
|
790
734
|
/**
|
|
791
|
-
* <p>Signs out users from all devices. It also invalidates all refresh tokens issued to a
|
|
792
|
-
*
|
|
793
|
-
* and Id tokens expire one hour after they are issued.</p>
|
|
735
|
+
* <p>Signs out users from all devices. It also invalidates all refresh tokens issued to a user. The user's current access and ID tokens remain valid until their expiry. Access and Id tokens expire
|
|
736
|
+
* one hour after they're issued.</p>
|
|
794
737
|
*/
|
|
795
738
|
globalSignOut(args: GlobalSignOutCommandInput, options?: __HttpHandlerOptions): Promise<GlobalSignOutCommandOutput>;
|
|
796
739
|
globalSignOut(args: GlobalSignOutCommandInput, cb: (err: any, data?: GlobalSignOutCommandOutput) => void): void;
|
|
@@ -799,20 +742,20 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
799
742
|
* <p>Initiates the authentication flow.</p>
|
|
800
743
|
*
|
|
801
744
|
* <note>
|
|
802
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021,
|
|
803
|
-
*
|
|
804
|
-
*
|
|
805
|
-
*
|
|
806
|
-
*
|
|
807
|
-
*
|
|
808
|
-
* in
|
|
809
|
-
*
|
|
810
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
811
|
-
*
|
|
812
|
-
*
|
|
813
|
-
*
|
|
814
|
-
*
|
|
815
|
-
*
|
|
745
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
|
|
746
|
+
* origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
|
|
747
|
+
* register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
|
|
748
|
+
* automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
|
|
749
|
+
* or sign in.</p>
|
|
750
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
|
|
751
|
+
* might place your account in SMS sandbox. In
|
|
752
|
+
* <i>
|
|
753
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
|
|
754
|
+
* </i>, you will have
|
|
755
|
+
* limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
|
|
756
|
+
* out of the SMS sandbox and into production. For more information, see
|
|
757
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
|
|
758
|
+
* message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
816
759
|
* </note>
|
|
817
760
|
*/
|
|
818
761
|
initiateAuth(args: InitiateAuthCommandInput, options?: __HttpHandlerOptions): Promise<InitiateAuthCommandOutput>;
|
|
@@ -845,8 +788,7 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
845
788
|
listResourceServers(args: ListResourceServersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceServersCommandOutput) => void): void;
|
|
846
789
|
/**
|
|
847
790
|
* <p>Lists the tags that are assigned to an Amazon Cognito user pool.</p>
|
|
848
|
-
* <p>A tag is a label that you can apply to user pools to categorize and manage them in
|
|
849
|
-
* different ways, such as by purpose, owner, environment, or other criteria.</p>
|
|
791
|
+
* <p>A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.</p>
|
|
850
792
|
* <p>You can use this action up to 10 times per second, per account.</p>
|
|
851
793
|
*/
|
|
852
794
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
@@ -865,7 +807,7 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
865
807
|
listUserPoolClients(args: ListUserPoolClientsCommandInput, cb: (err: any, data?: ListUserPoolClientsCommandOutput) => void): void;
|
|
866
808
|
listUserPoolClients(args: ListUserPoolClientsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUserPoolClientsCommandOutput) => void): void;
|
|
867
809
|
/**
|
|
868
|
-
* <p>Lists the user pools associated with an account.</p>
|
|
810
|
+
* <p>Lists the user pools associated with an Amazon Web Services account.</p>
|
|
869
811
|
*/
|
|
870
812
|
listUserPools(args: ListUserPoolsCommandInput, options?: __HttpHandlerOptions): Promise<ListUserPoolsCommandOutput>;
|
|
871
813
|
listUserPools(args: ListUserPoolsCommandInput, cb: (err: any, data?: ListUserPoolsCommandOutput) => void): void;
|
|
@@ -884,24 +826,24 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
884
826
|
listUsersInGroup(args: ListUsersInGroupCommandInput, cb: (err: any, data?: ListUsersInGroupCommandOutput) => void): void;
|
|
885
827
|
listUsersInGroup(args: ListUsersInGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersInGroupCommandOutput) => void): void;
|
|
886
828
|
/**
|
|
887
|
-
* <p>Resends the confirmation (for confirmation of registration) to a specific user in the
|
|
888
|
-
*
|
|
829
|
+
* <p>Resends the confirmation (for confirmation of registration) to a specific user in the user pool.</p>
|
|
830
|
+
*
|
|
889
831
|
*
|
|
890
832
|
* <note>
|
|
891
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021,
|
|
892
|
-
*
|
|
893
|
-
*
|
|
894
|
-
*
|
|
895
|
-
*
|
|
896
|
-
*
|
|
897
|
-
* in
|
|
898
|
-
*
|
|
899
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
900
|
-
*
|
|
901
|
-
*
|
|
902
|
-
*
|
|
903
|
-
*
|
|
904
|
-
*
|
|
833
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
|
|
834
|
+
* origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
|
|
835
|
+
* register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
|
|
836
|
+
* automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
|
|
837
|
+
* or sign in.</p>
|
|
838
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
|
|
839
|
+
* might place your account in SMS sandbox. In
|
|
840
|
+
* <i>
|
|
841
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
|
|
842
|
+
* </i>, you will have
|
|
843
|
+
* limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
|
|
844
|
+
* out of the SMS sandbox and into production. For more information, see
|
|
845
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
|
|
846
|
+
* message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
905
847
|
* </note>
|
|
906
848
|
*/
|
|
907
849
|
resendConfirmationCode(args: ResendConfirmationCodeCommandInput, options?: __HttpHandlerOptions): Promise<ResendConfirmationCodeCommandOutput>;
|
|
@@ -911,124 +853,111 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
911
853
|
* <p>Responds to the authentication challenge.</p>
|
|
912
854
|
*
|
|
913
855
|
* <note>
|
|
914
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021,
|
|
915
|
-
*
|
|
916
|
-
*
|
|
917
|
-
*
|
|
918
|
-
*
|
|
919
|
-
*
|
|
920
|
-
* in
|
|
921
|
-
*
|
|
922
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
923
|
-
*
|
|
924
|
-
*
|
|
925
|
-
*
|
|
926
|
-
*
|
|
927
|
-
*
|
|
856
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
|
|
857
|
+
* origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
|
|
858
|
+
* register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
|
|
859
|
+
* automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
|
|
860
|
+
* or sign in.</p>
|
|
861
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
|
|
862
|
+
* might place your account in SMS sandbox. In
|
|
863
|
+
* <i>
|
|
864
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
|
|
865
|
+
* </i>, you will have
|
|
866
|
+
* limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
|
|
867
|
+
* out of the SMS sandbox and into production. For more information, see
|
|
868
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
|
|
869
|
+
* message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
928
870
|
* </note>
|
|
929
871
|
*/
|
|
930
872
|
respondToAuthChallenge(args: RespondToAuthChallengeCommandInput, options?: __HttpHandlerOptions): Promise<RespondToAuthChallengeCommandOutput>;
|
|
931
873
|
respondToAuthChallenge(args: RespondToAuthChallengeCommandInput, cb: (err: any, data?: RespondToAuthChallengeCommandOutput) => void): void;
|
|
932
874
|
respondToAuthChallenge(args: RespondToAuthChallengeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RespondToAuthChallengeCommandOutput) => void): void;
|
|
933
875
|
/**
|
|
934
|
-
* <p>Revokes all of the access tokens generated by the specified refresh token. After the token is revoked, you can
|
|
935
|
-
* use the revoked token to access Cognito authenticated APIs.</p>
|
|
876
|
+
* <p>Revokes all of the access tokens generated by the specified refresh token. After the token is revoked, you can't use the revoked token to access Amazon Cognito authenticated APIs.</p>
|
|
936
877
|
*/
|
|
937
878
|
revokeToken(args: RevokeTokenCommandInput, options?: __HttpHandlerOptions): Promise<RevokeTokenCommandOutput>;
|
|
938
879
|
revokeToken(args: RevokeTokenCommandInput, cb: (err: any, data?: RevokeTokenCommandOutput) => void): void;
|
|
939
880
|
revokeToken(args: RevokeTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeTokenCommandOutput) => void): void;
|
|
940
881
|
/**
|
|
941
|
-
* <p>Configures actions on detected risks. To delete the risk configuration for
|
|
942
|
-
*
|
|
943
|
-
* configuration types.</p>
|
|
944
|
-
* <p>To enable Amazon Cognito advanced security features, update the user pool to include
|
|
945
|
-
* the <code>UserPoolAddOns</code> key<code>AdvancedSecurityMode</code>.</p>
|
|
882
|
+
* <p>Configures actions on detected risks. To delete the risk configuration for <code>UserPoolId</code> or <code>ClientId</code>, pass null values for all four configuration types.</p>
|
|
883
|
+
* <p>To activate Amazon Cognito advanced security features, update the user pool to include the <code>UserPoolAddOns</code> key<code>AdvancedSecurityMode</code>.</p>
|
|
946
884
|
*/
|
|
947
885
|
setRiskConfiguration(args: SetRiskConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<SetRiskConfigurationCommandOutput>;
|
|
948
886
|
setRiskConfiguration(args: SetRiskConfigurationCommandInput, cb: (err: any, data?: SetRiskConfigurationCommandOutput) => void): void;
|
|
949
887
|
setRiskConfiguration(args: SetRiskConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetRiskConfigurationCommandOutput) => void): void;
|
|
950
888
|
/**
|
|
951
|
-
* <p>Sets the UI customization information for a user pool's built-in app UI.</p>
|
|
952
|
-
* <p>You can specify app UI customization settings for a single client (with a specific
|
|
953
|
-
*
|
|
954
|
-
*
|
|
955
|
-
*
|
|
956
|
-
*
|
|
957
|
-
*
|
|
958
|
-
* <note>
|
|
959
|
-
* <p>To use this API, your user pool must have a domain associated with it. Otherwise,
|
|
960
|
-
* there is no place to host the app's pages, and the service will throw an
|
|
961
|
-
* error.</p>
|
|
962
|
-
* </note>
|
|
889
|
+
* <p>Sets the user interface (UI) customization information for a user pool's built-in app UI.</p>
|
|
890
|
+
* <p>You can specify app UI customization settings for a single client (with a specific <code>clientId</code>) or for all clients (by setting the <code>clientId</code>
|
|
891
|
+
* to <code>ALL</code>). If you specify <code>ALL</code>, the default configuration is used for every client that has no previously set UI customization. If you specify UI
|
|
892
|
+
* customization settings for a particular client, it will no longer return to the <code>ALL</code> configuration.</p>
|
|
893
|
+
* <note>
|
|
894
|
+
* <p>To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.</p>
|
|
895
|
+
* </note>
|
|
963
896
|
*/
|
|
964
897
|
setUICustomization(args: SetUICustomizationCommandInput, options?: __HttpHandlerOptions): Promise<SetUICustomizationCommandOutput>;
|
|
965
898
|
setUICustomization(args: SetUICustomizationCommandInput, cb: (err: any, data?: SetUICustomizationCommandOutput) => void): void;
|
|
966
899
|
setUICustomization(args: SetUICustomizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetUICustomizationCommandOutput) => void): void;
|
|
967
900
|
/**
|
|
968
|
-
* <p>Set the user's multi-factor authentication (MFA) method preference, including which
|
|
969
|
-
*
|
|
970
|
-
*
|
|
971
|
-
*
|
|
972
|
-
*
|
|
973
|
-
*
|
|
974
|
-
* unless device tracking is turned on and the device has been trusted. If you would like
|
|
975
|
-
* MFA to be applied selectively based on the assessed risk level of sign in attempts,
|
|
976
|
-
* disable MFA for users and turn on Adaptive Authentication for the user pool.</p>
|
|
901
|
+
* <p>Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated and if any are preferred.
|
|
902
|
+
* Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated.
|
|
903
|
+
* If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in. If an
|
|
904
|
+
* MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts unless device tracking is turned on and
|
|
905
|
+
* the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate
|
|
906
|
+
* MFA for users and turn on Adaptive Authentication for the user pool.</p>
|
|
977
907
|
*/
|
|
978
908
|
setUserMFAPreference(args: SetUserMFAPreferenceCommandInput, options?: __HttpHandlerOptions): Promise<SetUserMFAPreferenceCommandOutput>;
|
|
979
909
|
setUserMFAPreference(args: SetUserMFAPreferenceCommandInput, cb: (err: any, data?: SetUserMFAPreferenceCommandOutput) => void): void;
|
|
980
910
|
setUserMFAPreference(args: SetUserMFAPreferenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetUserMFAPreferenceCommandOutput) => void): void;
|
|
981
911
|
/**
|
|
982
|
-
* <p>
|
|
912
|
+
* <p>Sets the user pool multi-factor authentication (MFA) configuration.</p>
|
|
983
913
|
*
|
|
984
|
-
*
|
|
985
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021,
|
|
986
|
-
*
|
|
987
|
-
*
|
|
988
|
-
*
|
|
989
|
-
*
|
|
990
|
-
*
|
|
991
|
-
*
|
|
992
|
-
*
|
|
993
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
994
|
-
*
|
|
995
|
-
*
|
|
996
|
-
*
|
|
997
|
-
*
|
|
998
|
-
*
|
|
999
|
-
*
|
|
914
|
+
* <note>
|
|
915
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
|
|
916
|
+
* origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
|
|
917
|
+
* register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
|
|
918
|
+
* automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
|
|
919
|
+
* or sign in.</p>
|
|
920
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
|
|
921
|
+
* might place your account in SMS sandbox. In
|
|
922
|
+
* <i>
|
|
923
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
|
|
924
|
+
* </i>, you will have
|
|
925
|
+
* limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
|
|
926
|
+
* out of the SMS sandbox and into production. For more information, see
|
|
927
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
|
|
928
|
+
* message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
929
|
+
* </note>
|
|
1000
930
|
*/
|
|
1001
931
|
setUserPoolMfaConfig(args: SetUserPoolMfaConfigCommandInput, options?: __HttpHandlerOptions): Promise<SetUserPoolMfaConfigCommandOutput>;
|
|
1002
932
|
setUserPoolMfaConfig(args: SetUserPoolMfaConfigCommandInput, cb: (err: any, data?: SetUserPoolMfaConfigCommandOutput) => void): void;
|
|
1003
933
|
setUserPoolMfaConfig(args: SetUserPoolMfaConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetUserPoolMfaConfigCommandOutput) => void): void;
|
|
1004
934
|
/**
|
|
1005
935
|
* <p>
|
|
1006
|
-
* <i>This action is no longer supported.</i> You can use it to configure
|
|
1007
|
-
*
|
|
1008
|
-
* type of MFA, use <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserMFAPreference.html">SetUserMFAPreference</a> instead.</p>
|
|
936
|
+
* <i>This action is no longer supported.</i> You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA.
|
|
937
|
+
* 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>
|
|
1009
938
|
*/
|
|
1010
939
|
setUserSettings(args: SetUserSettingsCommandInput, options?: __HttpHandlerOptions): Promise<SetUserSettingsCommandOutput>;
|
|
1011
940
|
setUserSettings(args: SetUserSettingsCommandInput, cb: (err: any, data?: SetUserSettingsCommandOutput) => void): void;
|
|
1012
941
|
setUserSettings(args: SetUserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetUserSettingsCommandOutput) => void): void;
|
|
1013
942
|
/**
|
|
1014
|
-
* <p>Registers the user in the specified user pool and creates a user name, password, and
|
|
1015
|
-
*
|
|
943
|
+
* <p>Registers the user in the specified user pool and creates a user name, password, and user attributes.</p>
|
|
944
|
+
*
|
|
1016
945
|
*
|
|
1017
946
|
* <note>
|
|
1018
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021,
|
|
1019
|
-
*
|
|
1020
|
-
*
|
|
1021
|
-
*
|
|
1022
|
-
*
|
|
1023
|
-
*
|
|
1024
|
-
* in
|
|
1025
|
-
*
|
|
1026
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
1027
|
-
*
|
|
1028
|
-
*
|
|
1029
|
-
*
|
|
1030
|
-
*
|
|
1031
|
-
*
|
|
947
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
|
|
948
|
+
* origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
|
|
949
|
+
* register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
|
|
950
|
+
* automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
|
|
951
|
+
* or sign in.</p>
|
|
952
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
|
|
953
|
+
* might place your account in SMS sandbox. In
|
|
954
|
+
* <i>
|
|
955
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
|
|
956
|
+
* </i>, you will have
|
|
957
|
+
* limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
|
|
958
|
+
* out of the SMS sandbox and into production. For more information, see
|
|
959
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
|
|
960
|
+
* message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
1032
961
|
* </note>
|
|
1033
962
|
*/
|
|
1034
963
|
signUp(args: SignUpCommandInput, options?: __HttpHandlerOptions): Promise<SignUpCommandOutput>;
|
|
@@ -1047,35 +976,26 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
1047
976
|
stopUserImportJob(args: StopUserImportJobCommandInput, cb: (err: any, data?: StopUserImportJobCommandOutput) => void): void;
|
|
1048
977
|
stopUserImportJob(args: StopUserImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopUserImportJobCommandOutput) => void): void;
|
|
1049
978
|
/**
|
|
1050
|
-
* <p>Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can
|
|
1051
|
-
*
|
|
1052
|
-
*
|
|
1053
|
-
*
|
|
1054
|
-
*
|
|
1055
|
-
*
|
|
1056
|
-
*
|
|
1057
|
-
* user pool and <code>Production</code> for the other.</p>
|
|
1058
|
-
* <p>Tags are useful for cost tracking and access control. You can activate your tags so
|
|
1059
|
-
* that they appear on the Billing and Cost Management console, where you can track the
|
|
1060
|
-
* costs associated with your user pools. In an IAM policy, you can constrain permissions
|
|
1061
|
-
* for user pools based on specific tags or tag values.</p>
|
|
1062
|
-
* <p>You can use this action up to 5 times per second, per account. A user pool can have as
|
|
1063
|
-
* many as 50 tags.</p>
|
|
979
|
+
* <p>Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.</p>
|
|
980
|
+
* <p>Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool,
|
|
981
|
+
* one for testing and another for production, you might assign an <code>Environment</code> tag key to both user pools. The value of this key might be <code>Test</code> for
|
|
982
|
+
* one user pool, and <code>Production</code> for the other.</p>
|
|
983
|
+
* <p>Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with
|
|
984
|
+
* your user pools. In an Identity and Access Management policy, you can constrain permissions for user pools based on specific tags or tag values.</p>
|
|
985
|
+
* <p>You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.</p>
|
|
1064
986
|
*/
|
|
1065
987
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
1066
988
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
1067
989
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
1068
990
|
/**
|
|
1069
|
-
* <p>Removes the specified tags from an Amazon Cognito user pool. You can use this action
|
|
1070
|
-
* up to 5 times per second, per account</p>
|
|
991
|
+
* <p>Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account.</p>
|
|
1071
992
|
*/
|
|
1072
993
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
1073
994
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
1074
995
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
1075
996
|
/**
|
|
1076
|
-
* <p>Provides the feedback for an authentication event whether it was from a valid user or
|
|
1077
|
-
*
|
|
1078
|
-
* as part of Amazon Cognito advanced security.</p>
|
|
997
|
+
* <p>Provides the feedback for an authentication event, whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part
|
|
998
|
+
* of Amazon Cognito advanced security.</p>
|
|
1079
999
|
*/
|
|
1080
1000
|
updateAuthEventFeedback(args: UpdateAuthEventFeedbackCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAuthEventFeedbackCommandOutput>;
|
|
1081
1001
|
updateAuthEventFeedback(args: UpdateAuthEventFeedbackCommandInput, cb: (err: any, data?: UpdateAuthEventFeedbackCommandOutput) => void): void;
|
|
@@ -1101,10 +1021,9 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
1101
1021
|
updateIdentityProvider(args: UpdateIdentityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIdentityProviderCommandOutput) => void): void;
|
|
1102
1022
|
/**
|
|
1103
1023
|
* <p>Updates the name and scopes of resource server. All other fields are read-only.</p>
|
|
1104
|
-
*
|
|
1105
|
-
* <p>If you don't provide a value for an attribute, it
|
|
1106
|
-
*
|
|
1107
|
-
* </important>
|
|
1024
|
+
* <important>
|
|
1025
|
+
* <p>If you don't provide a value for an attribute, it is set to the default value.</p>
|
|
1026
|
+
* </important>
|
|
1108
1027
|
*/
|
|
1109
1028
|
updateResourceServer(args: UpdateResourceServerCommandInput, options?: __HttpHandlerOptions): Promise<UpdateResourceServerCommandOutput>;
|
|
1110
1029
|
updateResourceServer(args: UpdateResourceServerCommandInput, cb: (err: any, data?: UpdateResourceServerCommandOutput) => void): void;
|
|
@@ -1112,94 +1031,85 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
|
|
|
1112
1031
|
/**
|
|
1113
1032
|
* <p>Allows a user to update a specific attribute (one at a time).</p>
|
|
1114
1033
|
*
|
|
1034
|
+
*
|
|
1115
1035
|
* <note>
|
|
1116
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021,
|
|
1117
|
-
*
|
|
1118
|
-
*
|
|
1119
|
-
*
|
|
1120
|
-
*
|
|
1121
|
-
*
|
|
1122
|
-
* in
|
|
1123
|
-
*
|
|
1124
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
1125
|
-
*
|
|
1126
|
-
*
|
|
1127
|
-
*
|
|
1128
|
-
*
|
|
1129
|
-
*
|
|
1036
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
|
|
1037
|
+
* origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
|
|
1038
|
+
* register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
|
|
1039
|
+
* automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
|
|
1040
|
+
* or sign in.</p>
|
|
1041
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
|
|
1042
|
+
* might place your account in SMS sandbox. In
|
|
1043
|
+
* <i>
|
|
1044
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
|
|
1045
|
+
* </i>, you will have
|
|
1046
|
+
* limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
|
|
1047
|
+
* out of the SMS sandbox and into production. For more information, see
|
|
1048
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
|
|
1049
|
+
* message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
1130
1050
|
* </note>
|
|
1131
1051
|
*/
|
|
1132
1052
|
updateUserAttributes(args: UpdateUserAttributesCommandInput, options?: __HttpHandlerOptions): Promise<UpdateUserAttributesCommandOutput>;
|
|
1133
1053
|
updateUserAttributes(args: UpdateUserAttributesCommandInput, cb: (err: any, data?: UpdateUserAttributesCommandOutput) => void): void;
|
|
1134
1054
|
updateUserAttributes(args: UpdateUserAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserAttributesCommandOutput) => void): void;
|
|
1135
1055
|
/**
|
|
1136
|
-
* <p>Updates the specified user pool with the specified attributes. You can get a list of
|
|
1137
|
-
*
|
|
1138
|
-
* value.</p>
|
|
1056
|
+
* <p>Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using
|
|
1057
|
+
* <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>.
|
|
1058
|
+
* If you don't provide a value for an attribute, it will be set to the default value.</p>
|
|
1059
|
+
*
|
|
1139
1060
|
*
|
|
1140
1061
|
* <note>
|
|
1141
|
-
* <p>This action might generate an SMS text message. Starting June 1, 2021,
|
|
1142
|
-
*
|
|
1143
|
-
*
|
|
1144
|
-
*
|
|
1145
|
-
*
|
|
1146
|
-
*
|
|
1147
|
-
* in
|
|
1148
|
-
*
|
|
1149
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
1150
|
-
*
|
|
1151
|
-
*
|
|
1152
|
-
*
|
|
1153
|
-
*
|
|
1154
|
-
*
|
|
1062
|
+
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
|
|
1063
|
+
* origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must
|
|
1064
|
+
* register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
|
|
1065
|
+
* automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
|
|
1066
|
+
* or sign in.</p>
|
|
1067
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
|
|
1068
|
+
* might place your account in SMS sandbox. In
|
|
1069
|
+
* <i>
|
|
1070
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
|
|
1071
|
+
* </i>, you will have
|
|
1072
|
+
* limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
|
|
1073
|
+
* out of the SMS sandbox and into production. For more information, see
|
|
1074
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS
|
|
1075
|
+
* message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
1155
1076
|
* </note>
|
|
1156
1077
|
*/
|
|
1157
1078
|
updateUserPool(args: UpdateUserPoolCommandInput, options?: __HttpHandlerOptions): Promise<UpdateUserPoolCommandOutput>;
|
|
1158
1079
|
updateUserPool(args: UpdateUserPoolCommandInput, cb: (err: any, data?: UpdateUserPoolCommandOutput) => void): void;
|
|
1159
1080
|
updateUserPool(args: UpdateUserPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserPoolCommandOutput) => void): void;
|
|
1160
1081
|
/**
|
|
1161
|
-
* <p>Updates the specified user pool app client with the specified attributes. You can get
|
|
1162
|
-
*
|
|
1163
|
-
*
|
|
1164
|
-
* <p>If you don't provide a value for an attribute, it will be set to the default
|
|
1165
|
-
*
|
|
1166
|
-
*
|
|
1167
|
-
*
|
|
1168
|
-
* about revoking tokens, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
|
|
1082
|
+
* <p>Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings using
|
|
1083
|
+
* <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html">DescribeUserPoolClient</a>.</p>
|
|
1084
|
+
* <important>
|
|
1085
|
+
* <p>If you don't provide a value for an attribute, it will be set to the default value.</p>
|
|
1086
|
+
* </important>
|
|
1087
|
+
* <p>You can also use this operation to enable token revocation for user pool clients. For more information about revoking tokens,
|
|
1088
|
+
* see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
|
|
1169
1089
|
*/
|
|
1170
1090
|
updateUserPoolClient(args: UpdateUserPoolClientCommandInput, options?: __HttpHandlerOptions): Promise<UpdateUserPoolClientCommandOutput>;
|
|
1171
1091
|
updateUserPoolClient(args: UpdateUserPoolClientCommandInput, cb: (err: any, data?: UpdateUserPoolClientCommandOutput) => void): void;
|
|
1172
1092
|
updateUserPoolClient(args: UpdateUserPoolClientCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserPoolClientCommandOutput) => void): void;
|
|
1173
1093
|
/**
|
|
1174
|
-
* <p>Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user
|
|
1175
|
-
*
|
|
1176
|
-
* <p>
|
|
1177
|
-
*
|
|
1178
|
-
*
|
|
1179
|
-
* <p>A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up
|
|
1180
|
-
* and sign-in pages for your application. When you set up a custom domain, you provide a
|
|
1181
|
-
* certificate that you manage with Certificate Manager (ACM). When necessary, you can
|
|
1182
|
-
* use this operation to change the certificate that you applied to your custom
|
|
1183
|
-
* domain.</p>
|
|
1184
|
-
* <p>Usually, this is unnecessary following routine certificate renewal with ACM. When you
|
|
1185
|
-
* renew your existing certificate in ACM, the ARN for your certificate remains the same,
|
|
1094
|
+
* <p>Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.</p>
|
|
1095
|
+
* <p>You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You can't use it to change the domain for a user pool.</p>
|
|
1096
|
+
* <p>A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you
|
|
1097
|
+
* manage with Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.</p>
|
|
1098
|
+
* <p>Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same,
|
|
1186
1099
|
* and your custom domain uses the new certificate automatically.</p>
|
|
1187
|
-
* <p>However, if you replace your existing certificate with a new one, ACM gives the new
|
|
1188
|
-
*
|
|
1189
|
-
*
|
|
1190
|
-
* <p>
|
|
1191
|
-
*
|
|
1192
|
-
*
|
|
1193
|
-
* new certificate to your custom domain.</p>
|
|
1194
|
-
* <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>
|
|
1100
|
+
* <p>However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide
|
|
1101
|
+
* this ARN to Amazon Cognito.</p>
|
|
1102
|
+
* <p>When you add your new certificate in ACM, you must choose US East (N. Virginia) as the Amazon Web Services Region.</p>
|
|
1103
|
+
* <p>After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.</p>
|
|
1104
|
+
* <p>For more information about adding a custom domain to your user pool,
|
|
1105
|
+
* 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>
|
|
1195
1106
|
*/
|
|
1196
1107
|
updateUserPoolDomain(args: UpdateUserPoolDomainCommandInput, options?: __HttpHandlerOptions): Promise<UpdateUserPoolDomainCommandOutput>;
|
|
1197
1108
|
updateUserPoolDomain(args: UpdateUserPoolDomainCommandInput, cb: (err: any, data?: UpdateUserPoolDomainCommandOutput) => void): void;
|
|
1198
1109
|
updateUserPoolDomain(args: UpdateUserPoolDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserPoolDomainCommandOutput) => void): void;
|
|
1199
1110
|
/**
|
|
1200
|
-
* <p>Use this API to register a user's entered TOTP code and mark the user's software token
|
|
1201
|
-
*
|
|
1202
|
-
* string, but not both.</p>
|
|
1111
|
+
* <p>Use this API to register a user's entered time-based one-time password (TOTP) code and mark the user's software token MFA status as "verified" if successful. The request takes an access
|
|
1112
|
+
* token or a session string, but not both.</p>
|
|
1203
1113
|
*/
|
|
1204
1114
|
verifySoftwareToken(args: VerifySoftwareTokenCommandInput, options?: __HttpHandlerOptions): Promise<VerifySoftwareTokenCommandOutput>;
|
|
1205
1115
|
verifySoftwareToken(args: VerifySoftwareTokenCommandInput, cb: (err: any, data?: VerifySoftwareTokenCommandOutput) => void): void;
|