@aws-sdk/client-cognito-identity-provider 3.98.0 → 3.102.0

package/CHANGELOG.md

@@ -3,6 +3,33 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.102.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.101.0...v3.102.0) (2022-05-31)
+
+
+### Features
+
+* **client-cognito-identity-provider:** Amazon Cognito now supports IP Address propagation for all unauthenticated APIs (e.g. SignUp, ForgotPassword). ([d285512](https://github.com/aws/aws-sdk-js-v3/commit/d28551296728adfae6dfbf6d0ea8d6c903f4a059))
+
+
+
+
+
+# [3.100.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.99.0...v3.100.0) (2022-05-26)
+
+**Note:** Version bump only for package @aws-sdk/client-cognito-identity-provider
+
+
+
+
+
+# [3.99.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.98.0...v3.99.0) (2022-05-25)
+
+**Note:** Version bump only for package @aws-sdk/client-cognito-identity-provider
+
+
+
+
+
 # [3.98.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.97.0...v3.98.0) (2022-05-24)
 
 

package/dist-cjs/protocols/Aws_json1_1.js

@@ -7641,6 +7641,10 @@ const serializeAws_json1_1CreateUserPoolClientRequest = (input, context) => {
         ...(input.ClientName !== undefined && input.ClientName !== null && { ClientName: input.ClientName }),
         ...(input.DefaultRedirectURI !== undefined &&
             input.DefaultRedirectURI !== null && { DefaultRedirectURI: input.DefaultRedirectURI }),
+        ...(input.EnablePropagateAdditionalUserContextData !== undefined &&
+            input.EnablePropagateAdditionalUserContextData !== null && {
+            EnablePropagateAdditionalUserContextData: input.EnablePropagateAdditionalUserContextData,
+        }),
         ...(input.EnableTokenRevocation !== undefined &&
             input.EnableTokenRevocation !== null && { EnableTokenRevocation: input.EnableTokenRevocation }),
         ...(input.ExplicitAuthFlows !== undefined &&
@@ -8706,6 +8710,10 @@ const serializeAws_json1_1UpdateUserPoolClientRequest = (input, context) => {
         ...(input.ClientName !== undefined && input.ClientName !== null && { ClientName: input.ClientName }),
         ...(input.DefaultRedirectURI !== undefined &&
             input.DefaultRedirectURI !== null && { DefaultRedirectURI: input.DefaultRedirectURI }),
+        ...(input.EnablePropagateAdditionalUserContextData !== undefined &&
+            input.EnablePropagateAdditionalUserContextData !== null && {
+            EnablePropagateAdditionalUserContextData: input.EnablePropagateAdditionalUserContextData,
+        }),
         ...(input.EnableTokenRevocation !== undefined &&
             input.EnableTokenRevocation !== null && { EnableTokenRevocation: input.EnableTokenRevocation }),
         ...(input.ExplicitAuthFlows !== undefined &&
@@ -8821,6 +8829,7 @@ const serializeAws_json1_1UserAttributeUpdateSettingsType = (input, context) =>
 const serializeAws_json1_1UserContextDataType = (input, context) => {
     return {
         ...(input.EncodedData !== undefined && input.EncodedData !== null && { EncodedData: input.EncodedData }),
+        ...(input.IpAddress !== undefined && input.IpAddress !== null && { IpAddress: input.IpAddress }),
     };
 };
 const serializeAws_json1_1UsernameAttributesListType = (input, context) => {
@@ -10551,6 +10560,7 @@ const deserializeAws_json1_1UserPoolClientType = (output, context) => {
             ? (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(output.CreationDate)))
             : undefined,
         DefaultRedirectURI: (0, smithy_client_1.expectString)(output.DefaultRedirectURI),
+        EnablePropagateAdditionalUserContextData: (0, smithy_client_1.expectBoolean)(output.EnablePropagateAdditionalUserContextData),
         EnableTokenRevocation: (0, smithy_client_1.expectBoolean)(output.EnableTokenRevocation),
         ExplicitAuthFlows: output.ExplicitAuthFlows !== undefined && output.ExplicitAuthFlows !== null
             ? deserializeAws_json1_1ExplicitAuthFlowsListType(output.ExplicitAuthFlows, context)

package/dist-cjs/runtimeConfig.js

@@ -17,8 +17,10 @@ const util_utf8_node_1 = require("@aws-sdk/util-utf8-node");
 const runtimeConfig_shared_1 = require("./runtimeConfig.shared");
 const smithy_client_1 = require("@aws-sdk/smithy-client");
 const util_defaults_mode_node_1 = require("@aws-sdk/util-defaults-mode-node");
+const smithy_client_2 = require("@aws-sdk/smithy-client");
 const getRuntimeConfig = (config) => {
     var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
+    (0, smithy_client_2.emitWarningIfUnsupportedVersion)(process.version);
     const defaultsMode = (0, util_defaults_mode_node_1.resolveDefaultsModeConfig)(config);
     const defaultConfigProvider = () => defaultsMode().then(smithy_client_1.loadConfigsForDefaultMode);
     const clientSharedValues = (0, runtimeConfig_shared_1.getRuntimeConfig)(config);

package/dist-es/protocols/Aws_json1_1.js

@@ -9615,7 +9615,7 @@ var serializeAws_json1_1CreateUserImportJobRequest = function (input, context) {
         input.CloudWatchLogsRoleArn !== null && { CloudWatchLogsRoleArn: input.CloudWatchLogsRoleArn })), (input.JobName !== undefined && input.JobName !== null && { JobName: input.JobName })), (input.UserPoolId !== undefined && input.UserPoolId !== null && { UserPoolId: input.UserPoolId }));
 };
 var serializeAws_json1_1CreateUserPoolClientRequest = function (input, context) {
-    return __assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, (input.AccessTokenValidity !== undefined &&
+    return __assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, (input.AccessTokenValidity !== undefined &&
         input.AccessTokenValidity !== null && { AccessTokenValidity: input.AccessTokenValidity })), (input.AllowedOAuthFlows !== undefined &&
         input.AllowedOAuthFlows !== null && {
         AllowedOAuthFlows: serializeAws_json1_1OAuthFlowsType(input.AllowedOAuthFlows, context),
@@ -9632,7 +9632,10 @@ var serializeAws_json1_1CreateUserPoolClientRequest = function (input, context)
         input.CallbackURLs !== null && {
         CallbackURLs: serializeAws_json1_1CallbackURLsListType(input.CallbackURLs, context),
     })), (input.ClientName !== undefined && input.ClientName !== null && { ClientName: input.ClientName })), (input.DefaultRedirectURI !== undefined &&
-        input.DefaultRedirectURI !== null && { DefaultRedirectURI: input.DefaultRedirectURI })), (input.EnableTokenRevocation !== undefined &&
+        input.DefaultRedirectURI !== null && { DefaultRedirectURI: input.DefaultRedirectURI })), (input.EnablePropagateAdditionalUserContextData !== undefined &&
+        input.EnablePropagateAdditionalUserContextData !== null && {
+        EnablePropagateAdditionalUserContextData: input.EnablePropagateAdditionalUserContextData,
+    })), (input.EnableTokenRevocation !== undefined &&
         input.EnableTokenRevocation !== null && { EnableTokenRevocation: input.EnableTokenRevocation })), (input.ExplicitAuthFlows !== undefined &&
         input.ExplicitAuthFlows !== null && {
         ExplicitAuthFlows: serializeAws_json1_1ExplicitAuthFlowsListType(input.ExplicitAuthFlows, context),
@@ -10303,7 +10306,7 @@ var serializeAws_json1_1UpdateUserAttributesRequest = function (input, context)
     }));
 };
 var serializeAws_json1_1UpdateUserPoolClientRequest = function (input, context) {
-    return __assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, (input.AccessTokenValidity !== undefined &&
+    return __assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, (input.AccessTokenValidity !== undefined &&
         input.AccessTokenValidity !== null && { AccessTokenValidity: input.AccessTokenValidity })), (input.AllowedOAuthFlows !== undefined &&
         input.AllowedOAuthFlows !== null && {
         AllowedOAuthFlows: serializeAws_json1_1OAuthFlowsType(input.AllowedOAuthFlows, context),
@@ -10320,7 +10323,10 @@ var serializeAws_json1_1UpdateUserPoolClientRequest = function (input, context)
         input.CallbackURLs !== null && {
         CallbackURLs: serializeAws_json1_1CallbackURLsListType(input.CallbackURLs, context),
     })), (input.ClientId !== undefined && input.ClientId !== null && { ClientId: input.ClientId })), (input.ClientName !== undefined && input.ClientName !== null && { ClientName: input.ClientName })), (input.DefaultRedirectURI !== undefined &&
-        input.DefaultRedirectURI !== null && { DefaultRedirectURI: input.DefaultRedirectURI })), (input.EnableTokenRevocation !== undefined &&
+        input.DefaultRedirectURI !== null && { DefaultRedirectURI: input.DefaultRedirectURI })), (input.EnablePropagateAdditionalUserContextData !== undefined &&
+        input.EnablePropagateAdditionalUserContextData !== null && {
+        EnablePropagateAdditionalUserContextData: input.EnablePropagateAdditionalUserContextData,
+    })), (input.EnableTokenRevocation !== undefined &&
         input.EnableTokenRevocation !== null && { EnableTokenRevocation: input.EnableTokenRevocation })), (input.ExplicitAuthFlows !== undefined &&
         input.ExplicitAuthFlows !== null && {
         ExplicitAuthFlows: serializeAws_json1_1ExplicitAuthFlowsListType(input.ExplicitAuthFlows, context),
@@ -10397,7 +10403,7 @@ var serializeAws_json1_1UserAttributeUpdateSettingsType = function (input, conte
     }));
 };
 var serializeAws_json1_1UserContextDataType = function (input, context) {
-    return __assign({}, (input.EncodedData !== undefined && input.EncodedData !== null && { EncodedData: input.EncodedData }));
+    return __assign(__assign({}, (input.EncodedData !== undefined && input.EncodedData !== null && { EncodedData: input.EncodedData })), (input.IpAddress !== undefined && input.IpAddress !== null && { IpAddress: input.IpAddress }));
 };
 var serializeAws_json1_1UsernameAttributesListType = function (input, context) {
     return input
@@ -12101,6 +12107,7 @@ var deserializeAws_json1_1UserPoolClientType = function (output, context) {
             ? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.CreationDate)))
             : undefined,
         DefaultRedirectURI: __expectString(output.DefaultRedirectURI),
+        EnablePropagateAdditionalUserContextData: __expectBoolean(output.EnablePropagateAdditionalUserContextData),
         EnableTokenRevocation: __expectBoolean(output.EnableTokenRevocation),
         ExplicitAuthFlows: output.ExplicitAuthFlows !== undefined && output.ExplicitAuthFlows !== null
             ? deserializeAws_json1_1ExplicitAuthFlowsListType(output.ExplicitAuthFlows, context)

package/dist-es/runtimeConfig.js

@@ -14,8 +14,10 @@ import { fromUtf8, toUtf8 } from "@aws-sdk/util-utf8-node";
 import { getRuntimeConfig as getSharedRuntimeConfig } from "./runtimeConfig.shared";
 import { loadConfigsForDefaultMode } from "@aws-sdk/smithy-client";
 import { resolveDefaultsModeConfig } from "@aws-sdk/util-defaults-mode-node";
+import { emitWarningIfUnsupportedVersion } from "@aws-sdk/smithy-client";
 export var getRuntimeConfig = function (config) {
     var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
+    emitWarningIfUnsupportedVersion(process.version);
     var defaultsMode = resolveDefaultsModeConfig(config);
     var defaultConfigProvider = function () { return defaultsMode().then(loadConfigsForDefaultMode); };
     var clientSharedValues = getSharedRuntimeConfig(config);

package/dist-types/CognitoIdentityProvider.d.ts

@@ -483,15 +483,22 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
     adminUserGlobalSignOut(args: AdminUserGlobalSignOutCommandInput, cb: (err: any, data?: AdminUserGlobalSignOutCommandOutput) => void): void;
     adminUserGlobalSignOut(args: AdminUserGlobalSignOutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminUserGlobalSignOutCommandOutput) => void): void;
     /**
-     * <p>Returns a unique generated shared secret key code for the user account. The request
-     *             takes an access token or a session string, but not both.</p>
+     * <p>Begins setup of time-based one-time password multi-factor authentication (TOTP MFA)
+     *             for a user, with a unique private key that Amazon Cognito generates and returns in the API
+     *             response. You can authorize an <code>AssociateSoftwareToken</code> request with either
+     *             the user's access token, or a session string from a challenge response that you received
+     *             from Amazon Cognito.</p>
      *         <note>
-     *             <p>Calling AssociateSoftwareToken immediately disassociates the existing software
-     *                 token from the user account. If the user doesn't subsequently verify the software
-     *                 token, their account is set up to authenticate without MFA. If MFA config is set to
-     *                 Optional at the user pool level, the user can then log in without MFA. However, if
-     *                 MFA is set to Required for the user pool, the user is asked to set up a new software
-     *                 token MFA during sign-in.</p>
+     *             <p>Amazon Cognito disassociates an existing software token when you verify the new token in a
+     *                     <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifySoftwareToken.html"> VerifySoftwareToken</a> API request. If you don't verify the software
+     *                 token and your user pool doesn't require MFA, the user can then authenticate with
+     *                 user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito
+     *                 generates an <code>MFA_SETUP</code> or <code>SOFTWARE_TOKEN_SETUP</code> challenge
+     *                 each time your user signs. Complete setup with <code>AssociateSoftwareToken</code>
+     *                 and <code>VerifySoftwareToken</code>.</p>
+     *             <p>After you set up software token MFA for your user, Amazon Cognito generates a
+     *                     <code>SOFTWARE_TOKEN_MFA</code> challenge when they authenticate. Respond to
+     *                 this challenge with your user's TOTP.</p>
      *         </note>
      */
     associateSoftwareToken(args: AssociateSoftwareTokenCommandInput, options?: __HttpHandlerOptions): Promise<AssociateSoftwareTokenCommandOutput>;

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

@@ -7,15 +7,22 @@ export interface AssociateSoftwareTokenCommandInput extends AssociateSoftwareTok
 export interface AssociateSoftwareTokenCommandOutput extends AssociateSoftwareTokenResponse, __MetadataBearer {
 }
 /**
- * <p>Returns a unique generated shared secret key code for the user account. The request
- *             takes an access token or a session string, but not both.</p>
+ * <p>Begins setup of time-based one-time password multi-factor authentication (TOTP MFA)
+ *             for a user, with a unique private key that Amazon Cognito generates and returns in the API
+ *             response. You can authorize an <code>AssociateSoftwareToken</code> request with either
+ *             the user's access token, or a session string from a challenge response that you received
+ *             from Amazon Cognito.</p>
  *         <note>
- *             <p>Calling AssociateSoftwareToken immediately disassociates the existing software
- *                 token from the user account. If the user doesn't subsequently verify the software
- *                 token, their account is set up to authenticate without MFA. If MFA config is set to
- *                 Optional at the user pool level, the user can then log in without MFA. However, if
- *                 MFA is set to Required for the user pool, the user is asked to set up a new software
- *                 token MFA during sign-in.</p>
+ *             <p>Amazon Cognito disassociates an existing software token when you verify the new token in a
+ *                     <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifySoftwareToken.html"> VerifySoftwareToken</a> API request. If you don't verify the software
+ *                 token and your user pool doesn't require MFA, the user can then authenticate with
+ *                 user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito
+ *                 generates an <code>MFA_SETUP</code> or <code>SOFTWARE_TOKEN_SETUP</code> challenge
+ *                 each time your user signs. Complete setup with <code>AssociateSoftwareToken</code>
+ *                 and <code>VerifySoftwareToken</code>.</p>
+ *             <p>After you set up software token MFA for your user, Amazon Cognito generates a
+ *                     <code>SOFTWARE_TOKEN_MFA</code> challenge when they authenticate. Respond to
+ *                 this challenge with your user's TOTP.</p>
  *         </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

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

@@ -1081,8 +1081,8 @@ export declare namespace AdminDisableProviderForUserResponse {
 }
 /**
  * <p>This exception is thrown when a user tries to confirm the account with an email
- *             address or phone number that has already been supplied as an alias from a different
- *             account. This exception indicates that an account with this email address or phone
+ *             address or phone number that has already been supplied as an alias for a different
+ *             user profile. This exception indicates that an account with this email address or phone
  *             already exists in a user pool that you've configured to use email address or phone
  *             number as a sign-in alias.</p>
  */
@@ -1408,7 +1408,7 @@ export declare namespace HttpHeader {
  */
 export interface ContextDataType {
     /**
-     * <p>Source IP address of your user.</p>
+     * <p>The source IP address of your user's device.</p>
      */
     IpAddress: string | undefined;
     /**
@@ -1424,8 +1424,8 @@ export interface ContextDataType {
      */
     HttpHeaders: HttpHeader[] | undefined;
     /**
-     * <p>Encoded data containing device fingerprinting details collected using the Amazon Cognito
-     *             context data collection library.</p>
+     * <p>Encoded device-fingerprint details that your app collected with the Amazon Cognito
+     *             context data collection library. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint">Adding user device and session data to API requests</a>.</p>
      */
     EncodedData?: string;
 }
@@ -1612,8 +1612,9 @@ export interface AdminInitiateAuthRequest {
      */
     AnalyticsMetadata?: AnalyticsMetadataType;
     /**
-     * <p>Contextual data such as the user's device fingerprint, IP address, or location used
-     *             for evaluating the risk of an unexpected event by Amazon Cognito advanced security.</p>
+     * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
+     * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
+     * when it makes API requests.</p>
      */
     ContextData?: ContextDataType;
 }
@@ -2111,7 +2112,7 @@ export declare namespace ChallengeResponseType {
  */
 export interface EventContextDataType {
     /**
-     * <p>The user's IP address.</p>
+     * <p>The source IP address of your user's device.</p>
      */
     IpAddress?: string;
     /**
@@ -2474,8 +2475,9 @@ export interface AdminRespondToAuthChallengeRequest {
      */
     AnalyticsMetadata?: AnalyticsMetadataType;
     /**
-     * <p>Contextual data such as the user's device fingerprint, IP address, or location used
-     *             for evaluating the risk of an unexpected event by Amazon Cognito advanced security.</p>
+     * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
+     * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
+     * when it makes API requests.</p>
      */
     ContextData?: ContextDataType;
     /**
@@ -3164,14 +3166,18 @@ export declare namespace ConfirmDeviceResponse {
     const filterSensitiveLog: (obj: ConfirmDeviceResponse) => any;
 }
 /**
- * <p>Information that your app generates about a user's <code>AdminInitiateAuth</code> or
- *                 <code>AdminRespondToAuthChallenge</code> session. Amazon Cognito advanced security features
- *             calculate risk levels for user sessions based on this context data.</p>
+ * <p>Contextual data, such as the user's device fingerprint, IP address, or location, used
+ *             for evaluating the risk of an unexpected event by Amazon Cognito advanced
+ *         security.</p>
  */
 export interface UserContextDataType {
     /**
-     * <p>Contextual data, such as the user's device fingerprint, IP address, or location, used
-     *             for evaluating the risk of an unexpected event by Amazon Cognito advanced security.</p>
+     * <p>The source IP address of your user's device.</p>
+     */
+    IpAddress?: string;
+    /**
+     * <p>Encoded device-fingerprint details that your app collected with the Amazon Cognito
+     *             context data collection library. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint">Adding user device and session data to API requests</a>.</p>
      */
     EncodedData?: string;
 }
@@ -3214,8 +3220,9 @@ export interface ConfirmForgotPasswordRequest {
      */
     AnalyticsMetadata?: AnalyticsMetadataType;
     /**
-     * <p>Contextual data such as the user's device fingerprint, IP address, or location used
-     *             for evaluating the risk of an unexpected event by Amazon Cognito advanced security.</p>
+     * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
+     * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
+     * when it makes API requests.</p>
      */
     UserContextData?: UserContextDataType;
     /**
@@ -3311,8 +3318,9 @@ export interface ConfirmSignUpRequest {
      */
     AnalyticsMetadata?: AnalyticsMetadataType;
     /**
-     * <p>Contextual data such as the user's device fingerprint, IP address, or location used
-     *             for evaluating the risk of an unexpected event by Amazon Cognito advanced security.</p>
+     * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
+     * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
+     * when it makes API requests.</p>
      */
     UserContextData?: UserContextDataType;
     /**
@@ -4394,7 +4402,10 @@ export declare namespace SmsConfigurationType {
     const filterSensitiveLog: (obj: SmsConfigurationType) => any;
 }
 /**
- * <p>The settings for updates to user attributes.</p>
+ * <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>,
+ * a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For
+ * more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates">
+ * Verifying updates to to email addresses and phone numbers</a>.</p>
  */
 export interface UserAttributeUpdateSettingsType {
     /**
@@ -4587,7 +4598,10 @@ export interface CreateUserPoolRequest {
      */
     MfaConfiguration?: UserPoolMfaType | string;
     /**
-     * <p></p>
+     * <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>,
+     * a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For
+     * more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates">
+     * Verifying updates to to email addresses and phone numbers</a>.</p>
      */
     UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType;
     /**
@@ -4726,7 +4740,10 @@ export interface UserPoolType {
      */
     SmsAuthenticationMessage?: string;
     /**
-     * <p></p>
+     * <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>,
+     * a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For
+     * more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates">
+     * Verifying updates to to email addresses and phone numbers</a>.</p>
      */
     UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType;
     /**
@@ -4910,18 +4927,22 @@ export declare enum TimeUnitsType {
  */
 export interface TokenValidityUnitsType {
     /**
-     * <p> A time unit in “seconds”, “minutes”, “hours”, or “days” for the value in
-     *             AccessTokenValidity, defaulting to hours.</p>
+     * <p> A time unit of <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or
+     *                 <code>days</code> for the value that you set in the <code>AccessTokenValidity</code>
+     *             parameter. The default <code>AccessTokenValidity</code> time unit is hours.</p>
      */
     AccessToken?: TimeUnitsType | string;
     /**
-     * <p>A time unit in “seconds”, “minutes”, “hours”, or “days” for the value in
-     *             IdTokenValidity, defaulting to hours.</p>
+     * <p>A time unit of <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or
+     *                 <code>days</code> for the value that you set in the <code>IdTokenValidity</code>
+     *             parameter. The default <code>IdTokenValidity</code> time unit is hours.</p>
      */
     IdToken?: TimeUnitsType | string;
     /**
-     * <p>A time unit in “seconds”, “minutes”, “hours”, or “days” for the value in
-     *             RefreshTokenValidity, defaulting to days.</p>
+     * <p>A time unit of <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or
+     *                 <code>days</code> for the value that you set in the
+     *                 <code>RefreshTokenValidity</code> parameter. The default
+     *                 <code>RefreshTokenValidity</code> time unit is days.</p>
      */
     RefreshToken?: TimeUnitsType | string;
 }
@@ -5177,6 +5198,15 @@ export interface CreateUserPoolClientRequest {
      *             the new user pool client.</p>
      */
     EnableTokenRevocation?: boolean;
+    /**
+     * <p>Activates the propagation of additional user context data. For more information about
+     *             propagation of user context data, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html"> Adding advanced security to a user pool</a>. If you don’t include this
+     *             parameter, you can't send device fingerprint information, including source IP address,
+     *             to Amazon Cognito advanced security. You can only activate
+     *                 <code>EnablePropagateAdditionalUserContextData</code> in an app client that has a
+     *             client secret.</p>
+     */
+    EnablePropagateAdditionalUserContextData?: boolean;
 }
 export declare namespace CreateUserPoolClientRequest {
     /**
@@ -5427,6 +5457,24 @@ export interface UserPoolClientType {
      *             information about revoking tokens, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
      */
     EnableTokenRevocation?: boolean;
+    /**
+     * <p>When <code>EnablePropagateAdditionalUserContextData</code> is true, Amazon Cognito accepts an
+     *                 <code>IpAddress</code> value that you send in the <code>UserContextData</code>
+     *             parameter. The <code>UserContextData</code> parameter sends information to Amazon Cognito
+     *             advanced security for risk analysis. You can send <code>UserContextData</code> when you
+     *             sign in Amazon Cognito native users with the <code>InitiateAuth</code> and
+     *                 <code>RespondToAuthChallenge</code> API operations.</p>
+     *         <p>When <code>EnablePropagateAdditionalUserContextData</code> is false, you can't send
+     *             your user's source IP address to Amazon Cognito advanced security with unauthenticated API
+     *             operations. <code>EnablePropagateAdditionalUserContextData</code> doesn't affect whether
+     *             you can send a source IP address in a <code>ContextData</code> parameter with the
+     *             authenticated API operations <code>AdminInitiateAuth</code> and
+     *                 <code>AdminRespondToAuthChallenge</code>.</p>
+     *         <p>You can only activate <code>EnablePropagateAdditionalUserContextData</code> in an app
+     *             client that has a client secret. For more information about propagation of user context
+     *             data, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint">Adding user device and session data to API requests</a>.</p>
+     */
+    EnablePropagateAdditionalUserContextData?: boolean;
 }
 export declare namespace UserPoolClientType {
     /**
@@ -6097,8 +6145,9 @@ export interface ForgotPasswordRequest {
      */
     SecretHash?: string;
     /**
-     * <p>Contextual data such as the user's device fingerprint, IP address, or location used
-     *             for evaluating the risk of an unexpected event by Amazon Cognito advanced security.</p>
+     * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
+     * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
+     * when it makes API requests.</p>
      */
     UserContextData?: UserContextDataType;
     /**
@@ -6183,8 +6232,7 @@ export declare namespace CodeDeliveryDetailsType {
     const filterSensitiveLog: (obj: CodeDeliveryDetailsType) => any;
 }
 /**
- * <p>Represents the response from the server regarding the request to reset a
- *             password.</p>
+ * <p>The response from Amazon Cognito to a request to reset a password.</p>
  */
 export interface ForgotPasswordResponse {
     /**
@@ -6831,8 +6879,9 @@ export interface InitiateAuthRequest {
      */
     AnalyticsMetadata?: AnalyticsMetadataType;
     /**
-     * <p>Contextual data such as the user's device fingerprint, IP address, or location used
-     *             for evaluating the risk of an unexpected event by Amazon Cognito advanced security.</p>
+     * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
+     * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
+     * when it makes API requests.</p>
      */
     UserContextData?: UserContextDataType;
 }
@@ -7546,8 +7595,9 @@ export interface ResendConfirmationCodeRequest {
      */
     SecretHash?: string;
     /**
-     * <p>Contextual data such as the user's device fingerprint, IP address, or location used
-     *             for evaluating the risk of an unexpected event by Amazon Cognito advanced security.</p>
+     * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
+     * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
+     * when it makes API requests.</p>
      */
     UserContextData?: UserContextDataType;
     /**
@@ -7720,8 +7770,9 @@ export interface RespondToAuthChallengeRequest {
      */
     AnalyticsMetadata?: AnalyticsMetadataType;
     /**
-     * <p>Contextual data such as the user's device fingerprint, IP address, or location used
-     *             for evaluating the risk of an unexpected event by Amazon Cognito advanced security.</p>
+     * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
+     * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
+     * when it makes API requests.</p>
      */
     UserContextData?: UserContextDataType;
     /**
@@ -8125,8 +8176,9 @@ export interface SignUpRequest {
      */
     AnalyticsMetadata?: AnalyticsMetadataType;
     /**
-     * <p>Contextual data such as the user's device fingerprint, IP address, or location used
-     *             for evaluating the risk of an unexpected event by Amazon Cognito advanced security.</p>
+     * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
+     * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
+     * when it makes API requests.</p>
      */
     UserContextData?: UserContextDataType;
     /**

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

@@ -440,7 +440,10 @@ export interface UpdateUserPoolRequest {
      */
     SmsAuthenticationMessage?: string;
     /**
-     * <p></p>
+     * <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>,
+     * a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For
+     * more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates">
+     * Verifying updates to to email addresses and phone numbers</a>.</p>
      */
     UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType;
     /**
@@ -759,6 +762,15 @@ export interface UpdateUserPoolClientRequest {
      *             see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
      */
     EnableTokenRevocation?: boolean;
+    /**
+     * <p>Activates the propagation of additional user context data. For more information about
+     *             propagation of user context data, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html"> Adding advanced security to a user pool</a>. If you don’t include this
+     *             parameter, you can't send device fingerprint information, including source IP address,
+     *             to Amazon Cognito advanced security. You can only activate
+     *                 <code>EnablePropagateAdditionalUserContextData</code> in an app client that has a
+     *             client secret.</p>
+     */
+    EnablePropagateAdditionalUserContextData?: boolean;
 }
 export declare namespace UpdateUserPoolClientRequest {
     /**

package/dist-types/ts3.4/models/models_0.d.ts

@@ -1423,6 +1423,8 @@ export declare namespace ConfirmDeviceResponse {
 
 export interface UserContextDataType {
     
+    IpAddress?: string;
+    
     EncodedData?: string;
 }
 export declare namespace UserContextDataType {
@@ -2128,6 +2130,8 @@ export interface CreateUserPoolClientRequest {
     PreventUserExistenceErrors?: PreventUserExistenceErrorTypes | string;
     
     EnableTokenRevocation?: boolean;
+    
+    EnablePropagateAdditionalUserContextData?: boolean;
 }
 export declare namespace CreateUserPoolClientRequest {
     
@@ -2181,6 +2185,8 @@ export interface UserPoolClientType {
     PreventUserExistenceErrors?: PreventUserExistenceErrorTypes | string;
     
     EnableTokenRevocation?: boolean;
+    
+    EnablePropagateAdditionalUserContextData?: boolean;
 }
 export declare namespace UserPoolClientType {
     

package/dist-types/ts3.4/models/models_1.d.ts

@@ -309,6 +309,8 @@ export interface UpdateUserPoolClientRequest {
     PreventUserExistenceErrors?: PreventUserExistenceErrorTypes | string;
     
     EnableTokenRevocation?: boolean;
+    
+    EnablePropagateAdditionalUserContextData?: boolean;
 }
 export declare namespace UpdateUserPoolClientRequest {
     

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-cognito-identity-provider",
   "description": "AWS SDK for JavaScript Cognito Identity Provider Client for Node.js, Browser and React Native",
-  "version": "3.98.0",
+  "version": "3.102.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -18,9 +18,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "2.0.0",
     "@aws-crypto/sha256-js": "2.0.0",
-    "@aws-sdk/client-sts": "3.95.0",
+    "@aws-sdk/client-sts": "3.100.0",
     "@aws-sdk/config-resolver": "3.80.0",
-    "@aws-sdk/credential-provider-node": "3.95.0",
+    "@aws-sdk/credential-provider-node": "3.100.0",
     "@aws-sdk/fetch-http-handler": "3.78.0",
     "@aws-sdk/hash-node": "3.78.0",
     "@aws-sdk/invalid-dependency": "3.78.0",
@@ -35,15 +35,15 @@
     "@aws-sdk/node-config-provider": "3.80.0",
     "@aws-sdk/node-http-handler": "3.94.0",
     "@aws-sdk/protocol-http": "3.78.0",
-    "@aws-sdk/smithy-client": "3.85.0",
+    "@aws-sdk/smithy-client": "3.99.0",
     "@aws-sdk/types": "3.78.0",
     "@aws-sdk/url-parser": "3.78.0",
     "@aws-sdk/util-base64-browser": "3.58.0",
     "@aws-sdk/util-base64-node": "3.55.0",
     "@aws-sdk/util-body-length-browser": "3.55.0",
     "@aws-sdk/util-body-length-node": "3.55.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.85.0",
-    "@aws-sdk/util-defaults-mode-node": "3.85.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.99.0",
+    "@aws-sdk/util-defaults-mode-node": "3.99.0",
     "@aws-sdk/util-user-agent-browser": "3.78.0",
     "@aws-sdk/util-user-agent-node": "3.80.0",
     "@aws-sdk/util-utf8-browser": "3.55.0",