@aws-sdk/client-cognito-identity-provider 3.296.0 → 3.297.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
 import { UpdateUserPoolRequest, UpdateUserPoolResponse } from "../models/models_1";
 /**
+ * @public
+ *
  * The input for {@link UpdateUserPoolCommand}.
  */
 export interface UpdateUserPoolCommandInput extends UpdateUserPoolRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateUserPoolCommand}.
  */
 export interface UpdateUserPoolCommandOutput extends UpdateUserPoolResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the specified user pool with the specified attributes. You can get a list of
  *             the current user pool settings using <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>. If you don't provide a value for an attribute, it will be
  *             set to the default value.
@@ -46,6 +51,8 @@ export interface UpdateUserPoolCommandOutput extends UpdateUserPoolResponse, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateUserPoolCommandInput - {@link UpdateUserPoolCommandInput}
+ * @returns {@link UpdateUserPoolCommandOutput}
  * @see {@link UpdateUserPoolCommandInput} for command's `input` shape.
  * @see {@link UpdateUserPoolCommandOutput} for command's `response` shape.
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -98,11 +105,20 @@ export interface UpdateUserPoolCommandOutput extends UpdateUserPoolResponse, __M
 export declare class UpdateUserPoolCommand extends $Command<UpdateUserPoolCommandInput, UpdateUserPoolCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
     readonly input: UpdateUserPoolCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateUserPoolCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateUserPoolCommandInput, UpdateUserPoolCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
 import { UpdateUserPoolDomainRequest, UpdateUserPoolDomainResponse } from "../models/models_1";
 /**
+ * @public
+ *
  * The input for {@link UpdateUserPoolDomainCommand}.
  */
 export interface UpdateUserPoolDomainCommandInput extends UpdateUserPoolDomainRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateUserPoolDomainCommand}.
  */
 export interface UpdateUserPoolDomainCommandOutput extends UpdateUserPoolDomainResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user
  *             pool.</p>
  *         <p>You can use this operation to provide the Amazon Resource Name (ARN) of a new
@@ -43,6 +48,8 @@ export interface UpdateUserPoolDomainCommandOutput extends UpdateUserPoolDomainR
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateUserPoolDomainCommandInput - {@link UpdateUserPoolDomainCommandInput}
+ * @returns {@link UpdateUserPoolDomainCommandOutput}
  * @see {@link UpdateUserPoolDomainCommandInput} for command's `input` shape.
  * @see {@link UpdateUserPoolDomainCommandOutput} for command's `response` shape.
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -70,11 +77,20 @@ export interface UpdateUserPoolDomainCommandOutput extends UpdateUserPoolDomainR
 export declare class UpdateUserPoolDomainCommand extends $Command<UpdateUserPoolDomainCommandInput, UpdateUserPoolDomainCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
     readonly input: UpdateUserPoolDomainCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateUserPoolDomainCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateUserPoolDomainCommandInput, UpdateUserPoolDomainCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
 import { VerifySoftwareTokenRequest, VerifySoftwareTokenResponse } from "../models/models_1";
 /**
+ * @public
+ *
  * The input for {@link VerifySoftwareTokenCommand}.
  */
 export interface VerifySoftwareTokenCommandInput extends VerifySoftwareTokenRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link VerifySoftwareTokenCommand}.
  */
 export interface VerifySoftwareTokenCommandOutput extends VerifySoftwareTokenResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Use this API to register a user's entered time-based one-time password (TOTP) code and
  *             mark the user's software token MFA status as "verified" if successful. The request takes
  *             an access token or a session string, but not both.</p>
@@ -27,6 +32,8 @@ export interface VerifySoftwareTokenCommandOutput extends VerifySoftwareTokenRes
  * const response = await client.send(command);
  * ```
  *
+ * @param VerifySoftwareTokenCommandInput - {@link VerifySoftwareTokenCommandInput}
+ * @returns {@link VerifySoftwareTokenCommandOutput}
  * @see {@link VerifySoftwareTokenCommandInput} for command's `input` shape.
  * @see {@link VerifySoftwareTokenCommandOutput} for command's `response` shape.
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -81,11 +88,20 @@ export interface VerifySoftwareTokenCommandOutput extends VerifySoftwareTokenRes
 export declare class VerifySoftwareTokenCommand extends $Command<VerifySoftwareTokenCommandInput, VerifySoftwareTokenCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
     readonly input: VerifySoftwareTokenCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: VerifySoftwareTokenCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<VerifySoftwareTokenCommandInput, VerifySoftwareTokenCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
 import { VerifyUserAttributeRequest, VerifyUserAttributeResponse } from "../models/models_1";
 /**
+ * @public
+ *
  * The input for {@link VerifyUserAttributeCommand}.
  */
 export interface VerifyUserAttributeCommandInput extends VerifyUserAttributeRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link VerifyUserAttributeCommand}.
  */
 export interface VerifyUserAttributeCommandOutput extends VerifyUserAttributeResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Verifies the specified user attributes in the user pool.</p>
  *         <p>
  *             If your user pool requires verification before Amazon Cognito updates the attribute value,
@@ -31,6 +36,8 @@ export interface VerifyUserAttributeCommandOutput extends VerifyUserAttributeRes
  * const response = await client.send(command);
  * ```
  *
+ * @param VerifyUserAttributeCommandInput - {@link VerifyUserAttributeCommandInput}
+ * @returns {@link VerifyUserAttributeCommandOutput}
  * @see {@link VerifyUserAttributeCommandInput} for command's `input` shape.
  * @see {@link VerifyUserAttributeCommandOutput} for command's `response` shape.
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -88,11 +95,20 @@ export interface VerifyUserAttributeCommandOutput extends VerifyUserAttributeRes
 export declare class VerifyUserAttributeCommand extends $Command<VerifyUserAttributeCommandInput, VerifyUserAttributeCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
     readonly input: VerifyUserAttributeCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: VerifyUserAttributeCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<VerifyUserAttributeCommandInput, VerifyUserAttributeCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/CognitoIdentityProviderServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from CognitoIdentityProvider service.
  */
 export declare class CognitoIdentityProviderServiceException extends __ServiceException {