@aws-sdk/client-cognito-identity-provider 3.34.0 → 3.37.0

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

@@ -0,0 +1,55 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
+import { UpdateUserPoolDomainRequest, UpdateUserPoolDomainResponse } from "../models/models_1";
+export interface UpdateUserPoolDomainCommandInput extends UpdateUserPoolDomainRequest {
+}
+export interface UpdateUserPoolDomainCommandOutput extends UpdateUserPoolDomainResponse, __MetadataBearer {
+}
+/**
+ * <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
+ *             certificate to Amazon Cognito. You cannot use it to change the domain for a user
+ *             pool.</p>
+ *         <p>A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up
+ *             and sign-in pages for your application. When you set up a custom domain, you provide a
+ *             certificate that you manage with Certificate Manager (ACM). When necessary, you can
+ *             use this operation to change the certificate that you applied to your custom
+ *             domain.</p>
+ *         <p>Usually, this is unnecessary following routine certificate renewal with ACM. When you
+ *             renew your existing certificate in ACM, the ARN for your certificate remains the same,
+ *             and your custom domain uses the new certificate automatically.</p>
+ *         <p>However, if you replace your existing certificate with a new one, ACM gives the new
+ *             certificate a new ARN. To apply the new certificate to your custom domain, you must
+ *             provide this ARN to Amazon Cognito.</p>
+ *         <p>When you add your new certificate in ACM, you must choose US East (N. Virginia) as the
+ *             Region.</p>
+ *         <p>After you submit your request, Amazon Cognito requires up to 1 hour to distribute your
+ *             new certificate to your custom domain.</p>
+ *         <p>For more information about adding a custom domain to your user pool, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html">Using Your Own Domain for the Hosted UI</a>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CognitoIdentityProviderClient, UpdateUserPoolDomainCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
+ * // const { CognitoIdentityProviderClient, UpdateUserPoolDomainCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
+ * const client = new CognitoIdentityProviderClient(config);
+ * const command = new UpdateUserPoolDomainCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link UpdateUserPoolDomainCommandInput} for command's `input` shape.
+ * @see {@link UpdateUserPoolDomainCommandOutput} for command's `response` shape.
+ * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape.
+ *
+ */
+export declare class UpdateUserPoolDomainCommand extends $Command<UpdateUserPoolDomainCommandInput, UpdateUserPoolDomainCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
+    readonly input: UpdateUserPoolDomainCommandInput;
+    constructor(input: UpdateUserPoolDomainCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateUserPoolDomainCommandInput, UpdateUserPoolDomainCommandOutput>;
+    private serialize;
+    private deserialize;
+}

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

@@ -0,0 +1,37 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
+import { VerifySoftwareTokenRequest, VerifySoftwareTokenResponse } from "../models/models_1";
+export interface VerifySoftwareTokenCommandInput extends VerifySoftwareTokenRequest {
+}
+export interface VerifySoftwareTokenCommandOutput extends VerifySoftwareTokenResponse, __MetadataBearer {
+}
+/**
+ * <p>Use this API to register a user's entered 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>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CognitoIdentityProviderClient, VerifySoftwareTokenCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
+ * // const { CognitoIdentityProviderClient, VerifySoftwareTokenCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
+ * const client = new CognitoIdentityProviderClient(config);
+ * const command = new VerifySoftwareTokenCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link VerifySoftwareTokenCommandInput} for command's `input` shape.
+ * @see {@link VerifySoftwareTokenCommandOutput} for command's `response` shape.
+ * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape.
+ *
+ */
+export declare class VerifySoftwareTokenCommand extends $Command<VerifySoftwareTokenCommandInput, VerifySoftwareTokenCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
+    readonly input: VerifySoftwareTokenCommandInput;
+    constructor(input: VerifySoftwareTokenCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<VerifySoftwareTokenCommandInput, VerifySoftwareTokenCommandOutput>;
+    private serialize;
+    private deserialize;
+}

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

@@ -0,0 +1,35 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
+import { VerifyUserAttributeRequest, VerifyUserAttributeResponse } from "../models/models_1";
+export interface VerifyUserAttributeCommandInput extends VerifyUserAttributeRequest {
+}
+export interface VerifyUserAttributeCommandOutput extends VerifyUserAttributeResponse, __MetadataBearer {
+}
+/**
+ * <p>Verifies the specified user attributes in the user pool.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CognitoIdentityProviderClient, VerifyUserAttributeCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
+ * // const { CognitoIdentityProviderClient, VerifyUserAttributeCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
+ * const client = new CognitoIdentityProviderClient(config);
+ * const command = new VerifyUserAttributeCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link VerifyUserAttributeCommandInput} for command's `input` shape.
+ * @see {@link VerifyUserAttributeCommandOutput} for command's `response` shape.
+ * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape.
+ *
+ */
+export declare class VerifyUserAttributeCommand extends $Command<VerifyUserAttributeCommandInput, VerifyUserAttributeCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
+    readonly input: VerifyUserAttributeCommandInput;
+    constructor(input: VerifyUserAttributeCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<VerifyUserAttributeCommandInput, VerifyUserAttributeCommandOutput>;
+    private serialize;
+    private deserialize;
+}