@aws-sdk/client-cognito-identity-provider 3.92.0 → 3.98.0

package/dist-types/CognitoIdentityProviderClient.d.ts

@@ -227,9 +227,12 @@ 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>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>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,7 +7,8 @@ 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,9 +8,8 @@ export interface AdminCreateUserCommandOutput extends AdminCreateUserResponse, _
 }
 /**
  * <p>Creates a new user in the specified user pool.</p>
- *         <p>If <code>MessageAction</code> isn't 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, US telecom carriers
@@ -30,10 +29,13 @@ export interface AdminCreateUserCommandOutput extends AdminCreateUserResponse, _
  *                     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 <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>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,7 +7,8 @@ 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

@@ -8,22 +8,33 @@ export interface AdminDisableProviderForUserCommandOutput extends AdminDisablePr
 }
 /**
  * <p>Prevents the user from signing in with the specified external (SAML or social)
- *             identity provider. If the user that you want to  deactivate is a Amazon Cognito user pools native
- *             username + password user, they can't 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. When the external user signs in again, and the user is
- *             no longer attached to the previously linked <code>DestinationUser</code>, the user 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>
+ *             identity provider (IdP). If the user that you want to deactivate is a Amazon Cognito user pools
+ *             native username + password user, they can't use their password to sign in. If the user
+ *             to deactivate is a linked external IdP user, any link between that user and an existing
+ *             user is removed. When the external user signs in again, and the user is no longer
+ *             attached to the previously linked <code>DestinationUser</code>, the user 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 IdPs. 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,7 +7,8 @@ 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

@@ -9,7 +9,6 @@ export interface AdminInitiateAuthCommandOutput extends AdminInitiateAuthRespons
 /**
  * <p>Initiates the authentication flow, as an administrator.</p>
  *
- *
  *          <note>
  *             <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

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

@@ -7,18 +7,23 @@ 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. 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>
+ * <p>Links an existing user account in a user pool (<code>DestinationUser</code>) to an
+ *             identity from an external IdP (<code>SourceUser</code>) based on a specified attribute
+ *             name and value from the external IdP. 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 five.</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
+ *                 IdPs and provider attributes that have been trusted by the application owner.</p>
+ *         </important>
  *
  *         <p>This action is administrative and requires developer credentials.</p>
  * @example

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

@@ -7,7 +7,8 @@ export interface AdminListUserAuthEventsCommandInput extends AdminListUserAuthEv
 export interface AdminListUserAuthEventsCommandOutput extends AdminListUserAuthEventsResponse, __MetadataBearer {
 }
 /**
- * <p>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,12 +7,16 @@ 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, US telecom carriers

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

@@ -7,9 +7,11 @@ export interface AdminSetUserMFAPreferenceCommandInput extends AdminSetUserMFAPr
 export interface AdminSetUserMFAPreferenceCommandOutput extends AdminSetUserMFAPreferenceResponse, __MetadataBearer {
 }
 /**
- * <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>
+ * <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,11 +7,16 @@ 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 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>
+ * <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 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>
+ *             <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,8 +7,9 @@ export interface AdminUpdateAuthEventFeedbackCommandInput extends AdminUpdateAut
 export interface AdminUpdateAuthEventFeedbackCommandOutput extends AdminUpdateAuthEventFeedbackResponse, __MetadataBearer {
 }
 /**
- * <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>
+ * <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,9 +7,12 @@ 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, US telecom carriers

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

@@ -7,8 +7,12 @@ 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're issued.</p>
+ * <p>Signs out a user from all devices. You must sign <code>AdminUserGlobalSignOut</code> requests
+ *             with Amazon Web Services credentials. It also invalidates all refresh tokens that Amazon Cognito has issued to
+ *             a user. The user's current access and ID tokens remain valid until they expire. By
+ *             default, access and ID tokens expire one hour after they're issued. A user can still use
+ *             a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period
+ *             of 1 hour.</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,12 +7,16 @@ 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 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>
+ * <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,7 +7,8 @@ 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,7 +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 new user.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -7,7 +7,7 @@ export interface CreateIdentityProviderCommandInput extends CreateIdentityProvid
 export interface CreateIdentityProviderCommandOutput extends CreateIdentityProviderResponse, __MetadataBearer {
 }
 /**
- * <p>Creates an identity provider for a user pool.</p>
+ * <p>Creates an IdP for a user pool.</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 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>
+ *         <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

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

@@ -7,7 +7,8 @@ export interface CreateUserPoolCommandInput extends CreateUserPoolRequest {
 export interface CreateUserPoolCommandOutput extends CreateUserPoolResponse, __MetadataBearer {
 }
 /**
- * <p>Creates a new Amazon Cognito user pool and sets the password policy for the pool.</p>
+ * <p>Creates a new Amazon Cognito user pool and sets the password policy for the
+ *             pool.</p>
  *
  *          <note>
  *             <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers

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

@@ -7,7 +7,7 @@ export interface DeleteIdentityProviderCommandInput extends DeleteIdentityProvid
 export interface DeleteIdentityProviderCommandOutput extends __MetadataBearer {
 }
 /**
- * <p>Deletes an identity provider for a user pool.</p>
+ * <p>Deletes an IdP for a user pool.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -7,7 +7,7 @@ export interface DescribeIdentityProviderCommandInput extends DescribeIdentityPr
 export interface DescribeIdentityProviderCommandOutput extends DescribeIdentityProviderResponse, __MetadataBearer {
 }
 /**
- * <p>Gets information about a specific identity provider.</p>
+ * <p>Gets information about a specific IdP.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -7,7 +7,8 @@ export interface DescribeUserPoolClientCommandInput extends DescribeUserPoolClie
 export interface DescribeUserPoolClientCommandOutput extends DescribeUserPoolClientResponse, __MetadataBearer {
 }
 /**
- * <p>Client method for returning the configuration information and metadata of the specified user pool app client.</p>
+ * <p>Client method for returning the configuration information and metadata of the
+ *             specified user pool app client.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -7,14 +7,14 @@ export interface ForgotPasswordCommandInput extends ForgotPasswordRequest {
 export interface ForgotPasswordCommandOutput extends ForgotPasswordResponse, __MetadataBearer {
 }
 /**
- * <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
- *             <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
- *             specified AccountRecoverySetting. For more information,
- *             see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-recover-a-user-account.html">Recovering User Accounts</a>
- *             in the <i>Amazon Cognito Developer Guide</i>. If neither a verified phone number nor a verified email exists,
- *             an <code>InvalidParameterException</code> is thrown. To use the confirmation code for resetting the password,
- *             call <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html">ConfirmForgotPassword</a>.
- *         </p>
+ * <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 <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 specified AccountRecoverySetting. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-recover-a-user-account.html">Recovering
+ *                 User Accounts</a> in the <i>Amazon Cognito Developer Guide</i>. If
+ *             neither a verified phone number nor a verified email exists, an
+ *                 <code>InvalidParameterException</code> is thrown. To use the confirmation code for
+ *             resetting the password, call <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html">ConfirmForgotPassword</a>. </p>
  *
  *          <note>
  *             <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers

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

@@ -7,7 +7,8 @@ export interface GetCSVHeaderCommandInput extends GetCSVHeaderRequest {
 export interface GetCSVHeaderCommandOutput extends GetCSVHeaderResponse, __MetadataBearer {
 }
 /**
- * <p>Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job.</p>
+ * <p>Gets the header information for the comma-separated value (CSV) file to be used as
+ *             input for the user import job.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -7,7 +7,7 @@ export interface GetIdentityProviderByIdentifierCommandInput extends GetIdentity
 export interface GetIdentityProviderByIdentifierCommandOutput extends GetIdentityProviderByIdentifierResponse, __MetadataBearer {
 }
 /**
- * <p>Gets the specified identity provider.</p>
+ * <p>Gets the specified IdP.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -7,8 +7,11 @@ export interface GetUICustomizationCommandInput extends GetUICustomizationReques
 export interface GetUICustomizationCommandOutput extends GetUICustomizationResponse, __MetadataBearer {
 }
 /**
- * <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,
- *             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>
+ * <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, 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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -7,7 +7,9 @@ export interface GetUserAttributeVerificationCodeCommandInput extends GetUserAtt
 export interface GetUserAttributeVerificationCodeCommandOutput extends GetUserAttributeVerificationCodeResponse, __MetadataBearer {
 }
 /**
- * <p>Gets the user attribute verification code for the specified attribute name.</p>
+ * <p>Generates a user attribute verification code for the specified attribute name. Sends a
+ *             message to a user with a code that they must return in a VerifyUserAttribute
+ *             request.</p>
  *
  *          <note>
  *             <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers

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

@@ -7,8 +7,11 @@ export interface GlobalSignOutCommandInput extends GlobalSignOutRequest {
 export interface GlobalSignOutCommandOutput extends GlobalSignOutResponse, __MetadataBearer {
 }
 /**
- * <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
- *             one hour after they're issued.</p>
+ * <p>Signs out users from all devices. It also invalidates all refresh tokens that Amazon Cognito
+ *             has issued to a user. The user's current access and ID tokens remain valid until their
+ *             expiry. By default, access and ID tokens expire one hour after Amazon Cognito issues them. A user
+ *             can still use a hosted UI cookie to retrieve new tokens for the duration of the cookie
+ *             validity period of 1 hour.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -7,7 +7,8 @@ export interface InitiateAuthCommandInput extends InitiateAuthRequest {
 export interface InitiateAuthCommandOutput extends InitiateAuthResponse, __MetadataBearer {
 }
 /**
- * <p>Initiates the authentication flow.</p>
+ * <p>Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user
+ *             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>
  *
  *          <note>
  *             <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers

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

@@ -7,7 +7,7 @@ export interface ListDevicesCommandInput extends ListDevicesRequest {
 export interface ListDevicesCommandOutput extends ListDevicesResponse, __MetadataBearer {
 }
 /**
- * <p>Lists the devices.</p>
+ * <p>Lists the sign-in devices that Amazon Cognito has registered to the current user.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -7,7 +7,7 @@ export interface ListIdentityProvidersCommandInput extends ListIdentityProviders
 export interface ListIdentityProvidersCommandOutput extends ListIdentityProvidersResponse, __MetadataBearer {
 }
 /**
- * <p>Lists information about all identity providers for a user pool.</p>
+ * <p>Lists information about all IdPs for a user pool.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -8,7 +8,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
 }
 /**
  * <p>Lists the tags that are assigned to an Amazon Cognito user pool.</p>
- *         <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>
+ *         <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>
  *         <p>You can use this action up to 10 times per second, per account.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

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

@@ -7,7 +7,8 @@ export interface ResendConfirmationCodeCommandInput extends ResendConfirmationCo
 export interface ResendConfirmationCodeCommandOutput extends ResendConfirmationCodeResponse, __MetadataBearer {
 }
 /**
- * <p>Resends the confirmation (for confirmation of registration) to a specific user in the user pool.</p>
+ * <p>Resends the confirmation (for confirmation of registration) to a specific user in the
+ *             user pool.</p>
  *
  *          <note>
  *             <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers