@aws-sdk/client-cognito-identity-provider 3.1056.0 → 3.1058.0

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

@@ -1,7 +1,7 @@
 import { Command as $Command } from "@smithy/core/client";
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
 import type { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
-import type { UpdateGroupRequest, UpdateGroupResponse } from "../models/models_0";
+import type { UpdateGroupRequest, UpdateGroupResponse } from "../models/models_1";
 /**
  * @public
  */
@@ -98,6 +98,9 @@ declare const UpdateGroupCommand_base: {
  * @throws {@link NotAuthorizedException} (client fault)
  *  <p>This exception is thrown when a user isn't authorized.</p>
  *
+ * @throws {@link OperationNotEnabledException} (client fault)
+ *  <p>This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.</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/UpdateIdentityProviderCommand.d.ts

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

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

@@ -1,7 +1,7 @@
 import { Command as $Command } from "@smithy/core/client";
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
 import type { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
-import type { UpdateManagedLoginBrandingRequest, UpdateManagedLoginBrandingResponse } from "../models/models_0";
+import type { UpdateManagedLoginBrandingRequest, UpdateManagedLoginBrandingResponse } from "../models/models_1";
 /**
  * @public
  */
@@ -125,6 +125,9 @@ declare const UpdateManagedLoginBrandingCommand_base: {
  * @throws {@link NotAuthorizedException} (client fault)
  *  <p>This exception is thrown when a user isn't authorized.</p>
  *
+ * @throws {@link OperationNotEnabledException} (client fault)
+ *  <p>This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.</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/UpdateResourceServerCommand.d.ts

@@ -108,6 +108,9 @@ declare const UpdateResourceServerCommand_base: {
  * @throws {@link NotAuthorizedException} (client fault)
  *  <p>This exception is thrown when a user isn't authorized.</p>
  *
+ * @throws {@link OperationNotEnabledException} (client fault)
+ *  <p>This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.</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/UpdateTermsCommand.d.ts

@@ -118,6 +118,9 @@ declare const UpdateTermsCommand_base: {
  * @throws {@link NotAuthorizedException} (client fault)
  *  <p>This exception is thrown when a user isn't authorized.</p>
  *
+ * @throws {@link OperationNotEnabledException} (client fault)
+ *  <p>This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.</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/UpdateUserAttributesCommand.d.ts

@@ -146,6 +146,9 @@ declare const UpdateUserAttributesCommand_base: {
  * @throws {@link NotAuthorizedException} (client fault)
  *  <p>This exception is thrown when a user isn't authorized.</p>
  *
+ * @throws {@link OperationNotEnabledException} (client fault)
+ *  <p>This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.</p>
+ *
  * @throws {@link PasswordResetRequiredException} (client fault)
  *  <p>This exception is thrown when a password reset is required.</p>
  *

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

@@ -212,6 +212,9 @@ declare const UpdateUserPoolClientCommand_base: {
  * @throws {@link NotAuthorizedException} (client fault)
  *  <p>This exception is thrown when a user isn't authorized.</p>
  *
+ * @throws {@link OperationNotEnabledException} (client fault)
+ *  <p>This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.</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/UpdateUserPoolCommand.d.ts

@@ -33,8 +33,12 @@ 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>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>
+ *             <p>If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.</p>
  *          </important>
+ *          <p>In secondary regions for user pools with multi-region replication, regional
+ *             configurations for email, SMS, Lambda functions, and tags can be updated. Both global
+ *             and regional settings must be provided as inputs, with global settings required to match
+ *             existing values to maintain consistency across replicas.</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
@@ -193,6 +197,13 @@ declare const UpdateUserPoolCommand_base: {
  *   },
  *   PoolName: "STRING_VALUE",
  *   UserPoolTier: "LITE" || "ESSENTIALS" || "PLUS",
+ *   KeyConfiguration: { // KeyConfigurationType
+ *     KeyType: "AWS_OWNED_KEY" || "CUSTOMER_MANAGED_KEY",
+ *     KmsKeyArn: "STRING_VALUE",
+ *   },
+ *   IssuerConfiguration: { // IssuerConfigurationType
+ *     Type: "ORIGINAL" || "UPDATED",
+ *   },
  * };
  * const command = new UpdateUserPoolCommand(input);
  * const response = await client.send(command);
@@ -238,6 +249,9 @@ declare const UpdateUserPoolCommand_base: {
  * @throws {@link NotAuthorizedException} (client fault)
  *  <p>This exception is thrown when a user isn't authorized.</p>
  *
+ * @throws {@link OperationNotEnabledException} (client fault)
+ *  <p>This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.</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/UpdateUserPoolDomainCommand.d.ts

@@ -81,12 +81,24 @@ declare const UpdateUserPoolDomainCommand_base: {
  *   CustomDomainConfig: { // CustomDomainConfigType
  *     CertificateArn: "STRING_VALUE", // required
  *   },
+ *   Routing: { // RoutingType
+ *     Failover: { // FailoverType
+ *       SecondaryRegion: "STRING_VALUE", // required
+ *       PrimaryRoute53HealthCheckId: "STRING_VALUE", // required
+ *     },
+ *   },
  * };
  * const command = new UpdateUserPoolDomainCommand(input);
  * const response = await client.send(command);
  * // { // UpdateUserPoolDomainResponse
  * //   ManagedLoginVersion: Number("int"),
  * //   CloudFrontDomain: "STRING_VALUE",
+ * //   Routing: { // RoutingType
+ * //     Failover: { // FailoverType
+ * //       SecondaryRegion: "STRING_VALUE", // required
+ * //       PrimaryRoute53HealthCheckId: "STRING_VALUE", // required
+ * //     },
+ * //   },
  * // };
  *
  * ```
@@ -115,6 +127,9 @@ declare const UpdateUserPoolDomainCommand_base: {
  * @throws {@link NotAuthorizedException} (client fault)
  *  <p>This exception is thrown when a user isn't authorized.</p>
  *
+ * @throws {@link OperationNotEnabledException} (client fault)
+ *  <p>This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.</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/UpdateUserPoolReplicaCommand.d.ts

@@ -0,0 +1,148 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
+import type { UpdateUserPoolReplicaRequest, UpdateUserPoolReplicaResponse } from "../models/models_1";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateUserPoolReplicaCommand}.
+ */
+export interface UpdateUserPoolReplicaCommandInput extends UpdateUserPoolReplicaRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateUserPoolReplicaCommand}.
+ */
+export interface UpdateUserPoolReplicaCommandOutput extends UpdateUserPoolReplicaResponse, __MetadataBearer {
+}
+declare const UpdateUserPoolReplicaCommand_base: {
+    new (input: UpdateUserPoolReplicaCommandInput): import("@smithy/core/client").CommandImpl<UpdateUserPoolReplicaCommandInput, UpdateUserPoolReplicaCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdateUserPoolReplicaCommandInput): import("@smithy/core/client").CommandImpl<UpdateUserPoolReplicaCommandInput, UpdateUserPoolReplicaCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): {
+        [x: string]: unknown;
+    };
+};
+/**
+ * <p>Updates replica-specific settings for a user pool replica. You can modify the status
+ *             to activate or deactivate the replica. This request can be made in both primary and secondary
+ *             regions of the user pool.</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
+ *     grant yourself the corresponding IAM permission in a policy.</p>
+ *             <p class="title">
+ *                <b>Learn more</b>
+ *             </p>
+ *             <ul>
+ *                <li>
+ *                   <p>
+ *                      <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
+ *                   </p>
+ *                </li>
+ *                <li>
+ *                   <p>
+ *                      <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>
+ *                   </p>
+ *                </li>
+ *             </ul>
+ *          </note>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CognitoIdentityProviderClient, UpdateUserPoolReplicaCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
+ * // const { CognitoIdentityProviderClient, UpdateUserPoolReplicaCommand } = 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 = { // UpdateUserPoolReplicaRequest
+ *   UserPoolId: "STRING_VALUE", // required
+ *   RegionName: "STRING_VALUE", // required
+ *   Status: "ACTIVE" || "INACTIVE", // required
+ * };
+ * const command = new UpdateUserPoolReplicaCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateUserPoolReplicaResponse
+ * //   UserPoolReplica: { // UserPoolReplicaType
+ * //     RegionName: "STRING_VALUE",
+ * //     Status: "CREATING" || "ACTIVE" || "INACTIVE" || "DELETING",
+ * //     Role: "PRIMARY" || "SECONDARY",
+ * //     UserPoolArn: "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateUserPoolReplicaCommandInput - {@link UpdateUserPoolReplicaCommandInput}
+ * @returns {@link UpdateUserPoolReplicaCommandOutput}
+ * @see {@link UpdateUserPoolReplicaCommandInput} for command's `input` shape.
+ * @see {@link UpdateUserPoolReplicaCommandOutput} for command's `response` shape.
+ * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
+ *
+ * @throws {@link InternalErrorException} (server fault)
+ *  <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>This exception is thrown when the Amazon Cognito service encounters an invalid
+ *             parameter.</p>
+ *
+ * @throws {@link NotAuthorizedException} (client fault)
+ *  <p>This exception is thrown when a user isn't authorized.</p>
+ *
+ * @throws {@link OperationNotEnabledException} (client fault)
+ *  <p>This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.</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>
+ *
+ *
+ * @example Example update a user pool replica
+ * ```javascript
+ * // The following example sets the status of a user pool replica in the us-east-1 Region to ACTIVE.
+ * const input = {
+ *   RegionName: "us-east-1",
+ *   Status: "ACTIVE",
+ *   UserPoolId: "ap-south-1_abcd12345"
+ * };
+ * const command = new UpdateUserPoolReplicaCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   UserPoolReplica: {
+ *     RegionName: "us-east-1",
+ *     Role: "SECONDARY",
+ *     Status: "ACTIVE",
+ *     UserPoolArn: "arn:aws:cognito-idp:us-east-1:123456789012:userpool/ap-south-1_abcd12345"
+ *   }
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class UpdateUserPoolReplicaCommand extends UpdateUserPoolReplicaCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateUserPoolReplicaRequest;
+            output: UpdateUserPoolReplicaResponse;
+        };
+        sdk: {
+            input: UpdateUserPoolReplicaCommandInput;
+            output: UpdateUserPoolReplicaCommandOutput;
+        };
+    };
+}

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

@@ -93,6 +93,9 @@ declare const VerifySoftwareTokenCommand_base: {
  * @throws {@link NotAuthorizedException} (client fault)
  *  <p>This exception is thrown when a user isn't authorized.</p>
  *
+ * @throws {@link OperationNotEnabledException} (client fault)
+ *  <p>This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.</p>
+ *
  * @throws {@link PasswordResetRequiredException} (client fault)
  *  <p>This exception is thrown when a password reset is required.</p>
  *

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

@@ -99,6 +99,9 @@ declare const VerifyUserAttributeCommand_base: {
  * @throws {@link NotAuthorizedException} (client fault)
  *  <p>This exception is thrown when a user isn't authorized.</p>
  *
+ * @throws {@link OperationNotEnabledException} (client fault)
+ *  <p>This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.</p>
+ *
  * @throws {@link PasswordResetRequiredException} (client fault)
  *  <p>This exception is thrown when a password reset is required.</p>
  *

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

@@ -41,6 +41,7 @@ export * from "./CreateUserImportJobCommand";
 export * from "./CreateUserPoolClientCommand";
 export * from "./CreateUserPoolCommand";
 export * from "./CreateUserPoolDomainCommand";
+export * from "./CreateUserPoolReplicaCommand";
 export * from "./DeleteGroupCommand";
 export * from "./DeleteIdentityProviderCommand";
 export * from "./DeleteManagedLoginBrandingCommand";
@@ -52,6 +53,7 @@ export * from "./DeleteUserPoolClientCommand";
 export * from "./DeleteUserPoolClientSecretCommand";
 export * from "./DeleteUserPoolCommand";
 export * from "./DeleteUserPoolDomainCommand";
+export * from "./DeleteUserPoolReplicaCommand";
 export * from "./DeleteWebAuthnCredentialCommand";
 export * from "./DescribeIdentityProviderCommand";
 export * from "./DescribeManagedLoginBrandingByClientCommand";
@@ -88,6 +90,7 @@ export * from "./ListTermsCommand";
 export * from "./ListUserImportJobsCommand";
 export * from "./ListUserPoolClientSecretsCommand";
 export * from "./ListUserPoolClientsCommand";
+export * from "./ListUserPoolReplicasCommand";
 export * from "./ListUserPoolsCommand";
 export * from "./ListUsersCommand";
 export * from "./ListUsersInGroupCommand";
@@ -118,5 +121,6 @@ export * from "./UpdateUserAttributesCommand";
 export * from "./UpdateUserPoolClientCommand";
 export * from "./UpdateUserPoolCommand";
 export * from "./UpdateUserPoolDomainCommand";
+export * from "./UpdateUserPoolReplicaCommand";
 export * from "./VerifySoftwareTokenCommand";
 export * from "./VerifyUserAttributeCommand";

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

@@ -424,6 +424,30 @@ export declare const EmailSendingAccountType: {
  * @public
  */
 export type EmailSendingAccountType = (typeof EmailSendingAccountType)[keyof typeof EmailSendingAccountType];
+/**
+ * @public
+ * @enum
+ */
+export declare const IssuerType: {
+    readonly ORIGINAL: "ORIGINAL";
+    readonly UPDATED: "UPDATED";
+};
+/**
+ * @public
+ */
+export type IssuerType = (typeof IssuerType)[keyof typeof IssuerType];
+/**
+ * @public
+ * @enum
+ */
+export declare const EncryptionKeyType: {
+    readonly AWS_OWNED_KEY: "AWS_OWNED_KEY";
+    readonly CUSTOMER_MANAGED_KEY: "CUSTOMER_MANAGED_KEY";
+};
+/**
+ * @public
+ */
+export type EncryptionKeyType = (typeof EncryptionKeyType)[keyof typeof EncryptionKeyType];
 /**
  * @public
  * @enum
@@ -602,6 +626,32 @@ export declare const TimeUnitsType: {
  * @public
  */
 export type TimeUnitsType = (typeof TimeUnitsType)[keyof typeof TimeUnitsType];
+/**
+ * @public
+ * @enum
+ */
+export declare const ReplicaRoleType: {
+    readonly PRIMARY: "PRIMARY";
+    readonly SECONDARY: "SECONDARY";
+};
+/**
+ * @public
+ */
+export type ReplicaRoleType = (typeof ReplicaRoleType)[keyof typeof ReplicaRoleType];
+/**
+ * @public
+ * @enum
+ */
+export declare const ReplicaStatusType: {
+    readonly ACTIVE: "ACTIVE";
+    readonly CREATING: "CREATING";
+    readonly DELETING: "DELETING";
+    readonly INACTIVE: "INACTIVE";
+};
+/**
+ * @public
+ */
+export type ReplicaStatusType = (typeof ReplicaStatusType)[keyof typeof ReplicaStatusType];
 /**
  * @public
  * @enum
@@ -690,6 +740,18 @@ export declare const UserVerificationType: {
  * @public
  */
 export type UserVerificationType = (typeof UserVerificationType)[keyof typeof UserVerificationType];
+/**
+ * @public
+ * @enum
+ */
+export declare const UpdateReplicaStatusType: {
+    readonly ACTIVE: "ACTIVE";
+    readonly INACTIVE: "INACTIVE";
+};
+/**
+ * @public
+ */
+export type UpdateReplicaStatusType = (typeof UpdateReplicaStatusType)[keyof typeof UpdateReplicaStatusType];
 /**
  * @public
  * @enum

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

@@ -54,6 +54,18 @@ export declare class NotAuthorizedException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<NotAuthorizedException, __BaseException>);
 }
+/**
+ * <p>This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.</p>
+ * @public
+ */
+export declare class OperationNotEnabledException extends __BaseException {
+    readonly name: "OperationNotEnabledException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<OperationNotEnabledException, __BaseException>);
+}
 /**
  * <p>This exception is thrown when the Amazon Cognito service can't find the requested
  *             resource.</p>