@aws-sdk/client-cognito-identity-provider 3.998.0 → 3.1000.0

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

@@ -67,6 +67,7 @@ declare const CreateUserPoolClientCommand_base: {
  *   UserPoolId: "STRING_VALUE", // required
  *   ClientName: "STRING_VALUE", // required
  *   GenerateSecret: true || false,
+ *   ClientSecret: "STRING_VALUE",
  *   RefreshTokenValidity: Number("int"),
  *   AccessTokenValidity: Number("int"),
  *   IdTokenValidity: Number("int"),

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

@@ -0,0 +1,93 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
+import type { DeleteUserPoolClientSecretRequest, DeleteUserPoolClientSecretResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link DeleteUserPoolClientSecretCommand}.
+ */
+export interface DeleteUserPoolClientSecretCommandInput extends DeleteUserPoolClientSecretRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DeleteUserPoolClientSecretCommand}.
+ */
+export interface DeleteUserPoolClientSecretCommandOutput extends DeleteUserPoolClientSecretResponse, __MetadataBearer {
+}
+declare const DeleteUserPoolClientSecretCommand_base: {
+    new (input: DeleteUserPoolClientSecretCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteUserPoolClientSecretCommandInput, DeleteUserPoolClientSecretCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: DeleteUserPoolClientSecretCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteUserPoolClientSecretCommandInput, DeleteUserPoolClientSecretCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Deletes a specific client secret from a user pool app client. You cannot delete the last remaining secret for an app client.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CognitoIdentityProviderClient, DeleteUserPoolClientSecretCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
+ * // const { CognitoIdentityProviderClient, DeleteUserPoolClientSecretCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
+ * // import type { CognitoIdentityProviderClientConfig } from "@aws-sdk/client-cognito-identity-provider";
+ * const config = {}; // type is CognitoIdentityProviderClientConfig
+ * const client = new CognitoIdentityProviderClient(config);
+ * const input = { // DeleteUserPoolClientSecretRequest
+ *   UserPoolId: "STRING_VALUE", // required
+ *   ClientId: "STRING_VALUE", // required
+ *   ClientSecretId: "STRING_VALUE", // required
+ * };
+ * const command = new DeleteUserPoolClientSecretCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param DeleteUserPoolClientSecretCommandInput - {@link DeleteUserPoolClientSecretCommandInput}
+ * @returns {@link DeleteUserPoolClientSecretCommandOutput}
+ * @see {@link DeleteUserPoolClientSecretCommandInput} for command's `input` shape.
+ * @see {@link DeleteUserPoolClientSecretCommandOutput} for command's `response` shape.
+ * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>This exception is thrown when Amazon Cognito encounters an internal server error.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>This exception is thrown when the Amazon Cognito service encounters an invalid
+ *             parameter.</p>
+ *
+ * @throws {@link LimitExceededException} (client fault)
+ *  <p>This exception is thrown when a user exceeds the limit for a requested Amazon Web Services
+ *             resource.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>This exception is thrown when the Amazon Cognito service can't find the requested
+ *             resource.</p>
+ *
+ * @throws {@link TooManyRequestsException} (client fault)
+ *  <p>This exception is thrown when the user has made too many requests for a given
+ *             operation.</p>
+ *
+ * @throws {@link CognitoIdentityProviderServiceException}
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
+ *
+ *
+ * @public
+ */
+export declare class DeleteUserPoolClientSecretCommand extends DeleteUserPoolClientSecretCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DeleteUserPoolClientSecretRequest;
+            output: {};
+        };
+        sdk: {
+            input: DeleteUserPoolClientSecretCommandInput;
+            output: DeleteUserPoolClientSecretCommandOutput;
+        };
+    };
+}

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

@@ -78,6 +78,9 @@ declare const DeleteWebAuthnCredentialCommand_base: {
  * @throws {@link NotAuthorizedException} (client fault)
  *  <p>This exception is thrown when a user isn't authorized.</p>
  *
+ * @throws {@link PasswordResetRequiredException} (client fault)
+ *  <p>This exception is thrown when a password reset is required.</p>
+ *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>This exception is thrown when the Amazon Cognito service can't find the requested
  *             resource.</p>

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

@@ -0,0 +1,102 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
+import type { ListUserPoolClientSecretsRequest, ListUserPoolClientSecretsResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListUserPoolClientSecretsCommand}.
+ */
+export interface ListUserPoolClientSecretsCommandInput extends ListUserPoolClientSecretsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListUserPoolClientSecretsCommand}.
+ */
+export interface ListUserPoolClientSecretsCommandOutput extends ListUserPoolClientSecretsResponse, __MetadataBearer {
+}
+declare const ListUserPoolClientSecretsCommand_base: {
+    new (input: ListUserPoolClientSecretsCommandInput): import("@smithy/smithy-client").CommandImpl<ListUserPoolClientSecretsCommandInput, ListUserPoolClientSecretsCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: ListUserPoolClientSecretsCommandInput): import("@smithy/smithy-client").CommandImpl<ListUserPoolClientSecretsCommandInput, ListUserPoolClientSecretsCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Lists all client secrets associated with a user pool app client. Returns metadata about the secrets. The response does not include pagination tokens as there are only 2 secrets at any given time and we return both with every ListUserPoolClientSecrets call. For security reasons, the response never reveals the actual secret value in ClientSecretValue.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CognitoIdentityProviderClient, ListUserPoolClientSecretsCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
+ * // const { CognitoIdentityProviderClient, ListUserPoolClientSecretsCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
+ * // import type { CognitoIdentityProviderClientConfig } from "@aws-sdk/client-cognito-identity-provider";
+ * const config = {}; // type is CognitoIdentityProviderClientConfig
+ * const client = new CognitoIdentityProviderClient(config);
+ * const input = { // ListUserPoolClientSecretsRequest
+ *   UserPoolId: "STRING_VALUE", // required
+ *   ClientId: "STRING_VALUE", // required
+ *   NextToken: "STRING_VALUE",
+ * };
+ * const command = new ListUserPoolClientSecretsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListUserPoolClientSecretsResponse
+ * //   ClientSecrets: [ // ClientSecretDescriptorListType
+ * //     { // ClientSecretDescriptorType
+ * //       ClientSecretId: "STRING_VALUE",
+ * //       ClientSecretValue: "STRING_VALUE",
+ * //       ClientSecretCreateDate: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListUserPoolClientSecretsCommandInput - {@link ListUserPoolClientSecretsCommandInput}
+ * @returns {@link ListUserPoolClientSecretsCommandOutput}
+ * @see {@link ListUserPoolClientSecretsCommandInput} for command's `input` shape.
+ * @see {@link ListUserPoolClientSecretsCommandOutput} for command's `response` shape.
+ * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>This exception is thrown when Amazon Cognito encounters an internal server error.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>This exception is thrown when the Amazon Cognito service encounters an invalid
+ *             parameter.</p>
+ *
+ * @throws {@link LimitExceededException} (client fault)
+ *  <p>This exception is thrown when a user exceeds the limit for a requested Amazon Web Services
+ *             resource.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>This exception is thrown when the Amazon Cognito service can't find the requested
+ *             resource.</p>
+ *
+ * @throws {@link TooManyRequestsException} (client fault)
+ *  <p>This exception is thrown when the user has made too many requests for a given
+ *             operation.</p>
+ *
+ * @throws {@link CognitoIdentityProviderServiceException}
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
+ *
+ *
+ * @public
+ */
+export declare class ListUserPoolClientSecretsCommand extends ListUserPoolClientSecretsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListUserPoolClientSecretsRequest;
+            output: ListUserPoolClientSecretsResponse;
+        };
+        sdk: {
+            input: ListUserPoolClientSecretsCommandInput;
+            output: ListUserPoolClientSecretsCommandOutput;
+        };
+    };
+}

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

@@ -29,6 +29,9 @@ declare const ListUsersCommand_base: {
 /**
  * <p>Given a user pool ID, returns a list of users and their basic details in a user
  *             pool.</p>
+ *          <p>This operation is eventually consistent. You might experience a delay before results
+ *             are up-to-date. To validate the existence or configuration of an individual user, use
+ *                 <code>AdminGetUser</code>.</p>
  *          <note>
  *             <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
  *     this operation, you must use IAM credentials to authorize requests, and you must

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

@@ -93,6 +93,9 @@ declare const ListWebAuthnCredentialsCommand_base: {
  * @throws {@link NotAuthorizedException} (client fault)
  *  <p>This exception is thrown when a user isn't authorized.</p>
  *
+ * @throws {@link PasswordResetRequiredException} (client fault)
+ *  <p>This exception is thrown when a password reset is required.</p>
+ *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>This exception is thrown when the user has made too many requests for a given
  *             operation.</p>

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

@@ -75,6 +75,9 @@ declare const StartWebAuthnRegistrationCommand_base: {
  * @throws {@link NotAuthorizedException} (client fault)
  *  <p>This exception is thrown when a user isn't authorized.</p>
  *
+ * @throws {@link PasswordResetRequiredException} (client fault)
+ *  <p>This exception is thrown when a password reset is required.</p>
+ *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>This exception is thrown when the user has made too many requests for a given
  *             operation.</p>

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

@@ -1,7 +1,8 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
 import type { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
-import type { UpdateResourceServerRequest, UpdateResourceServerResponse } from "../models/models_0";
+import type { UpdateResourceServerRequest } from "../models/models_0";
+import type { UpdateResourceServerResponse } from "../models/models_1";
 /**
  * @public
  */

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

@@ -1,7 +1,7 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
 import type { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
-import type { UpdateTermsRequest, UpdateTermsResponse } from "../models/models_0";
+import type { UpdateTermsRequest, UpdateTermsResponse } from "../models/models_1";
 /**
  * @public
  */

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

@@ -1,7 +1,7 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
 import type { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
-import type { UpdateUserAttributesRequest, UpdateUserAttributesResponse } from "../models/models_0";
+import type { UpdateUserAttributesRequest, UpdateUserAttributesResponse } from "../models/models_1";
 /**
  * @public
  */

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

@@ -1,7 +1,7 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
 import type { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
-import type { UpdateUserPoolRequest, UpdateUserPoolResponse } from "../models/models_0";
+import type { UpdateUserPoolRequest, UpdateUserPoolResponse } from "../models/models_1";
 /**
  * @public
  */
@@ -31,7 +31,7 @@ declare const UpdateUserPoolCommand_base: {
  *             defaults, construct this API request to pass the existing configuration of your user
  *             pool, modified to include the changes that you want to make.</p>
  *          <important>
- *             <p>If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.</p>
+ *             <p>With the exception of <code>UserPoolTier</code>, if you don't provide a value for an attribute, Amazon Cognito sets it to its default value.</p>
  *          </important>
  *          <note>
  *             <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers

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

@@ -1,4 +1,5 @@
 export * from "./AddCustomAttributesCommand";
+export * from "./AddUserPoolClientSecretCommand";
 export * from "./AdminAddUserToGroupCommand";
 export * from "./AdminConfirmSignUpCommand";
 export * from "./AdminCreateUserCommand";
@@ -48,6 +49,7 @@ export * from "./DeleteTermsCommand";
 export * from "./DeleteUserAttributesCommand";
 export * from "./DeleteUserCommand";
 export * from "./DeleteUserPoolClientCommand";
+export * from "./DeleteUserPoolClientSecretCommand";
 export * from "./DeleteUserPoolCommand";
 export * from "./DeleteUserPoolDomainCommand";
 export * from "./DeleteWebAuthnCredentialCommand";
@@ -84,6 +86,7 @@ export * from "./ListResourceServersCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./ListTermsCommand";
 export * from "./ListUserImportJobsCommand";
+export * from "./ListUserPoolClientSecretsCommand";
 export * from "./ListUserPoolClientsCommand";
 export * from "./ListUserPoolsCommand";
 export * from "./ListUsersCommand";

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

@@ -1,5 +1,17 @@
 import type { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import { CognitoIdentityProviderServiceException as __BaseException } from "./CognitoIdentityProviderServiceException";
+/**
+ * <p>This exception is thrown when you don't have sufficient permissions to perform the requested operation.</p>
+ * @public
+ */
+export declare class AccessDeniedException extends __BaseException {
+    readonly name: "AccessDeniedException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
+}
 /**
  * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
  * @public
@@ -82,41 +94,53 @@ export declare class UserImportInProgressException extends __BaseException {
     constructor(opts: __ExceptionOptionType<UserImportInProgressException, __BaseException>);
 }
 /**
- * <p>This exception is thrown when a user isn't found.</p>
+ * <p>This exception is thrown when Amazon Cognito encounters an internal server error.</p>
  * @public
  */
-export declare class UserNotFoundException extends __BaseException {
-    readonly name: "UserNotFoundException";
+export declare class InternalServerException extends __BaseException {
+    readonly name: "InternalServerException";
+    readonly $fault: "server";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
+}
+/**
+ * <p>This exception is thrown when a user exceeds the limit for a requested Amazon Web Services
+ *             resource.</p>
+ * @public
+ */
+export declare class LimitExceededException extends __BaseException {
+    readonly name: "LimitExceededException";
     readonly $fault: "client";
     /**
      * @internal
      */
-    constructor(opts: __ExceptionOptionType<UserNotFoundException, __BaseException>);
+    constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
 }
 /**
- * <p>This exception is thrown when Amazon Cognito encounters an invalid Lambda response.</p>
+ * <p>This exception is thrown when a user isn't found.</p>
  * @public
  */
-export declare class InvalidLambdaResponseException extends __BaseException {
-    readonly name: "InvalidLambdaResponseException";
+export declare class UserNotFoundException extends __BaseException {
+    readonly name: "UserNotFoundException";
     readonly $fault: "client";
     /**
      * @internal
      */
-    constructor(opts: __ExceptionOptionType<InvalidLambdaResponseException, __BaseException>);
+    constructor(opts: __ExceptionOptionType<UserNotFoundException, __BaseException>);
 }
 /**
- * <p>This exception is thrown when a user exceeds the limit for a requested Amazon Web Services
- *             resource.</p>
+ * <p>This exception is thrown when Amazon Cognito encounters an invalid Lambda response.</p>
  * @public
  */
-export declare class LimitExceededException extends __BaseException {
-    readonly name: "LimitExceededException";
+export declare class InvalidLambdaResponseException extends __BaseException {
+    readonly name: "InvalidLambdaResponseException";
     readonly $fault: "client";
     /**
      * @internal
      */
-    constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
+    constructor(opts: __ExceptionOptionType<InvalidLambdaResponseException, __BaseException>);
 }
 /**
  * <p>This exception is thrown when the user has made too many failed attempts for a given