@aws-sdk/client-cognito-identity-provider 3.36.0 → 3.39.0

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

@@ -6,49 +6,11 @@ export interface AdminInitiateAuthCommandInput extends AdminInitiateAuthRequest
 }
 export interface AdminInitiateAuthCommandOutput extends AdminInitiateAuthResponse, __MetadataBearer {
 }
-/**
- * <p>Initiates the authentication flow, 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>
- *         </note>
- *
- *         <p>Calling this action requires developer credentials.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { CognitoIdentityProviderClient, AdminInitiateAuthCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
- * // const { CognitoIdentityProviderClient, AdminInitiateAuthCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
- * const client = new CognitoIdentityProviderClient(config);
- * const command = new AdminInitiateAuthCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link AdminInitiateAuthCommandInput} for command's `input` shape.
- * @see {@link AdminInitiateAuthCommandOutput} for command's `response` shape.
- * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class AdminInitiateAuthCommand extends $Command<AdminInitiateAuthCommandInput, AdminInitiateAuthCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
     readonly input: AdminInitiateAuthCommandInput;
     constructor(input: AdminInitiateAuthCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminInitiateAuthCommandInput, AdminInitiateAuthCommandOutput>;
     private serialize;
     private deserialize;

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

@@ -6,49 +6,11 @@ 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>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>This action is enabled only for admin access and requires developer
- *             credentials.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { CognitoIdentityProviderClient, AdminLinkProviderForUserCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
- * // const { CognitoIdentityProviderClient, AdminLinkProviderForUserCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
- * const client = new CognitoIdentityProviderClient(config);
- * const command = new AdminLinkProviderForUserCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link AdminLinkProviderForUserCommandInput} for command's `input` shape.
- * @see {@link AdminLinkProviderForUserCommandOutput} for command's `response` shape.
- * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class AdminLinkProviderForUserCommand extends $Command<AdminLinkProviderForUserCommandInput, AdminLinkProviderForUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
     readonly input: AdminLinkProviderForUserCommandInput;
     constructor(input: AdminLinkProviderForUserCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminLinkProviderForUserCommandInput, AdminLinkProviderForUserCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/AdminListDevicesCommand.d.ts

@@ -6,30 +6,11 @@ export interface AdminListDevicesCommandInput extends AdminListDevicesRequest {
 }
 export interface AdminListDevicesCommandOutput extends AdminListDevicesResponse, __MetadataBearer {
 }
-/**
- * <p>Lists devices, as an administrator.</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.
- * ```javascript
- * import { CognitoIdentityProviderClient, AdminListDevicesCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
- * // const { CognitoIdentityProviderClient, AdminListDevicesCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
- * const client = new CognitoIdentityProviderClient(config);
- * const command = new AdminListDevicesCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link AdminListDevicesCommandInput} for command's `input` shape.
- * @see {@link AdminListDevicesCommandOutput} for command's `response` shape.
- * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class AdminListDevicesCommand extends $Command<AdminListDevicesCommandInput, AdminListDevicesCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
     readonly input: AdminListDevicesCommandInput;
     constructor(input: AdminListDevicesCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminListDevicesCommandInput, AdminListDevicesCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/AdminListGroupsForUserCommand.d.ts

@@ -6,30 +6,11 @@ export interface AdminListGroupsForUserCommandInput extends AdminListGroupsForUs
 }
 export interface AdminListGroupsForUserCommandOutput extends AdminListGroupsForUserResponse, __MetadataBearer {
 }
-/**
- * <p>Lists the groups that the user belongs to.</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.
- * ```javascript
- * import { CognitoIdentityProviderClient, AdminListGroupsForUserCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
- * // const { CognitoIdentityProviderClient, AdminListGroupsForUserCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
- * const client = new CognitoIdentityProviderClient(config);
- * const command = new AdminListGroupsForUserCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link AdminListGroupsForUserCommandInput} for command's `input` shape.
- * @see {@link AdminListGroupsForUserCommandOutput} for command's `response` shape.
- * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class AdminListGroupsForUserCommand extends $Command<AdminListGroupsForUserCommandInput, AdminListGroupsForUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
     readonly input: AdminListGroupsForUserCommandInput;
     constructor(input: AdminListGroupsForUserCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminListGroupsForUserCommandInput, AdminListGroupsForUserCommandOutput>;
     private serialize;
     private deserialize;

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

@@ -6,30 +6,11 @@ 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>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { CognitoIdentityProviderClient, AdminListUserAuthEventsCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
- * // const { CognitoIdentityProviderClient, AdminListUserAuthEventsCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
- * const client = new CognitoIdentityProviderClient(config);
- * const command = new AdminListUserAuthEventsCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link AdminListUserAuthEventsCommandInput} for command's `input` shape.
- * @see {@link AdminListUserAuthEventsCommandOutput} for command's `response` shape.
- * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class AdminListUserAuthEventsCommand extends $Command<AdminListUserAuthEventsCommandInput, AdminListUserAuthEventsCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
     readonly input: AdminListUserAuthEventsCommandInput;
     constructor(input: AdminListUserAuthEventsCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminListUserAuthEventsCommandInput, AdminListUserAuthEventsCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/AdminRemoveUserFromGroupCommand.d.ts

@@ -6,30 +6,11 @@ export interface AdminRemoveUserFromGroupCommandInput extends AdminRemoveUserFro
 }
 export interface AdminRemoveUserFromGroupCommandOutput extends __MetadataBearer {
 }
-/**
- * <p>Removes the specified user from the specified group.</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.
- * ```javascript
- * import { CognitoIdentityProviderClient, AdminRemoveUserFromGroupCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
- * // const { CognitoIdentityProviderClient, AdminRemoveUserFromGroupCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
- * const client = new CognitoIdentityProviderClient(config);
- * const command = new AdminRemoveUserFromGroupCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link AdminRemoveUserFromGroupCommandInput} for command's `input` shape.
- * @see {@link AdminRemoveUserFromGroupCommandOutput} for command's `response` shape.
- * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class AdminRemoveUserFromGroupCommand extends $Command<AdminRemoveUserFromGroupCommandInput, AdminRemoveUserFromGroupCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
     readonly input: AdminRemoveUserFromGroupCommandInput;
     constructor(input: AdminRemoveUserFromGroupCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminRemoveUserFromGroupCommandInput, AdminRemoveUserFromGroupCommandOutput>;
     private serialize;
     private deserialize;

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

@@ -6,58 +6,11 @@ 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>
- *
- *
- *         <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>
- *         </note>
- *
- *         <p>Calling this action requires developer credentials.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { CognitoIdentityProviderClient, AdminResetUserPasswordCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
- * // const { CognitoIdentityProviderClient, AdminResetUserPasswordCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
- * const client = new CognitoIdentityProviderClient(config);
- * const command = new AdminResetUserPasswordCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link AdminResetUserPasswordCommandInput} for command's `input` shape.
- * @see {@link AdminResetUserPasswordCommandOutput} for command's `response` shape.
- * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class AdminResetUserPasswordCommand extends $Command<AdminResetUserPasswordCommandInput, AdminResetUserPasswordCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
     readonly input: AdminResetUserPasswordCommandInput;
     constructor(input: AdminResetUserPasswordCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminResetUserPasswordCommandInput, AdminResetUserPasswordCommandOutput>;
     private serialize;
     private deserialize;

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

@@ -6,48 +6,11 @@ export interface AdminRespondToAuthChallengeCommandInput extends AdminRespondToA
 }
 export interface AdminRespondToAuthChallengeCommandOutput extends AdminRespondToAuthChallengeResponse, __MetadataBearer {
 }
-/**
- * <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>
- *         </note>
- *
- *         <p>Calling this action requires developer credentials.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { CognitoIdentityProviderClient, AdminRespondToAuthChallengeCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
- * // const { CognitoIdentityProviderClient, AdminRespondToAuthChallengeCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
- * const client = new CognitoIdentityProviderClient(config);
- * const command = new AdminRespondToAuthChallengeCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link AdminRespondToAuthChallengeCommandInput} for command's `input` shape.
- * @see {@link AdminRespondToAuthChallengeCommandOutput} for command's `response` shape.
- * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class AdminRespondToAuthChallengeCommand extends $Command<AdminRespondToAuthChallengeCommandInput, AdminRespondToAuthChallengeCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
     readonly input: AdminRespondToAuthChallengeCommandInput;
     constructor(input: AdminRespondToAuthChallengeCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminRespondToAuthChallengeCommandInput, AdminRespondToAuthChallengeCommandOutput>;
     private serialize;
     private deserialize;

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

@@ -6,33 +6,11 @@ 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>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { CognitoIdentityProviderClient, AdminSetUserMFAPreferenceCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
- * // const { CognitoIdentityProviderClient, AdminSetUserMFAPreferenceCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
- * const client = new CognitoIdentityProviderClient(config);
- * const command = new AdminSetUserMFAPreferenceCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link AdminSetUserMFAPreferenceCommandInput} for command's `input` shape.
- * @see {@link AdminSetUserMFAPreferenceCommandOutput} for command's `response` shape.
- * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class AdminSetUserMFAPreferenceCommand extends $Command<AdminSetUserMFAPreferenceCommandInput, AdminSetUserMFAPreferenceCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
     readonly input: AdminSetUserMFAPreferenceCommandInput;
     constructor(input: AdminSetUserMFAPreferenceCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminSetUserMFAPreferenceCommandInput, AdminSetUserMFAPreferenceCommandOutput>;
     private serialize;
     private deserialize;

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

@@ -6,38 +6,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>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { CognitoIdentityProviderClient, AdminSetUserPasswordCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
- * // const { CognitoIdentityProviderClient, AdminSetUserPasswordCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
- * const client = new CognitoIdentityProviderClient(config);
- * const command = new AdminSetUserPasswordCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link AdminSetUserPasswordCommandInput} for command's `input` shape.
- * @see {@link AdminSetUserPasswordCommandOutput} for command's `response` shape.
- * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class AdminSetUserPasswordCommand extends $Command<AdminSetUserPasswordCommandInput, AdminSetUserPasswordCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
     readonly input: AdminSetUserPasswordCommandInput;
     constructor(input: AdminSetUserPasswordCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminSetUserPasswordCommandInput, AdminSetUserPasswordCommandOutput>;
     private serialize;
     private deserialize;

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

@@ -6,32 +6,11 @@ export interface AdminSetUserSettingsCommandInput extends AdminSetUserSettingsRe
 }
 export interface AdminSetUserSettingsCommandOutput extends AdminSetUserSettingsResponse, __MetadataBearer {
 }
-/**
- * <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>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { CognitoIdentityProviderClient, AdminSetUserSettingsCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
- * // const { CognitoIdentityProviderClient, AdminSetUserSettingsCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
- * const client = new CognitoIdentityProviderClient(config);
- * const command = new AdminSetUserSettingsCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link AdminSetUserSettingsCommandInput} for command's `input` shape.
- * @see {@link AdminSetUserSettingsCommandOutput} for command's `response` shape.
- * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class AdminSetUserSettingsCommand extends $Command<AdminSetUserSettingsCommandInput, AdminSetUserSettingsCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
     readonly input: AdminSetUserSettingsCommandInput;
     constructor(input: AdminSetUserSettingsCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminSetUserSettingsCommandInput, AdminSetUserSettingsCommandOutput>;
     private serialize;
     private deserialize;

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

@@ -6,31 +6,11 @@ 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>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { CognitoIdentityProviderClient, AdminUpdateAuthEventFeedbackCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
- * // const { CognitoIdentityProviderClient, AdminUpdateAuthEventFeedbackCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
- * const client = new CognitoIdentityProviderClient(config);
- * const command = new AdminUpdateAuthEventFeedbackCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link AdminUpdateAuthEventFeedbackCommandInput} for command's `input` shape.
- * @see {@link AdminUpdateAuthEventFeedbackCommandOutput} for command's `response` shape.
- * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class AdminUpdateAuthEventFeedbackCommand extends $Command<AdminUpdateAuthEventFeedbackCommandInput, AdminUpdateAuthEventFeedbackCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
     readonly input: AdminUpdateAuthEventFeedbackCommandInput;
     constructor(input: AdminUpdateAuthEventFeedbackCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminUpdateAuthEventFeedbackCommandInput, AdminUpdateAuthEventFeedbackCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/AdminUpdateDeviceStatusCommand.d.ts

@@ -6,30 +6,11 @@ export interface AdminUpdateDeviceStatusCommandInput extends AdminUpdateDeviceSt
 }
 export interface AdminUpdateDeviceStatusCommandOutput extends AdminUpdateDeviceStatusResponse, __MetadataBearer {
 }
-/**
- * <p>Updates the device status as an administrator.</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.
- * ```javascript
- * import { CognitoIdentityProviderClient, AdminUpdateDeviceStatusCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
- * // const { CognitoIdentityProviderClient, AdminUpdateDeviceStatusCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
- * const client = new CognitoIdentityProviderClient(config);
- * const command = new AdminUpdateDeviceStatusCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link AdminUpdateDeviceStatusCommandInput} for command's `input` shape.
- * @see {@link AdminUpdateDeviceStatusCommandOutput} for command's `response` shape.
- * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class AdminUpdateDeviceStatusCommand extends $Command<AdminUpdateDeviceStatusCommandInput, AdminUpdateDeviceStatusCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
     readonly input: AdminUpdateDeviceStatusCommandInput;
     constructor(input: AdminUpdateDeviceStatusCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminUpdateDeviceStatusCommandInput, AdminUpdateDeviceStatusCommandOutput>;
     private serialize;
     private deserialize;

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

@@ -6,53 +6,11 @@ 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>
- *
- *         <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>
- *         </note>
- *
- *         <p>Calling this action requires developer credentials.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { CognitoIdentityProviderClient, AdminUpdateUserAttributesCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
- * // const { CognitoIdentityProviderClient, AdminUpdateUserAttributesCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
- * const client = new CognitoIdentityProviderClient(config);
- * const command = new AdminUpdateUserAttributesCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link AdminUpdateUserAttributesCommandInput} for command's `input` shape.
- * @see {@link AdminUpdateUserAttributesCommandOutput} for command's `response` shape.
- * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class AdminUpdateUserAttributesCommand extends $Command<AdminUpdateUserAttributesCommandInput, AdminUpdateUserAttributesCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
     readonly input: AdminUpdateUserAttributesCommandInput;
     constructor(input: AdminUpdateUserAttributesCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminUpdateUserAttributesCommandInput, AdminUpdateUserAttributesCommandOutput>;
     private serialize;
     private deserialize;

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

@@ -6,32 +6,11 @@ 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>Calling this action requires developer credentials.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { CognitoIdentityProviderClient, AdminUserGlobalSignOutCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
- * // const { CognitoIdentityProviderClient, AdminUserGlobalSignOutCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
- * const client = new CognitoIdentityProviderClient(config);
- * const command = new AdminUserGlobalSignOutCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link AdminUserGlobalSignOutCommandInput} for command's `input` shape.
- * @see {@link AdminUserGlobalSignOutCommandOutput} for command's `response` shape.
- * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class AdminUserGlobalSignOutCommand extends $Command<AdminUserGlobalSignOutCommandInput, AdminUserGlobalSignOutCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
     readonly input: AdminUserGlobalSignOutCommandInput;
     constructor(input: AdminUserGlobalSignOutCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminUserGlobalSignOutCommandInput, AdminUserGlobalSignOutCommandOutput>;
     private serialize;
     private deserialize;