@aws-sdk/client-cognito-identity-provider 3.47.2 → 3.51.0

package/dist-types/CognitoIdentityProviderClient.d.ts

@@ -227,13 +227,9 @@ declare type CognitoIdentityProviderClientResolvedConfigType = __SmithyResolvedC
 export interface CognitoIdentityProviderClientResolvedConfig extends CognitoIdentityProviderClientResolvedConfigType {
 }
 /**
- * <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>
- *         <p>This API reference provides information about user pools in Amazon Cognito User
- *             Pools.</p>
- *         <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>
+ * <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>
+ *         <p>This API reference provides information about user pools in Amazon Cognito user pools.</p>
+ *         <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>
  */
 export declare class CognitoIdentityProviderClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, CognitoIdentityProviderClientResolvedConfig> {
     /**

package/dist-types/commands/AdminConfirmSignUpCommand.d.ts

@@ -7,8 +7,7 @@ export interface AdminConfirmSignUpCommandInput extends AdminConfirmSignUpReques
 export interface AdminConfirmSignUpCommandOutput extends AdminConfirmSignUpResponse, __MetadataBearer {
 }
 /**
- * <p>Confirms user registration as an admin without using a confirmation code. Works on any
- *             user.</p>
+ * <p>Confirms user registration as an admin without using a confirmation code. Works on any user.</p>
  *         <p>Calling this action requires developer credentials.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

package/dist-types/commands/AdminCreateUserCommand.d.ts

@@ -8,33 +8,30 @@ export interface AdminCreateUserCommandOutput extends AdminCreateUserResponse, _
 }
 /**
  * <p>Creates a new user in the specified user pool.</p>
- *         <p>If <code>MessageAction</code> is not set, the default is to send a welcome message via
- *             email or phone (SMS).</p>
+ *         <p>If <code>MessageAction</code> isn't set, the default is to send a welcome message via email or phone (SMS).</p>
+ *
  *
  *         <note>
- *             <p>This action might generate an SMS text message. Starting June 1, 2021, U.S.
- *                 telecom carriers require that you register an 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 register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
- *                 Cognito  will use the the registered number automatically. Otherwise, Cognito users that must
- *                 receive SMS messages might be unable to sign up, activate their accounts, or sign
- *                 in.</p>
- *             <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In <i>
- *                   <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
- *                     mode</a>
- *                </i>, you’ll have limitations, such as sending messages
- *                 to only verified phone numbers. After testing in the sandbox environment, you can
- *                 move out of the SMS 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 Cognito User Pools</a> in the <i>Amazon
- *                         Cognito Developer Guide</i>. </p>
+ *             <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
+ *             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
+ *             register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
+ *             automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
+ *             or sign in.</p>
+ *             <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
+ *                 might place your account in SMS sandbox. In
+ *                 <i>
+ *                   <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
+ *                </i>, you will have
+ *                 limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
+ *                 out of the SMS 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 Developer Guide</i>.</p>
  *         </note>
  *
- *         <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 user name and temporary password.</p>
- *         <p>Alternatively, you can call <code>AdminCreateUser</code> with “SUPPRESS” for the
- *                 <code>MessageAction</code> parameter, and Amazon Cognito will not send any email. </p>
- *         <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>
+ *         <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
+ *             user name and temporary password.</p>
+ *         <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>
+ *         <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>
  *         <p>
  *             <code>AdminCreateUser</code> requires developer credentials.</p>
  * @example

package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts

@@ -7,8 +7,7 @@ export interface AdminDeleteUserAttributesCommandInput extends AdminDeleteUserAt
 export interface AdminDeleteUserAttributesCommandOutput extends AdminDeleteUserAttributesResponse, __MetadataBearer {
 }
 /**
- * <p>Deletes the user attributes in a user pool as an administrator. Works on any
- *             user.</p>
+ * <p>Deletes the user attributes in a user pool as an administrator. Works on any user.</p>
  *         <p>Calling this action requires developer credentials.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts

@@ -7,34 +7,20 @@ export interface AdminDisableProviderForUserCommandInput extends AdminDisablePro
 export interface AdminDisableProviderForUserCommandOutput extends AdminDisableProviderForUserResponse, __MetadataBearer {
 }
 /**
- * <p>Disables the user from signing in with the specified external (SAML or social)
- *             identity provider. If the user to disable is a Cognito User Pools native username +
- *             password user, they are not permitted to use their password to sign-in. If the user to
- *             disable is a linked external IdP user, any link between that user and an existing 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. See
- *                 <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html">AdminLinkProviderForUser</a>.</p>
- *         <p>This action is enabled only for admin access and requires developer
- *             credentials.</p>
- *         <p>The <code>ProviderName</code> must match the value specified when creating an IdP for
- *             the pool. </p>
- *         <p>To disable 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>, with the <code>ProviderAttributeValue</code> being the
- *             name that is used in the user pool for the user.</p>
- *         <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 subject that was used when the user was originally linked as a source user.</p>
- *         <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> 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 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 be <code>Cognito_Subject</code> and
- *                 <code>ProviderAttributeValue</code> must be the subject of the SAML
- *             assertion.</p>
+ * <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,
+ *             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
+ *             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.
+ *             See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html">AdminLinkProviderForUser</a>.</p>
+ *         <p>This action is enabled only for admin access and requires developer credentials.</p>
+ *         <p>The <code>ProviderName</code> must match the value specified when creating an IdP for the pool. </p>
+ *         <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>.
+ *             The <code>ProviderAttributeValue</code> must be the name that is used in the user pool for the user.</p>
+ *         <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
+ *             subject that was used when the user was originally linked as a source user.</p>
+ *         <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>
+ *             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
+ *             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
+ *             be <code>Cognito_Subject</code> and <code>ProviderAttributeValue</code> must be the subject of the SAML assertion.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/AdminGetUserCommand.d.ts

@@ -7,8 +7,7 @@ export interface AdminGetUserCommandInput extends AdminGetUserRequest {
 export interface AdminGetUserCommandOutput extends AdminGetUserResponse, __MetadataBearer {
 }
 /**
- * <p>Gets the specified user by user name in a user pool as an administrator. Works on any
- *             user.</p>
+ * <p>Gets the specified user by user name in a user pool as an administrator. Works on any user.</p>
  *         <p>Calling this action requires developer credentials.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

package/dist-types/commands/AdminInitiateAuthCommand.d.ts

@@ -11,20 +11,20 @@ export interface AdminInitiateAuthCommandOutput extends AdminInitiateAuthRespons
  *
  *
  *         <note>
- *             <p>This action might generate an SMS text message. Starting June 1, 2021, U.S.
- *                 telecom carriers require that you register an 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 register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
- *                 Cognito  will use the the registered number automatically. Otherwise, Cognito users that must
- *                 receive SMS messages might be unable to sign up, activate their accounts, or sign
- *                 in.</p>
- *             <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In <i>
- *                   <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
- *                     mode</a>
- *                </i>, you’ll have limitations, such as sending messages
- *                 to only verified phone numbers. After testing in the sandbox environment, you can
- *                 move out of the SMS 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 Cognito User Pools</a> in the <i>Amazon
- *                         Cognito Developer Guide</i>. </p>
+ *             <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
+ *             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
+ *             register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
+ *             automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
+ *             or sign in.</p>
+ *             <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
+ *                 might place your account in SMS sandbox. In
+ *                 <i>
+ *                   <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
+ *                </i>, you will have
+ *                 limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
+ *                 out of the SMS 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 Developer Guide</i>.</p>
  *         </note>
  *
  *         <p>Calling this action requires developer credentials.</p>

package/dist-types/commands/AdminLinkProviderForUserCommand.d.ts

@@ -7,27 +7,20 @@ export interface AdminLinkProviderForUserCommandInput extends AdminLinkProviderF
 export interface AdminLinkProviderForUserCommandOutput extends AdminLinkProviderForUserResponse, __MetadataBearer {
 }
 /**
- * <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 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 yet been used to sign in, so that the federated user identity can be used
- *             to sign in as the existing user account. </p>
- *         <p> For example, if there is an existing user with a username and password, this API
- *             links that user to a federated user identity, so that when the federated user identity
- *             is used, the user signs in as the existing user account. </p>
- *         <note>
+ * <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
+ *             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
+ *             yet been used to sign in. You can then use the federated user identity to sign in as the existing user account. </p>
+ *         <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
+ *             identity, they sign in as the existing user account.</p>
+ *          <note>
  *             <p>The maximum number of federated identities linked to a user is 5.</p>
- *         </note>
- *         <important>
- *             <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
- *                 identity providers and provider attributes that have been trusted by the application
- *                 owner.</p>
- *         </important>
+ *          </note>
+ *          <important>
+ *             <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
+ *         identity providers and provider attributes that have been trusted by the application owner.</p>
+ *          </important>
  *
- *         <p>This action is enabled only for admin access and requires developer
- *             credentials.</p>
+ *         <p>This action is administrative and requires developer credentials.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/AdminListUserAuthEventsCommand.d.ts

@@ -7,8 +7,7 @@ export interface AdminListUserAuthEventsCommandInput extends AdminListUserAuthEv
 export interface AdminListUserAuthEventsCommandOutput extends AdminListUserAuthEventsResponse, __MetadataBearer {
 }
 /**
- * <p>Lists a history of user activity and any risks detected as part of Amazon Cognito
- *             advanced security.</p>
+ * <p>A history of user activity and any risks detected as part of Amazon Cognito advanced security.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/AdminResetUserPasswordCommand.d.ts

@@ -7,33 +7,29 @@ export interface AdminResetUserPasswordCommandInput extends AdminResetUserPasswo
 export interface AdminResetUserPasswordCommandOutput extends AdminResetUserPasswordResponse, __MetadataBearer {
 }
 /**
- * <p>Resets the specified user's password in a user pool as an administrator. Works on any
- *             user.</p>
- *         <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, the app will get a
- *             PasswordResetRequiredException exception back and should direct the user down the flow
- *             to reset the password, which is the same 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 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 with the code to
- *             change their password.</p>
+ * <p>Resets the specified user's password in a user pool as an administrator. Works on any user.</p>
+ *         <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,
+ *             the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same
+ *             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
+ *             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
+ *             with the code to change their password.</p>
  *
  *
  *         <note>
- *             <p>This action might generate an SMS text message. Starting June 1, 2021, U.S.
- *                 telecom carriers require that you register an 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 register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
- *                 Cognito  will use the the registered number automatically. Otherwise, Cognito users that must
- *                 receive SMS messages might be unable to sign up, activate their accounts, or sign
- *                 in.</p>
- *             <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In <i>
- *                   <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
- *                     mode</a>
- *                </i>, you’ll have limitations, such as sending messages
- *                 to only verified phone numbers. After testing in the sandbox environment, you can
- *                 move out of the SMS 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 Cognito User Pools</a> in the <i>Amazon
- *                         Cognito Developer Guide</i>. </p>
+ *             <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
+ *             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
+ *             register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
+ *             automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
+ *             or sign in.</p>
+ *             <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
+ *                 might place your account in SMS sandbox. In
+ *                 <i>
+ *                   <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
+ *                </i>, you will have
+ *                 limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
+ *                 out of the SMS 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 Developer Guide</i>.</p>
  *         </note>
  *
  *         <p>Calling this action requires developer credentials.</p>

package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts

@@ -10,20 +10,20 @@ export interface AdminRespondToAuthChallengeCommandOutput extends AdminRespondTo
  * <p>Responds to an authentication challenge, as an administrator.</p>
  *
  *         <note>
- *             <p>This action might generate an SMS text message. Starting June 1, 2021, U.S.
- *                 telecom carriers require that you register an 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 register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
- *                 Cognito  will use the the registered number automatically. Otherwise, Cognito users that must
- *                 receive SMS messages might be unable to sign up, activate their accounts, or sign
- *                 in.</p>
- *             <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In <i>
- *                   <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
- *                     mode</a>
- *                </i>, you’ll have limitations, such as sending messages
- *                 to only verified phone numbers. After testing in the sandbox environment, you can
- *                 move out of the SMS 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 Cognito User Pools</a> in the <i>Amazon
- *                         Cognito Developer Guide</i>. </p>
+ *             <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
+ *             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
+ *             register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
+ *             automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
+ *             or sign in.</p>
+ *             <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
+ *                 might place your account in SMS sandbox. In
+ *                 <i>
+ *                   <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
+ *                </i>, you will have
+ *                 limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
+ *                 out of the SMS 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 Developer Guide</i>.</p>
  *         </note>
  *
  *         <p>Calling this action requires developer credentials.</p>

package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts

@@ -7,11 +7,9 @@ export interface AdminSetUserMFAPreferenceCommandInput extends AdminSetUserMFAPr
 export interface AdminSetUserMFAPreferenceCommandOutput extends AdminSetUserMFAPreferenceResponse, __MetadataBearer {
 }
 /**
- * <p>Sets the user's multi-factor authentication (MFA) preference, including which MFA
- *             options are enabled and if any are preferred. Only one factor can be set as preferred.
- *             The preferred MFA factor will be used to authenticate a user if multiple factors are
- *             enabled. If multiple options are enabled and no preference is set, a challenge to choose
- *             an MFA option will be returned during sign in.</p>
+ * <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
+ *             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
+ *             be returned during sign-in.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/AdminSetUserPasswordCommand.d.ts

@@ -7,16 +7,11 @@ export interface AdminSetUserPasswordCommandInput extends AdminSetUserPasswordRe
 export interface AdminSetUserPasswordCommandOutput extends AdminSetUserPasswordResponse, __MetadataBearer {
 }
 /**
- * <p>Sets the specified user's password in a user pool as an administrator. Works on any
- *             user. </p>
- *         <p>The password can be temporary or permanent. If it is temporary, the user status will
- *             be placed into the <code>FORCE_CHANGE_PASSWORD</code> state. When the user next tries to
- *             sign in, the InitiateAuth/AdminInitiateAuth response will contain the
- *                 <code>NEW_PASSWORD_REQUIRED</code> challenge. If the user does not sign in before it
- *             expires, the user will not be able to sign in and their password will need to be reset
- *             by an administrator. </p>
- *         <p>Once the user has set a new password, or the password is permanent, the user status
- *             will be set to <code>Confirmed</code>.</p>
+ * <p>Sets the specified user's password in a user pool as an administrator. Works on any user. </p>
+ *         <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,
+ *             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
+ *             able to sign in, and an administrator must reset their password. </p>
+ *         <p>Once the user has set a new password, or the password is permanent, the user status is set to <code>Confirmed</code>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/AdminSetUserSettingsCommand.d.ts

@@ -8,9 +8,9 @@ export interface AdminSetUserSettingsCommandOutput extends AdminSetUserSettingsR
 }
 /**
  * <p>
- *             <i>This action is no longer supported.</i> You can use it to configure
- *             only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either
- *             type of MFA, use <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserMFAPreference.html">AdminSetUserMFAPreference</a> instead.</p>
+ *             <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. To configure either type of MFA,
+ *             use <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserMFAPreference.html">AdminSetUserMFAPreference</a> instead.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts

@@ -7,9 +7,8 @@ export interface AdminUpdateAuthEventFeedbackCommandInput extends AdminUpdateAut
 export interface AdminUpdateAuthEventFeedbackCommandOutput extends AdminUpdateAuthEventFeedbackResponse, __MetadataBearer {
 }
 /**
- * <p>Provides feedback for an authentication event as to whether it was from a valid user.
- *             This feedback is used for improving the risk evaluation decision for the user pool as
- *             part of Amazon Cognito advanced security.</p>
+ * <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
+ *             as part of Amazon Cognito advanced security.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts

@@ -7,28 +7,25 @@ export interface AdminUpdateUserAttributesCommandInput extends AdminUpdateUserAt
 export interface AdminUpdateUserAttributesCommandOutput extends AdminUpdateUserAttributesResponse, __MetadataBearer {
 }
 /**
- * <p>Updates the specified user's attributes, including developer attributes, as an
- *             administrator. Works on any user.</p>
- *         <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the
- *             attribute name.</p>
- *         <p>In addition to updating user attributes, this API can also be used to mark phone and
- *             email as verified.</p>
+ * <p>Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.</p>
+ *         <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>
+ *         <p>In addition to updating user attributes, this API can also be used to mark phone and email as verified.</p>
  *
  *         <note>
- *             <p>This action might generate an SMS text message. Starting June 1, 2021, U.S.
- *                 telecom carriers require that you register an 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 register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
- *                 Cognito  will use the the registered number automatically. Otherwise, Cognito users that must
- *                 receive SMS messages might be unable to sign up, activate their accounts, or sign
- *                 in.</p>
- *             <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In <i>
- *                   <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
- *                     mode</a>
- *                </i>, you’ll have limitations, such as sending messages
- *                 to only verified phone numbers. After testing in the sandbox environment, you can
- *                 move out of the SMS 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 Cognito User Pools</a> in the <i>Amazon
- *                         Cognito Developer Guide</i>. </p>
+ *             <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an
+ *             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
+ *             register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito will use the registered number
+ *             automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts,
+ *             or sign in.</p>
+ *             <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service
+ *                 might place your account in SMS sandbox. In
+ *                 <i>
+ *                   <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a>
+ *                </i>, you will have
+ *                 limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move
+ *                 out of the SMS 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 Developer Guide</i>.</p>
  *         </note>
  *
  *         <p>Calling this action requires developer credentials.</p>

package/dist-types/commands/AdminUserGlobalSignOutCommand.d.ts

@@ -7,9 +7,8 @@ export interface AdminUserGlobalSignOutCommandInput extends AdminUserGlobalSignO
 export interface AdminUserGlobalSignOutCommandOutput extends AdminUserGlobalSignOutResponse, __MetadataBearer {
 }
 /**
- * <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 Id tokens expire one hour after they are issued.</p>
+ * <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
+ *             Id tokens expire one hour after they're issued.</p>
  *         <p>Calling this action requires developer credentials.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts

@@ -7,16 +7,12 @@ export interface AssociateSoftwareTokenCommandInput extends AssociateSoftwareTok
 export interface AssociateSoftwareTokenCommandOutput extends AssociateSoftwareTokenResponse, __MetadataBearer {
 }
 /**
- * <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>
- *         <note>
- *             <p>Calling AssociateSoftwareToken immediately disassociates the existing software
- *                 token from the user account. If the user doesn't subsequently verify the software
- *                 token, their account is essentially set up to authenticate without MFA. If MFA
- *                 config is set to Optional at the user pool level, the user can then login without
- *                 MFA. However, if MFA is set to Required for the user pool, the user will be asked to
- *                 setup a new software token MFA during sign in.</p>
- *         </note>
+ * <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>
+ *          <note>
+ *             <p>Calling AssociateSoftwareToken immediately disassociates the existing software token from the user account. If the user doesn't subsequently verify the software token,
+ *             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
+ *             set to Required for the user pool, the user is asked to set up a new software token MFA during sign-in.</p>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/ConfirmDeviceCommand.d.ts

@@ -7,8 +7,7 @@ export interface ConfirmDeviceCommandInput extends ConfirmDeviceRequest {
 export interface ConfirmDeviceCommandOutput extends ConfirmDeviceResponse, __MetadataBearer {
 }
 /**
- * <p>Confirms tracking of the device. This API call is the call that begins device
- *             tracking.</p>
+ * <p>Confirms tracking of the device. This API call is the call that begins device tracking.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/ConfirmSignUpCommand.d.ts

@@ -7,8 +7,7 @@ export interface ConfirmSignUpCommandInput extends ConfirmSignUpRequest {
 export interface ConfirmSignUpCommandOutput extends ConfirmSignUpResponse, __MetadataBearer {
 }
 /**
- * <p>Confirms registration of a user and handles the existing alias from a previous
- *             user.</p>
+ * <p>Confirms registration of a user and handles the existing alias from a previous user.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/CreateResourceServerCommand.d.ts

@@ -7,7 +7,7 @@ export interface CreateResourceServerCommandInput extends CreateResourceServerRe
 export interface CreateResourceServerCommandOutput extends CreateResourceServerResponse, __MetadataBearer {
 }
 /**
- * <p>Creates a new OAuth2.0 resource server and defines custom scopes in it.</p>
+ * <p>Creates a new OAuth2.0 resource server and defines custom scopes within it.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/CreateUserPoolClientCommand.d.ts

@@ -8,8 +8,8 @@ export interface CreateUserPoolClientCommandOutput extends CreateUserPoolClientR
 }
 /**
  * <p>Creates the user pool client.</p>
- *         <p>When you create a new user pool client, token revocation is automatically enabled. 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>
+ *         <p>When you create a new user pool client, token revocation is automatically activated. 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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript