@aws-sdk/client-cognito-identity-provider 3.363.0 → 3.370.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/dist-cjs/commands/VerifySoftwareTokenCommand.js +1 -1
  2. package/dist-cjs/endpoint/ruleset.js +3 -3
  3. package/dist-cjs/models/models_0.js +22 -2
  4. package/dist-cjs/models/models_1.js +9 -1
  5. package/dist-es/commands/VerifySoftwareTokenCommand.js +2 -2
  6. package/dist-es/endpoint/ruleset.js +3 -3
  7. package/dist-es/models/models_0.js +19 -0
  8. package/dist-es/models/models_1.js +7 -0
  9. package/dist-types/CognitoIdentityProvider.d.ts +2 -2
  10. package/dist-types/CognitoIdentityProviderClient.d.ts +2 -2
  11. package/dist-types/commands/AdminAddUserToGroupCommand.d.ts +1 -1
  12. package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +1 -1
  13. package/dist-types/commands/AdminCreateUserCommand.d.ts +5 -7
  14. package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +1 -1
  15. package/dist-types/commands/AdminDeleteUserCommand.d.ts +1 -1
  16. package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +5 -5
  17. package/dist-types/commands/AdminDisableUserCommand.d.ts +1 -1
  18. package/dist-types/commands/AdminEnableUserCommand.d.ts +1 -1
  19. package/dist-types/commands/AdminForgetDeviceCommand.d.ts +1 -1
  20. package/dist-types/commands/AdminGetDeviceCommand.d.ts +1 -1
  21. package/dist-types/commands/AdminGetUserCommand.d.ts +1 -1
  22. package/dist-types/commands/AdminInitiateAuthCommand.d.ts +1 -3
  23. package/dist-types/commands/AdminLinkProviderForUserCommand.d.ts +6 -7
  24. package/dist-types/commands/AdminListDevicesCommand.d.ts +1 -1
  25. package/dist-types/commands/AdminListGroupsForUserCommand.d.ts +1 -1
  26. package/dist-types/commands/AdminRemoveUserFromGroupCommand.d.ts +1 -1
  27. package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +2 -4
  28. package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +1 -3
  29. package/dist-types/commands/AdminSetUserPasswordCommand.d.ts +2 -2
  30. package/dist-types/commands/AdminUpdateDeviceStatusCommand.d.ts +1 -1
  31. package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +3 -5
  32. package/dist-types/commands/AdminUserGlobalSignOutCommand.d.ts +1 -1
  33. package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +2 -2
  34. package/dist-types/commands/CreateGroupCommand.d.ts +1 -1
  35. package/dist-types/commands/CreateUserPoolClientCommand.d.ts +1 -1
  36. package/dist-types/commands/CreateUserPoolCommand.d.ts +0 -1
  37. package/dist-types/commands/DeleteGroupCommand.d.ts +1 -1
  38. package/dist-types/commands/ForgotPasswordCommand.d.ts +0 -1
  39. package/dist-types/commands/GetGroupCommand.d.ts +1 -1
  40. package/dist-types/commands/GetSigningCertificateCommand.d.ts +1 -1
  41. package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +0 -1
  42. package/dist-types/commands/InitiateAuthCommand.d.ts +0 -1
  43. package/dist-types/commands/ListGroupsCommand.d.ts +1 -1
  44. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
  45. package/dist-types/commands/ListUsersInGroupCommand.d.ts +1 -1
  46. package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +0 -1
  47. package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +0 -1
  48. package/dist-types/commands/SetRiskConfigurationCommand.d.ts +1 -1
  49. package/dist-types/commands/SetUICustomizationCommand.d.ts +3 -3
  50. package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +0 -1
  51. package/dist-types/commands/SignUpCommand.d.ts +0 -1
  52. package/dist-types/commands/TagResourceCommand.d.ts +3 -3
  53. package/dist-types/commands/UpdateGroupCommand.d.ts +1 -1
  54. package/dist-types/commands/UpdateResourceServerCommand.d.ts +2 -2
  55. package/dist-types/commands/UpdateUserAttributesCommand.d.ts +0 -1
  56. package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +3 -3
  57. package/dist-types/commands/UpdateUserPoolCommand.d.ts +0 -1
  58. package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts +7 -7
  59. package/dist-types/commands/VerifyUserAttributeCommand.d.ts +1 -1
  60. package/dist-types/index.d.ts +2 -2
  61. package/dist-types/models/models_0.d.ts +627 -658
  62. package/dist-types/models/models_1.d.ts +74 -74
  63. package/dist-types/ts3.4/models/models_0.d.ts +3 -0
  64. package/dist-types/ts3.4/models/models_1.d.ts +3 -0
  65. package/package.json +17 -18
@@ -25,7 +25,7 @@ export interface AdminResetUserPasswordCommandOutput extends AdminResetUserPassw
25
25
  * @public
26
26
  * <p>Resets the specified user's password in a user pool as an administrator. Works on any
27
27
  * user.</p>
28
- * <p>When a developer calls this API, the current password is invalidated, so it must be
28
+ * <p>When a developer calls this API, the current password is invalidated, so it must be
29
29
  * changed. If a user tries to sign in after the API is called, the app will get a
30
30
  * PasswordResetRequiredException exception back and should direct the user down the flow
31
31
  * to reset the password, which is the same as the forgot password flow. In addition, if
@@ -33,7 +33,6 @@ export interface AdminResetUserPasswordCommandOutput extends AdminResetUserPassw
33
33
  * user, or if email verification is selected and a verified email exists for the user,
34
34
  * calling this API will also result in sending a message to the end user with the code to
35
35
  * change their password.</p>
36
- *
37
36
  * <note>
38
37
  * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
39
38
  * require you to register an origination phone number before you can send SMS messages
@@ -51,8 +50,7 @@ export interface AdminResetUserPasswordCommandOutput extends AdminResetUserPassw
51
50
  * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
52
51
  * Developer Guide</i>.</p>
53
52
  * </note>
54
- *
55
- * <p>Calling this action requires developer credentials.</p>
53
+ * <p>Calling this action requires developer credentials.</p>
56
54
  * @example
57
55
  * Use a bare-bones client and the command you need to make an API call.
58
56
  * ```javascript
@@ -24,7 +24,6 @@ export interface AdminRespondToAuthChallengeCommandOutput extends AdminRespondTo
24
24
  /**
25
25
  * @public
26
26
  * <p>Responds to an authentication challenge, as an administrator.</p>
27
- *
28
27
  * <note>
29
28
  * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
30
29
  * require you to register an origination phone number before you can send SMS messages
@@ -42,8 +41,7 @@ export interface AdminRespondToAuthChallengeCommandOutput extends AdminRespondTo
42
41
  * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
43
42
  * Developer Guide</i>.</p>
44
43
  * </note>
45
- *
46
- * <p>Calling this action requires developer credentials.</p>
44
+ * <p>Calling this action requires developer credentials.</p>
47
45
  * @example
48
46
  * Use a bare-bones client and the command you need to make an API call.
49
47
  * ```javascript
@@ -25,13 +25,13 @@ export interface AdminSetUserPasswordCommandOutput extends AdminSetUserPasswordR
25
25
  * @public
26
26
  * <p>Sets the specified user's password in a user pool as an administrator. Works on any
27
27
  * user. </p>
28
- * <p>The password can be temporary or permanent. If it is temporary, the user status enters
28
+ * <p>The password can be temporary or permanent. If it is temporary, the user status enters
29
29
  * the <code>FORCE_CHANGE_PASSWORD</code> state. When the user next tries to sign in, the
30
30
  * InitiateAuth/AdminInitiateAuth response will contain the
31
31
  * <code>NEW_PASSWORD_REQUIRED</code> challenge. If the user doesn't sign in before it
32
32
  * expires, the user won't be able to sign in, and an administrator must reset their
33
33
  * password. </p>
34
- * <p>Once the user has set a new password, or the password is permanent, the user status is
34
+ * <p>Once the user has set a new password, or the password is permanent, the user status is
35
35
  * set to <code>Confirmed</code>.</p>
36
36
  * @example
37
37
  * Use a bare-bones client and the command you need to make an API call.
@@ -24,7 +24,7 @@ export interface AdminUpdateDeviceStatusCommandOutput extends AdminUpdateDeviceS
24
24
  /**
25
25
  * @public
26
26
  * <p>Updates the device status as an administrator.</p>
27
- * <p>Calling this action requires developer credentials.</p>
27
+ * <p>Calling this action requires developer credentials.</p>
28
28
  * @example
29
29
  * Use a bare-bones client and the command you need to make an API call.
30
30
  * ```javascript
@@ -25,11 +25,10 @@ export interface AdminUpdateUserAttributesCommandOutput extends AdminUpdateUserA
25
25
  * @public
26
26
  * <p>Updates the specified user's attributes, including developer attributes, as an
27
27
  * administrator. Works on any user.</p>
28
- * <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the
28
+ * <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the
29
29
  * attribute name.</p>
30
- * <p>In addition to updating user attributes, this API can also be used to mark phone and
30
+ * <p>In addition to updating user attributes, this API can also be used to mark phone and
31
31
  * email as verified.</p>
32
- *
33
32
  * <note>
34
33
  * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
35
34
  * require you to register an origination phone number before you can send SMS messages
@@ -47,8 +46,7 @@ export interface AdminUpdateUserAttributesCommandOutput extends AdminUpdateUserA
47
46
  * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
48
47
  * Developer Guide</i>.</p>
49
48
  * </note>
50
- *
51
- * <p>Calling this action requires developer credentials.</p>
49
+ * <p>Calling this action requires developer credentials.</p>
52
50
  * @example
53
51
  * Use a bare-bones client and the command you need to make an API call.
54
52
  * ```javascript
@@ -29,7 +29,7 @@ export interface AdminUserGlobalSignOutCommandOutput extends AdminUserGlobalSign
29
29
  * default, access and ID tokens expire one hour after they're issued. A user can still use
30
30
  * a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period
31
31
  * of 1 hour.</p>
32
- * <p>Calling this action requires developer credentials.</p>
32
+ * <p>Calling this action requires developer credentials.</p>
33
33
  * @example
34
34
  * Use a bare-bones client and the command you need to make an API call.
35
35
  * ```javascript
@@ -28,7 +28,7 @@ export interface AssociateSoftwareTokenCommandOutput extends AssociateSoftwareTo
28
28
  * response. You can authorize an <code>AssociateSoftwareToken</code> request with either
29
29
  * the user's access token, or a session string from a challenge response that you received
30
30
  * from Amazon Cognito.</p>
31
- * <note>
31
+ * <note>
32
32
  * <p>Amazon Cognito disassociates an existing software token when you verify the new token in a
33
33
  * <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifySoftwareToken.html"> VerifySoftwareToken</a> API request. If you don't verify the software
34
34
  * token and your user pool doesn't require MFA, the user can then authenticate with
@@ -39,7 +39,7 @@ export interface AssociateSoftwareTokenCommandOutput extends AssociateSoftwareTo
39
39
  * <p>After you set up software token MFA for your user, Amazon Cognito generates a
40
40
  * <code>SOFTWARE_TOKEN_MFA</code> challenge when they authenticate. Respond to
41
41
  * this challenge with your user's TOTP.</p>
42
- * </note>
42
+ * </note>
43
43
  * @example
44
44
  * Use a bare-bones client and the command you need to make an API call.
45
45
  * ```javascript
@@ -24,7 +24,7 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat
24
24
  /**
25
25
  * @public
26
26
  * <p>Creates a new group in the specified user pool.</p>
27
- * <p>Calling this action requires developer credentials.</p>
27
+ * <p>Calling this action requires developer credentials.</p>
28
28
  * @example
29
29
  * Use a bare-bones client and the command you need to make an API call.
30
30
  * ```javascript
@@ -24,7 +24,7 @@ export interface CreateUserPoolClientCommandOutput extends CreateUserPoolClientR
24
24
  /**
25
25
  * @public
26
26
  * <p>Creates the user pool client.</p>
27
- * <p>When you create a new user pool client, token revocation is automatically activated.
27
+ * <p>When you create a new user pool client, token revocation is automatically activated.
28
28
  * For more information about revoking tokens, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
29
29
  * @example
30
30
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,7 +25,6 @@ export interface CreateUserPoolCommandOutput extends CreateUserPoolResponse, __M
25
25
  * @public
26
26
  * <p>Creates a new Amazon Cognito user pool and sets the password policy for the
27
27
  * pool.</p>
28
- *
29
28
  * <note>
30
29
  * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
31
30
  * require you to register an origination phone number before you can send SMS messages
@@ -24,7 +24,7 @@ export interface DeleteGroupCommandOutput extends __MetadataBearer {
24
24
  /**
25
25
  * @public
26
26
  * <p>Deletes a group.</p>
27
- * <p>Calling this action requires developer credentials.</p>
27
+ * <p>Calling this action requires developer credentials.</p>
28
28
  * @example
29
29
  * Use a bare-bones client and the command you need to make an API call.
30
30
  * ```javascript
@@ -31,7 +31,6 @@ export interface ForgotPasswordCommandOutput extends ForgotPasswordResponse, __M
31
31
  * neither a verified phone number nor a verified email exists, an
32
32
  * <code>InvalidParameterException</code> is thrown. To use the confirmation code for
33
33
  * resetting the password, call <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html">ConfirmForgotPassword</a>. </p>
34
- *
35
34
  * <note>
36
35
  * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
37
36
  * require you to register an origination phone number before you can send SMS messages
@@ -24,7 +24,7 @@ export interface GetGroupCommandOutput extends GetGroupResponse, __MetadataBeare
24
24
  /**
25
25
  * @public
26
26
  * <p>Gets a group.</p>
27
- * <p>Calling this action requires developer credentials.</p>
27
+ * <p>Calling this action requires developer credentials.</p>
28
28
  * @example
29
29
  * Use a bare-bones client and the command you need to make an API call.
30
30
  * ```javascript
@@ -24,7 +24,7 @@ export interface GetSigningCertificateCommandOutput extends GetSigningCertificat
24
24
  /**
25
25
  * @public
26
26
  * <p>This method takes a user pool ID, and returns the signing certificate. The issued certificate is valid for 10 years from the date of issue.</p>
27
- * <p>Amazon Cognito issues and assigns a new signing certificate annually. This process returns a new value in the response to <code>GetSigningCertificate</code>,
27
+ * <p>Amazon Cognito issues and assigns a new signing certificate annually. This process returns a new value in the response to <code>GetSigningCertificate</code>,
28
28
  * but doesn't invalidate the original certificate.</p>
29
29
  * @example
30
30
  * Use a bare-bones client and the command you need to make an API call.
@@ -26,7 +26,6 @@ export interface GetUserAttributeVerificationCodeCommandOutput extends GetUserAt
26
26
  * <p>Generates a user attribute verification code for the specified attribute name. Sends a
27
27
  * message to a user with a code that they must return in a VerifyUserAttribute
28
28
  * request.</p>
29
- *
30
29
  * <note>
31
30
  * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
32
31
  * require you to register an origination phone number before you can send SMS messages
@@ -25,7 +25,6 @@ export interface InitiateAuthCommandOutput extends InitiateAuthResponse, __Metad
25
25
  * @public
26
26
  * <p>Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user
27
27
  * with a federated IdP with <code>InitiateAuth</code>. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html"> Adding user pool sign-in through a third party</a>.</p>
28
- *
29
28
  * <note>
30
29
  * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
31
30
  * require you to register an origination phone number before you can send SMS messages
@@ -24,7 +24,7 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB
24
24
  /**
25
25
  * @public
26
26
  * <p>Lists the groups associated with a user pool.</p>
27
- * <p>Calling this action requires developer credentials.</p>
27
+ * <p>Calling this action requires developer credentials.</p>
28
28
  * @example
29
29
  * Use a bare-bones client and the command you need to make an API call.
30
30
  * ```javascript
@@ -24,9 +24,9 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
24
24
  /**
25
25
  * @public
26
26
  * <p>Lists the tags that are assigned to an Amazon Cognito user pool.</p>
27
- * <p>A tag is a label that you can apply to user pools to categorize and manage them in
27
+ * <p>A tag is a label that you can apply to user pools to categorize and manage them in
28
28
  * different ways, such as by purpose, owner, environment, or other criteria.</p>
29
- * <p>You can use this action up to 10 times per second, per account.</p>
29
+ * <p>You can use this action up to 10 times per second, per account.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -24,7 +24,7 @@ export interface ListUsersInGroupCommandOutput extends ListUsersInGroupResponse,
24
24
  /**
25
25
  * @public
26
26
  * <p>Lists the users in the specified group.</p>
27
- * <p>Calling this action requires developer credentials.</p>
27
+ * <p>Calling this action requires developer credentials.</p>
28
28
  * @example
29
29
  * Use a bare-bones client and the command you need to make an API call.
30
30
  * ```javascript
@@ -25,7 +25,6 @@ export interface ResendConfirmationCodeCommandOutput extends ResendConfirmationC
25
25
  * @public
26
26
  * <p>Resends the confirmation (for confirmation of registration) to a specific user in the
27
27
  * user pool.</p>
28
- *
29
28
  * <note>
30
29
  * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
31
30
  * require you to register an origination phone number before you can send SMS messages
@@ -24,7 +24,6 @@ export interface RespondToAuthChallengeCommandOutput extends RespondToAuthChalle
24
24
  /**
25
25
  * @public
26
26
  * <p>Responds to the authentication challenge.</p>
27
- *
28
27
  * <note>
29
28
  * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
30
29
  * require you to register an origination phone number before you can send SMS messages
@@ -26,7 +26,7 @@ export interface SetRiskConfigurationCommandOutput extends SetRiskConfigurationR
26
26
  * <p>Configures actions on detected risks. To delete the risk configuration for
27
27
  * <code>UserPoolId</code> or <code>ClientId</code>, pass null values for all four
28
28
  * configuration types.</p>
29
- * <p>To activate Amazon Cognito advanced security features, update the user pool to include the
29
+ * <p>To activate Amazon Cognito advanced security features, update the user pool to include the
30
30
  * <code>UserPoolAddOns</code> key<code>AdvancedSecurityMode</code>.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,17 +25,17 @@ export interface SetUICustomizationCommandOutput extends SetUICustomizationRespo
25
25
  * @public
26
26
  * <p>Sets the user interface (UI) customization information for a user pool's built-in app
27
27
  * UI.</p>
28
- * <p>You can specify app UI customization settings for a single client (with a specific
28
+ * <p>You can specify app UI customization settings for a single client (with a specific
29
29
  * <code>clientId</code>) or for all clients (by setting the <code>clientId</code> to
30
30
  * <code>ALL</code>). If you specify <code>ALL</code>, the default configuration is
31
31
  * used for every client that has no previously set UI customization. If you specify UI
32
32
  * customization settings for a particular client, it will no longer return to the
33
33
  * <code>ALL</code> configuration.</p>
34
- * <note>
34
+ * <note>
35
35
  * <p>To use this API, your user pool must have a domain associated with it. Otherwise,
36
36
  * there is no place to host the app's pages, and the service will throw an
37
37
  * error.</p>
38
- * </note>
38
+ * </note>
39
39
  * @example
40
40
  * Use a bare-bones client and the command you need to make an API call.
41
41
  * ```javascript
@@ -24,7 +24,6 @@ export interface SetUserPoolMfaConfigCommandOutput extends SetUserPoolMfaConfigR
24
24
  /**
25
25
  * @public
26
26
  * <p>Sets the user pool multi-factor authentication (MFA) configuration.</p>
27
- *
28
27
  * <note>
29
28
  * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
30
29
  * require you to register an origination phone number before you can send SMS messages
@@ -25,7 +25,6 @@ export interface SignUpCommandOutput extends SignUpResponse, __MetadataBearer {
25
25
  * @public
26
26
  * <p>Registers the user in the specified user pool and creates a user name, password, and
27
27
  * user attributes.</p>
28
- *
29
28
  * <note>
30
29
  * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
31
30
  * require you to register an origination phone number before you can send SMS messages
@@ -26,16 +26,16 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
26
26
  * <p>Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to
27
27
  * categorize and manage user pools in different ways, such as by purpose, owner,
28
28
  * environment, or other criteria.</p>
29
- * <p>Each tag consists of a key and value, both of which you define. A key is a general
29
+ * <p>Each tag consists of a key and value, both of which you define. A key is a general
30
30
  * category for more specific values. For example, if you have two versions of a user pool,
31
31
  * one for testing and another for production, you might assign an <code>Environment</code>
32
32
  * tag key to both user pools. The value of this key might be <code>Test</code> for one
33
33
  * user pool, and <code>Production</code> for the other.</p>
34
- * <p>Tags are useful for cost tracking and access control. You can activate your tags so
34
+ * <p>Tags are useful for cost tracking and access control. You can activate your tags so
35
35
  * that they appear on the Billing and Cost Management console, where you can track the
36
36
  * costs associated with your user pools. In an Identity and Access Management policy, you can constrain
37
37
  * permissions for user pools based on specific tags or tag values.</p>
38
- * <p>You can use this action up to 5 times per second, per account. A user pool can have as
38
+ * <p>You can use this action up to 5 times per second, per account. A user pool can have as
39
39
  * many as 50 tags.</p>
40
40
  * @example
41
41
  * Use a bare-bones client and the command you need to make an API call.
@@ -24,7 +24,7 @@ export interface UpdateGroupCommandOutput extends UpdateGroupResponse, __Metadat
24
24
  /**
25
25
  * @public
26
26
  * <p>Updates the specified group with the specified attributes.</p>
27
- * <p>Calling this action requires developer credentials.</p>
27
+ * <p>Calling this action requires developer credentials.</p>
28
28
  * @example
29
29
  * Use a bare-bones client and the command you need to make an API call.
30
30
  * ```javascript
@@ -24,10 +24,10 @@ export interface UpdateResourceServerCommandOutput extends UpdateResourceServerR
24
24
  /**
25
25
  * @public
26
26
  * <p>Updates the name and scopes of resource server. All other fields are read-only.</p>
27
- * <important>
27
+ * <important>
28
28
  * <p>If you don't provide a value for an attribute, it is set to the default
29
29
  * value.</p>
30
- * </important>
30
+ * </important>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -24,7 +24,6 @@ export interface UpdateUserAttributesCommandOutput extends UpdateUserAttributesR
24
24
  /**
25
25
  * @public
26
26
  * <p>Allows a user to update a specific attribute (one at a time).</p>
27
- *
28
27
  * <note>
29
28
  * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
30
29
  * require you to register an origination phone number before you can send SMS messages
@@ -25,11 +25,11 @@ export interface UpdateUserPoolClientCommandOutput extends UpdateUserPoolClientR
25
25
  * @public
26
26
  * <p>Updates the specified user pool app client with the specified attributes. You can get
27
27
  * a list of the current user pool app client settings using <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html">DescribeUserPoolClient</a>.</p>
28
- * <important>
28
+ * <important>
29
29
  * <p>If you don't provide a value for an attribute, it will be set to the default
30
30
  * value.</p>
31
- * </important>
32
- * <p>You can also use this operation to enable token revocation for user pool clients. For
31
+ * </important>
32
+ * <p>You can also use this operation to enable token revocation for user pool clients. For
33
33
  * more information about revoking tokens, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
34
34
  * @example
35
35
  * Use a bare-bones client and the command you need to make an API call.
@@ -27,7 +27,6 @@ export interface UpdateUserPoolCommandOutput extends UpdateUserPoolResponse, __M
27
27
  * the current user pool settings using <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>. If you don't provide a value for an attribute, it will be
28
28
  * set to the default value.
29
29
  * </p>
30
- *
31
30
  * <note>
32
31
  * <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
33
32
  * require you to register an origination phone number before you can send SMS messages
@@ -25,23 +25,23 @@ export interface UpdateUserPoolDomainCommandOutput extends UpdateUserPoolDomainR
25
25
  * @public
26
26
  * <p>Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user
27
27
  * pool.</p>
28
- * <p>You can use this operation to provide the Amazon Resource Name (ARN) of a new
28
+ * <p>You can use this operation to provide the Amazon Resource Name (ARN) of a new
29
29
  * certificate to Amazon Cognito. You can't use it to change the domain for a user pool.</p>
30
- * <p>A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and
30
+ * <p>A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and
31
31
  * sign-in pages for your application. When you set up a custom domain, you provide a
32
32
  * certificate that you manage with Certificate Manager (ACM). When necessary, you can use this
33
33
  * operation to change the certificate that you applied to your custom domain.</p>
34
- * <p>Usually, this is unnecessary following routine certificate renewal with ACM. When
34
+ * <p>Usually, this is unnecessary following routine certificate renewal with ACM. When
35
35
  * you renew your existing certificate in ACM, the ARN for your certificate remains the
36
36
  * same, and your custom domain uses the new certificate automatically.</p>
37
- * <p>However, if you replace your existing certificate with a new one, ACM gives the new
37
+ * <p>However, if you replace your existing certificate with a new one, ACM gives the new
38
38
  * certificate a new ARN. To apply the new certificate to your custom domain, you must
39
39
  * provide this ARN to Amazon Cognito.</p>
40
- * <p>When you add your new certificate in ACM, you must choose US East (N. Virginia) as
40
+ * <p>When you add your new certificate in ACM, you must choose US East (N. Virginia) as
41
41
  * the Amazon Web Services Region.</p>
42
- * <p>After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new
42
+ * <p>After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new
43
43
  * certificate to your custom domain.</p>
44
- * <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>
44
+ * <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>
45
45
  * @example
46
46
  * Use a bare-bones client and the command you need to make an API call.
47
47
  * ```javascript
@@ -24,7 +24,7 @@ export interface VerifyUserAttributeCommandOutput extends VerifyUserAttributeRes
24
24
  /**
25
25
  * @public
26
26
  * <p>Verifies the specified user attributes in the user pool.</p>
27
- * <p>
27
+ * <p>
28
28
  * If your user pool requires verification before Amazon Cognito updates the attribute value,
29
29
  * VerifyUserAttribute updates the affected attribute to its pending value. For more information,
30
30
  * see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserAttributeUpdateSettingsType.html">
@@ -2,8 +2,8 @@
2
2
  * <p>Using the Amazon Cognito user pools API, you can create a user pool to manage directories and
3
3
  * users. You can authenticate a user to obtain tokens related to user identity and access
4
4
  * policies.</p>
5
- * <p>This API reference provides information about user pools in Amazon Cognito user pools.</p>
6
- * <p>For more information, see the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html">Amazon Cognito
5
+ * <p>This API reference provides information about user pools in Amazon Cognito user pools.</p>
6
+ * <p>For more information, see the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html">Amazon Cognito
7
7
  * Documentation</a>.</p>
8
8
  *
9
9
  * @packageDocumentation