@aws-sdk/client-cognito-identity-provider 3.99.0 → 3.105.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -3,6 +3,36 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [3.105.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.104.0...v3.105.0) (2022-06-06)
7
+
8
+
9
+ ### Features
10
+
11
+ * **clients:** support recursion detection in Lambda ([#3654](https://github.com/aws/aws-sdk-js-v3/issues/3654)) ([ecfe46e](https://github.com/aws/aws-sdk-js-v3/commit/ecfe46ea1fd8b6e3812b75b3dc6c03554fb4b3fa))
12
+
13
+
14
+
15
+
16
+
17
+ # [3.102.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.101.0...v3.102.0) (2022-05-31)
18
+
19
+
20
+ ### Features
21
+
22
+ * **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))
23
+
24
+
25
+
26
+
27
+
28
+ # [3.100.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.99.0...v3.100.0) (2022-05-26)
29
+
30
+ **Note:** Version bump only for package @aws-sdk/client-cognito-identity-provider
31
+
32
+
33
+
34
+
35
+
6
36
  # [3.99.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.98.0...v3.99.0) (2022-05-25)
7
37
 
8
38
  **Note:** Version bump only for package @aws-sdk/client-cognito-identity-provider
@@ -5,6 +5,7 @@ const config_resolver_1 = require("@aws-sdk/config-resolver");
5
5
  const middleware_content_length_1 = require("@aws-sdk/middleware-content-length");
6
6
  const middleware_host_header_1 = require("@aws-sdk/middleware-host-header");
7
7
  const middleware_logger_1 = require("@aws-sdk/middleware-logger");
8
+ const middleware_recursion_detection_1 = require("@aws-sdk/middleware-recursion-detection");
8
9
  const middleware_retry_1 = require("@aws-sdk/middleware-retry");
9
10
  const middleware_signing_1 = require("@aws-sdk/middleware-signing");
10
11
  const middleware_user_agent_1 = require("@aws-sdk/middleware-user-agent");
@@ -25,6 +26,7 @@ class CognitoIdentityProviderClient extends smithy_client_1.Client {
25
26
  this.middlewareStack.use((0, middleware_content_length_1.getContentLengthPlugin)(this.config));
26
27
  this.middlewareStack.use((0, middleware_host_header_1.getHostHeaderPlugin)(this.config));
27
28
  this.middlewareStack.use((0, middleware_logger_1.getLoggerPlugin)(this.config));
29
+ this.middlewareStack.use((0, middleware_recursion_detection_1.getRecursionDetectionPlugin)(this.config));
28
30
  this.middlewareStack.use((0, middleware_user_agent_1.getUserAgentPlugin)(this.config));
29
31
  }
30
32
  destroy() {
@@ -7641,6 +7641,10 @@ const serializeAws_json1_1CreateUserPoolClientRequest = (input, context) => {
7641
7641
  ...(input.ClientName !== undefined && input.ClientName !== null && { ClientName: input.ClientName }),
7642
7642
  ...(input.DefaultRedirectURI !== undefined &&
7643
7643
  input.DefaultRedirectURI !== null && { DefaultRedirectURI: input.DefaultRedirectURI }),
7644
+ ...(input.EnablePropagateAdditionalUserContextData !== undefined &&
7645
+ input.EnablePropagateAdditionalUserContextData !== null && {
7646
+ EnablePropagateAdditionalUserContextData: input.EnablePropagateAdditionalUserContextData,
7647
+ }),
7644
7648
  ...(input.EnableTokenRevocation !== undefined &&
7645
7649
  input.EnableTokenRevocation !== null && { EnableTokenRevocation: input.EnableTokenRevocation }),
7646
7650
  ...(input.ExplicitAuthFlows !== undefined &&
@@ -8706,6 +8710,10 @@ const serializeAws_json1_1UpdateUserPoolClientRequest = (input, context) => {
8706
8710
  ...(input.ClientName !== undefined && input.ClientName !== null && { ClientName: input.ClientName }),
8707
8711
  ...(input.DefaultRedirectURI !== undefined &&
8708
8712
  input.DefaultRedirectURI !== null && { DefaultRedirectURI: input.DefaultRedirectURI }),
8713
+ ...(input.EnablePropagateAdditionalUserContextData !== undefined &&
8714
+ input.EnablePropagateAdditionalUserContextData !== null && {
8715
+ EnablePropagateAdditionalUserContextData: input.EnablePropagateAdditionalUserContextData,
8716
+ }),
8709
8717
  ...(input.EnableTokenRevocation !== undefined &&
8710
8718
  input.EnableTokenRevocation !== null && { EnableTokenRevocation: input.EnableTokenRevocation }),
8711
8719
  ...(input.ExplicitAuthFlows !== undefined &&
@@ -8821,6 +8829,7 @@ const serializeAws_json1_1UserAttributeUpdateSettingsType = (input, context) =>
8821
8829
  const serializeAws_json1_1UserContextDataType = (input, context) => {
8822
8830
  return {
8823
8831
  ...(input.EncodedData !== undefined && input.EncodedData !== null && { EncodedData: input.EncodedData }),
8832
+ ...(input.IpAddress !== undefined && input.IpAddress !== null && { IpAddress: input.IpAddress }),
8824
8833
  };
8825
8834
  };
8826
8835
  const serializeAws_json1_1UsernameAttributesListType = (input, context) => {
@@ -10551,6 +10560,7 @@ const deserializeAws_json1_1UserPoolClientType = (output, context) => {
10551
10560
  ? (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(output.CreationDate)))
10552
10561
  : undefined,
10553
10562
  DefaultRedirectURI: (0, smithy_client_1.expectString)(output.DefaultRedirectURI),
10563
+ EnablePropagateAdditionalUserContextData: (0, smithy_client_1.expectBoolean)(output.EnablePropagateAdditionalUserContextData),
10554
10564
  EnableTokenRevocation: (0, smithy_client_1.expectBoolean)(output.EnableTokenRevocation),
10555
10565
  ExplicitAuthFlows: output.ExplicitAuthFlows !== undefined && output.ExplicitAuthFlows !== null
10556
10566
  ? deserializeAws_json1_1ExplicitAuthFlowsListType(output.ExplicitAuthFlows, context)
@@ -3,6 +3,7 @@ import { resolveEndpointsConfig, resolveRegionConfig, } from "@aws-sdk/config-re
3
3
  import { getContentLengthPlugin } from "@aws-sdk/middleware-content-length";
4
4
  import { getHostHeaderPlugin, resolveHostHeaderConfig, } from "@aws-sdk/middleware-host-header";
5
5
  import { getLoggerPlugin } from "@aws-sdk/middleware-logger";
6
+ import { getRecursionDetectionPlugin } from "@aws-sdk/middleware-recursion-detection";
6
7
  import { getRetryPlugin, resolveRetryConfig } from "@aws-sdk/middleware-retry";
7
8
  import { resolveAwsAuthConfig } from "@aws-sdk/middleware-signing";
8
9
  import { getUserAgentPlugin, resolveUserAgentConfig, } from "@aws-sdk/middleware-user-agent";
@@ -25,6 +26,7 @@ var CognitoIdentityProviderClient = (function (_super) {
25
26
  _this.middlewareStack.use(getContentLengthPlugin(_this.config));
26
27
  _this.middlewareStack.use(getHostHeaderPlugin(_this.config));
27
28
  _this.middlewareStack.use(getLoggerPlugin(_this.config));
29
+ _this.middlewareStack.use(getRecursionDetectionPlugin(_this.config));
28
30
  _this.middlewareStack.use(getUserAgentPlugin(_this.config));
29
31
  return _this;
30
32
  }
@@ -9615,7 +9615,7 @@ var serializeAws_json1_1CreateUserImportJobRequest = function (input, context) {
9615
9615
  input.CloudWatchLogsRoleArn !== null && { CloudWatchLogsRoleArn: input.CloudWatchLogsRoleArn })), (input.JobName !== undefined && input.JobName !== null && { JobName: input.JobName })), (input.UserPoolId !== undefined && input.UserPoolId !== null && { UserPoolId: input.UserPoolId }));
9616
9616
  };
9617
9617
  var serializeAws_json1_1CreateUserPoolClientRequest = function (input, context) {
9618
- return __assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, (input.AccessTokenValidity !== undefined &&
9618
+ 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 &&
9619
9619
  input.AccessTokenValidity !== null && { AccessTokenValidity: input.AccessTokenValidity })), (input.AllowedOAuthFlows !== undefined &&
9620
9620
  input.AllowedOAuthFlows !== null && {
9621
9621
  AllowedOAuthFlows: serializeAws_json1_1OAuthFlowsType(input.AllowedOAuthFlows, context),
@@ -9632,7 +9632,10 @@ var serializeAws_json1_1CreateUserPoolClientRequest = function (input, context)
9632
9632
  input.CallbackURLs !== null && {
9633
9633
  CallbackURLs: serializeAws_json1_1CallbackURLsListType(input.CallbackURLs, context),
9634
9634
  })), (input.ClientName !== undefined && input.ClientName !== null && { ClientName: input.ClientName })), (input.DefaultRedirectURI !== undefined &&
9635
- input.DefaultRedirectURI !== null && { DefaultRedirectURI: input.DefaultRedirectURI })), (input.EnableTokenRevocation !== undefined &&
9635
+ input.DefaultRedirectURI !== null && { DefaultRedirectURI: input.DefaultRedirectURI })), (input.EnablePropagateAdditionalUserContextData !== undefined &&
9636
+ input.EnablePropagateAdditionalUserContextData !== null && {
9637
+ EnablePropagateAdditionalUserContextData: input.EnablePropagateAdditionalUserContextData,
9638
+ })), (input.EnableTokenRevocation !== undefined &&
9636
9639
  input.EnableTokenRevocation !== null && { EnableTokenRevocation: input.EnableTokenRevocation })), (input.ExplicitAuthFlows !== undefined &&
9637
9640
  input.ExplicitAuthFlows !== null && {
9638
9641
  ExplicitAuthFlows: serializeAws_json1_1ExplicitAuthFlowsListType(input.ExplicitAuthFlows, context),
@@ -10303,7 +10306,7 @@ var serializeAws_json1_1UpdateUserAttributesRequest = function (input, context)
10303
10306
  }));
10304
10307
  };
10305
10308
  var serializeAws_json1_1UpdateUserPoolClientRequest = function (input, context) {
10306
- return __assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, (input.AccessTokenValidity !== undefined &&
10309
+ 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 &&
10307
10310
  input.AccessTokenValidity !== null && { AccessTokenValidity: input.AccessTokenValidity })), (input.AllowedOAuthFlows !== undefined &&
10308
10311
  input.AllowedOAuthFlows !== null && {
10309
10312
  AllowedOAuthFlows: serializeAws_json1_1OAuthFlowsType(input.AllowedOAuthFlows, context),
@@ -10320,7 +10323,10 @@ var serializeAws_json1_1UpdateUserPoolClientRequest = function (input, context)
10320
10323
  input.CallbackURLs !== null && {
10321
10324
  CallbackURLs: serializeAws_json1_1CallbackURLsListType(input.CallbackURLs, context),
10322
10325
  })), (input.ClientId !== undefined && input.ClientId !== null && { ClientId: input.ClientId })), (input.ClientName !== undefined && input.ClientName !== null && { ClientName: input.ClientName })), (input.DefaultRedirectURI !== undefined &&
10323
- input.DefaultRedirectURI !== null && { DefaultRedirectURI: input.DefaultRedirectURI })), (input.EnableTokenRevocation !== undefined &&
10326
+ input.DefaultRedirectURI !== null && { DefaultRedirectURI: input.DefaultRedirectURI })), (input.EnablePropagateAdditionalUserContextData !== undefined &&
10327
+ input.EnablePropagateAdditionalUserContextData !== null && {
10328
+ EnablePropagateAdditionalUserContextData: input.EnablePropagateAdditionalUserContextData,
10329
+ })), (input.EnableTokenRevocation !== undefined &&
10324
10330
  input.EnableTokenRevocation !== null && { EnableTokenRevocation: input.EnableTokenRevocation })), (input.ExplicitAuthFlows !== undefined &&
10325
10331
  input.ExplicitAuthFlows !== null && {
10326
10332
  ExplicitAuthFlows: serializeAws_json1_1ExplicitAuthFlowsListType(input.ExplicitAuthFlows, context),
@@ -10397,7 +10403,7 @@ var serializeAws_json1_1UserAttributeUpdateSettingsType = function (input, conte
10397
10403
  }));
10398
10404
  };
10399
10405
  var serializeAws_json1_1UserContextDataType = function (input, context) {
10400
- return __assign({}, (input.EncodedData !== undefined && input.EncodedData !== null && { EncodedData: input.EncodedData }));
10406
+ return __assign(__assign({}, (input.EncodedData !== undefined && input.EncodedData !== null && { EncodedData: input.EncodedData })), (input.IpAddress !== undefined && input.IpAddress !== null && { IpAddress: input.IpAddress }));
10401
10407
  };
10402
10408
  var serializeAws_json1_1UsernameAttributesListType = function (input, context) {
10403
10409
  return input
@@ -12101,6 +12107,7 @@ var deserializeAws_json1_1UserPoolClientType = function (output, context) {
12101
12107
  ? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.CreationDate)))
12102
12108
  : undefined,
12103
12109
  DefaultRedirectURI: __expectString(output.DefaultRedirectURI),
12110
+ EnablePropagateAdditionalUserContextData: __expectBoolean(output.EnablePropagateAdditionalUserContextData),
12104
12111
  EnableTokenRevocation: __expectBoolean(output.EnableTokenRevocation),
12105
12112
  ExplicitAuthFlows: output.ExplicitAuthFlows !== undefined && output.ExplicitAuthFlows !== null
12106
12113
  ? deserializeAws_json1_1ExplicitAuthFlowsListType(output.ExplicitAuthFlows, context)
@@ -483,15 +483,22 @@ export declare class CognitoIdentityProvider extends CognitoIdentityProviderClie
483
483
  adminUserGlobalSignOut(args: AdminUserGlobalSignOutCommandInput, cb: (err: any, data?: AdminUserGlobalSignOutCommandOutput) => void): void;
484
484
  adminUserGlobalSignOut(args: AdminUserGlobalSignOutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminUserGlobalSignOutCommandOutput) => void): void;
485
485
  /**
486
- * <p>Returns a unique generated shared secret key code for the user account. The request
487
- * takes an access token or a session string, but not both.</p>
486
+ * <p>Begins setup of time-based one-time password multi-factor authentication (TOTP MFA)
487
+ * for a user, with a unique private key that Amazon Cognito generates and returns in the API
488
+ * response. You can authorize an <code>AssociateSoftwareToken</code> request with either
489
+ * the user's access token, or a session string from a challenge response that you received
490
+ * from Amazon Cognito.</p>
488
491
  * <note>
489
- * <p>Calling AssociateSoftwareToken immediately disassociates the existing software
490
- * token from the user account. If the user doesn't subsequently verify the software
491
- * token, their account is set up to authenticate without MFA. If MFA config is set to
492
- * Optional at the user pool level, the user can then log in without MFA. However, if
493
- * MFA is set to Required for the user pool, the user is asked to set up a new software
494
- * token MFA during sign-in.</p>
492
+ * <p>Amazon Cognito disassociates an existing software token when you verify the new token in a
493
+ * <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
494
+ * token and your user pool doesn't require MFA, the user can then authenticate with
495
+ * user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito
496
+ * generates an <code>MFA_SETUP</code> or <code>SOFTWARE_TOKEN_SETUP</code> challenge
497
+ * each time your user signs. Complete setup with <code>AssociateSoftwareToken</code>
498
+ * and <code>VerifySoftwareToken</code>.</p>
499
+ * <p>After you set up software token MFA for your user, Amazon Cognito generates a
500
+ * <code>SOFTWARE_TOKEN_MFA</code> challenge when they authenticate. Respond to
501
+ * this challenge with your user's TOTP.</p>
495
502
  * </note>
496
503
  */
497
504
  associateSoftwareToken(args: AssociateSoftwareTokenCommandInput, options?: __HttpHandlerOptions): Promise<AssociateSoftwareTokenCommandOutput>;
@@ -7,15 +7,22 @@ export interface AssociateSoftwareTokenCommandInput extends AssociateSoftwareTok
7
7
  export interface AssociateSoftwareTokenCommandOutput extends AssociateSoftwareTokenResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Returns a unique generated shared secret key code for the user account. The request
11
- * takes an access token or a session string, but not both.</p>
10
+ * <p>Begins setup of time-based one-time password multi-factor authentication (TOTP MFA)
11
+ * for a user, with a unique private key that Amazon Cognito generates and returns in the API
12
+ * response. You can authorize an <code>AssociateSoftwareToken</code> request with either
13
+ * the user's access token, or a session string from a challenge response that you received
14
+ * from Amazon Cognito.</p>
12
15
  * <note>
13
- * <p>Calling AssociateSoftwareToken immediately disassociates the existing software
14
- * token from the user account. If the user doesn't subsequently verify the software
15
- * token, their account is set up to authenticate without MFA. If MFA config is set to
16
- * Optional at the user pool level, the user can then log in without MFA. However, if
17
- * MFA is set to Required for the user pool, the user is asked to set up a new software
18
- * token MFA during sign-in.</p>
16
+ * <p>Amazon Cognito disassociates an existing software token when you verify the new token in a
17
+ * <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
18
+ * token and your user pool doesn't require MFA, the user can then authenticate with
19
+ * user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito
20
+ * generates an <code>MFA_SETUP</code> or <code>SOFTWARE_TOKEN_SETUP</code> challenge
21
+ * each time your user signs. Complete setup with <code>AssociateSoftwareToken</code>
22
+ * and <code>VerifySoftwareToken</code>.</p>
23
+ * <p>After you set up software token MFA for your user, Amazon Cognito generates a
24
+ * <code>SOFTWARE_TOKEN_MFA</code> challenge when they authenticate. Respond to
25
+ * this challenge with your user's TOTP.</p>
19
26
  * </note>
20
27
  * @example
21
28
  * Use a bare-bones client and the command you need to make an API call.
@@ -467,9 +467,7 @@ export interface AdminConfirmSignUpRequest {
467
467
  * </ul>
468
468
  * </note>
469
469
  */
470
- ClientMetadata?: {
471
- [key: string]: string;
472
- };
470
+ ClientMetadata?: Record<string, string>;
473
471
  }
474
472
  export declare namespace AdminConfirmSignUpRequest {
475
473
  /**
@@ -712,9 +710,7 @@ export interface AdminCreateUserRequest {
712
710
  * </ul>
713
711
  * </note>
714
712
  */
715
- ClientMetadata?: {
716
- [key: string]: string;
717
- };
713
+ ClientMetadata?: Record<string, string>;
718
714
  }
719
715
  export declare namespace AdminCreateUserRequest {
720
716
  /**
@@ -1081,8 +1077,8 @@ export declare namespace AdminDisableProviderForUserResponse {
1081
1077
  }
1082
1078
  /**
1083
1079
  * <p>This exception is thrown when a user tries to confirm the account with an email
1084
- * address or phone number that has already been supplied as an alias from a different
1085
- * account. This exception indicates that an account with this email address or phone
1080
+ * address or phone number that has already been supplied as an alias for a different
1081
+ * user profile. This exception indicates that an account with this email address or phone
1086
1082
  * already exists in a user pool that you've configured to use email address or phone
1087
1083
  * number as a sign-in alias.</p>
1088
1084
  */
@@ -1408,7 +1404,7 @@ export declare namespace HttpHeader {
1408
1404
  */
1409
1405
  export interface ContextDataType {
1410
1406
  /**
1411
- * <p>Source IP address of your user.</p>
1407
+ * <p>The source IP address of your user's device.</p>
1412
1408
  */
1413
1409
  IpAddress: string | undefined;
1414
1410
  /**
@@ -1424,8 +1420,8 @@ export interface ContextDataType {
1424
1420
  */
1425
1421
  HttpHeaders: HttpHeader[] | undefined;
1426
1422
  /**
1427
- * <p>Encoded data containing device fingerprinting details collected using the Amazon Cognito
1428
- * context data collection library.</p>
1423
+ * <p>Encoded device-fingerprint details that your app collected with the Amazon Cognito
1424
+ * 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>
1429
1425
  */
1430
1426
  EncodedData?: string;
1431
1427
  }
@@ -1530,9 +1526,7 @@ export interface AdminInitiateAuthRequest {
1530
1526
  * </li>
1531
1527
  * </ul>
1532
1528
  */
1533
- AuthParameters?: {
1534
- [key: string]: string;
1535
- };
1529
+ AuthParameters?: Record<string, string>;
1536
1530
  /**
1537
1531
  * <p>A map of custom key-value pairs that you can provide as input for certain custom
1538
1532
  * workflows that this action triggers.</p>
@@ -1603,17 +1597,16 @@ export interface AdminInitiateAuthRequest {
1603
1597
  * </ul>
1604
1598
  * </note>
1605
1599
  */
1606
- ClientMetadata?: {
1607
- [key: string]: string;
1608
- };
1600
+ ClientMetadata?: Record<string, string>;
1609
1601
  /**
1610
1602
  * <p>The analytics metadata for collecting Amazon Pinpoint metrics for
1611
1603
  * <code>AdminInitiateAuth</code> calls.</p>
1612
1604
  */
1613
1605
  AnalyticsMetadata?: AnalyticsMetadataType;
1614
1606
  /**
1615
- * <p>Contextual data such as the user's device fingerprint, IP address, or location used
1616
- * for evaluating the risk of an unexpected event by Amazon Cognito advanced security.</p>
1607
+ * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
1608
+ * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
1609
+ * when it makes API requests.</p>
1617
1610
  */
1618
1611
  ContextData?: ContextDataType;
1619
1612
  }
@@ -1801,9 +1794,7 @@ export interface AdminInitiateAuthResponse {
1801
1794
  * <code>AdminRespondToAuthChallenge</code> API <code>ChallengeResponses</code>, the
1802
1795
  * <code>USERNAME</code> attribute can't be an alias.</p>
1803
1796
  */
1804
- ChallengeParameters?: {
1805
- [key: string]: string;
1806
- };
1797
+ ChallengeParameters?: Record<string, string>;
1807
1798
  /**
1808
1799
  * <p>The result of the authentication response. This is only returned if the caller doesn't
1809
1800
  * need to pass another challenge. If the caller does need to pass another challenge before
@@ -2111,7 +2102,7 @@ export declare namespace ChallengeResponseType {
2111
2102
  */
2112
2103
  export interface EventContextDataType {
2113
2104
  /**
2114
- * <p>The user's IP address.</p>
2105
+ * <p>The source IP address of your user's device.</p>
2115
2106
  */
2116
2107
  IpAddress?: string;
2117
2108
  /**
@@ -2348,9 +2339,7 @@ export interface AdminResetUserPasswordRequest {
2348
2339
  * </ul>
2349
2340
  * </note>
2350
2341
  */
2351
- ClientMetadata?: {
2352
- [key: string]: string;
2353
- };
2342
+ ClientMetadata?: Record<string, string>;
2354
2343
  }
2355
2344
  export declare namespace AdminResetUserPasswordRequest {
2356
2345
  /**
@@ -2457,9 +2446,7 @@ export interface AdminRespondToAuthChallengeRequest {
2457
2446
  * <code>USERNAMEUSER_ID_FOR_SRP</code> attribute. This happens even if you specified
2458
2447
  * an alias in your call to <code>AdminInitiateAuth</code>.</p>
2459
2448
  */
2460
- ChallengeResponses?: {
2461
- [key: string]: string;
2462
- };
2449
+ ChallengeResponses?: Record<string, string>;
2463
2450
  /**
2464
2451
  * <p>The session that should be passed both ways in challenge-response calls to the
2465
2452
  * service. If an <code>InitiateAuth</code> or <code>RespondToAuthChallenge</code> API call
@@ -2474,8 +2461,9 @@ export interface AdminRespondToAuthChallengeRequest {
2474
2461
  */
2475
2462
  AnalyticsMetadata?: AnalyticsMetadataType;
2476
2463
  /**
2477
- * <p>Contextual data such as the user's device fingerprint, IP address, or location used
2478
- * for evaluating the risk of an unexpected event by Amazon Cognito advanced security.</p>
2464
+ * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
2465
+ * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
2466
+ * when it makes API requests.</p>
2479
2467
  */
2480
2468
  ContextData?: ContextDataType;
2481
2469
  /**
@@ -2540,9 +2528,7 @@ export interface AdminRespondToAuthChallengeRequest {
2540
2528
  * </ul>
2541
2529
  * </note>
2542
2530
  */
2543
- ClientMetadata?: {
2544
- [key: string]: string;
2545
- };
2531
+ ClientMetadata?: Record<string, string>;
2546
2532
  }
2547
2533
  export declare namespace AdminRespondToAuthChallengeRequest {
2548
2534
  /**
@@ -2568,9 +2554,7 @@ export interface AdminRespondToAuthChallengeResponse {
2568
2554
  /**
2569
2555
  * <p>The challenge parameters. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html">AdminInitiateAuth</a>.</p>
2570
2556
  */
2571
- ChallengeParameters?: {
2572
- [key: string]: string;
2573
- };
2557
+ ChallengeParameters?: Record<string, string>;
2574
2558
  /**
2575
2559
  * <p>The result returned by the server in response to the authentication request.</p>
2576
2560
  */
@@ -2910,9 +2894,7 @@ export interface AdminUpdateUserAttributesRequest {
2910
2894
  * </ul>
2911
2895
  * </note>
2912
2896
  */
2913
- ClientMetadata?: {
2914
- [key: string]: string;
2915
- };
2897
+ ClientMetadata?: Record<string, string>;
2916
2898
  }
2917
2899
  export declare namespace AdminUpdateUserAttributesRequest {
2918
2900
  /**
@@ -3164,14 +3146,18 @@ export declare namespace ConfirmDeviceResponse {
3164
3146
  const filterSensitiveLog: (obj: ConfirmDeviceResponse) => any;
3165
3147
  }
3166
3148
  /**
3167
- * <p>Information that your app generates about a user's <code>AdminInitiateAuth</code> or
3168
- * <code>AdminRespondToAuthChallenge</code> session. Amazon Cognito advanced security features
3169
- * calculate risk levels for user sessions based on this context data.</p>
3149
+ * <p>Contextual data, such as the user's device fingerprint, IP address, or location, used
3150
+ * for evaluating the risk of an unexpected event by Amazon Cognito advanced
3151
+ * security.</p>
3170
3152
  */
3171
3153
  export interface UserContextDataType {
3172
3154
  /**
3173
- * <p>Contextual data, such as the user's device fingerprint, IP address, or location, used
3174
- * for evaluating the risk of an unexpected event by Amazon Cognito advanced security.</p>
3155
+ * <p>The source IP address of your user's device.</p>
3156
+ */
3157
+ IpAddress?: string;
3158
+ /**
3159
+ * <p>Encoded device-fingerprint details that your app collected with the Amazon Cognito
3160
+ * 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>
3175
3161
  */
3176
3162
  EncodedData?: string;
3177
3163
  }
@@ -3214,8 +3200,9 @@ export interface ConfirmForgotPasswordRequest {
3214
3200
  */
3215
3201
  AnalyticsMetadata?: AnalyticsMetadataType;
3216
3202
  /**
3217
- * <p>Contextual data such as the user's device fingerprint, IP address, or location used
3218
- * for evaluating the risk of an unexpected event by Amazon Cognito advanced security.</p>
3203
+ * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
3204
+ * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
3205
+ * when it makes API requests.</p>
3219
3206
  */
3220
3207
  UserContextData?: UserContextDataType;
3221
3208
  /**
@@ -3253,9 +3240,7 @@ export interface ConfirmForgotPasswordRequest {
3253
3240
  * </ul>
3254
3241
  * </note>
3255
3242
  */
3256
- ClientMetadata?: {
3257
- [key: string]: string;
3258
- };
3243
+ ClientMetadata?: Record<string, string>;
3259
3244
  }
3260
3245
  export declare namespace ConfirmForgotPasswordRequest {
3261
3246
  /**
@@ -3311,8 +3296,9 @@ export interface ConfirmSignUpRequest {
3311
3296
  */
3312
3297
  AnalyticsMetadata?: AnalyticsMetadataType;
3313
3298
  /**
3314
- * <p>Contextual data such as the user's device fingerprint, IP address, or location used
3315
- * for evaluating the risk of an unexpected event by Amazon Cognito advanced security.</p>
3299
+ * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
3300
+ * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
3301
+ * when it makes API requests.</p>
3316
3302
  */
3317
3303
  UserContextData?: UserContextDataType;
3318
3304
  /**
@@ -3350,9 +3336,7 @@ export interface ConfirmSignUpRequest {
3350
3336
  * </ul>
3351
3337
  * </note>
3352
3338
  */
3353
- ClientMetadata?: {
3354
- [key: string]: string;
3355
- };
3339
+ ClientMetadata?: Record<string, string>;
3356
3340
  }
3357
3341
  export declare namespace ConfirmSignUpRequest {
3358
3342
  /**
@@ -3574,15 +3558,11 @@ export interface CreateIdentityProviderRequest {
3574
3558
  * </li>
3575
3559
  * </ul>
3576
3560
  */
3577
- ProviderDetails: {
3578
- [key: string]: string;
3579
- } | undefined;
3561
+ ProviderDetails: Record<string, string> | undefined;
3580
3562
  /**
3581
3563
  * <p>A mapping of IdP attributes to standard and custom user pool attributes.</p>
3582
3564
  */
3583
- AttributeMapping?: {
3584
- [key: string]: string;
3585
- };
3565
+ AttributeMapping?: Record<string, string>;
3586
3566
  /**
3587
3567
  * <p>A list of IdP identifiers.</p>
3588
3568
  */
@@ -3730,15 +3710,11 @@ export interface IdentityProviderType {
3730
3710
  * </li>
3731
3711
  * </ul>
3732
3712
  */
3733
- ProviderDetails?: {
3734
- [key: string]: string;
3735
- };
3713
+ ProviderDetails?: Record<string, string>;
3736
3714
  /**
3737
3715
  * <p>A mapping of IdP attributes to standard and custom user pool attributes.</p>
3738
3716
  */
3739
- AttributeMapping?: {
3740
- [key: string]: string;
3741
- };
3717
+ AttributeMapping?: Record<string, string>;
3742
3718
  /**
3743
3719
  * <p>A list of IdP identifiers.</p>
3744
3720
  */
@@ -4394,7 +4370,10 @@ export declare namespace SmsConfigurationType {
4394
4370
  const filterSensitiveLog: (obj: SmsConfigurationType) => any;
4395
4371
  }
4396
4372
  /**
4397
- * <p>The settings for updates to user attributes.</p>
4373
+ * <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>,
4374
+ * 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
4375
+ * 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">
4376
+ * Verifying updates to to email addresses and phone numbers</a>.</p>
4398
4377
  */
4399
4378
  export interface UserAttributeUpdateSettingsType {
4400
4379
  /**
@@ -4587,7 +4566,10 @@ export interface CreateUserPoolRequest {
4587
4566
  */
4588
4567
  MfaConfiguration?: UserPoolMfaType | string;
4589
4568
  /**
4590
- * <p></p>
4569
+ * <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>,
4570
+ * 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
4571
+ * 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">
4572
+ * Verifying updates to to email addresses and phone numbers</a>.</p>
4591
4573
  */
4592
4574
  UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType;
4593
4575
  /**
@@ -4612,9 +4594,7 @@ export interface CreateUserPoolRequest {
4612
4594
  * to categorize and manage user pools in different ways, such as by purpose, owner,
4613
4595
  * environment, or other criteria.</p>
4614
4596
  */
4615
- UserPoolTags?: {
4616
- [key: string]: string;
4617
- };
4597
+ UserPoolTags?: Record<string, string>;
4618
4598
  /**
4619
4599
  * <p>The configuration for <code>AdminCreateUser</code> requests.</p>
4620
4600
  */
@@ -4726,7 +4706,10 @@ export interface UserPoolType {
4726
4706
  */
4727
4707
  SmsAuthenticationMessage?: string;
4728
4708
  /**
4729
- * <p></p>
4709
+ * <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>,
4710
+ * 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
4711
+ * 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">
4712
+ * Verifying updates to to email addresses and phone numbers</a>.</p>
4730
4713
  */
4731
4714
  UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType;
4732
4715
  /**
@@ -4776,9 +4759,7 @@ export interface UserPoolType {
4776
4759
  * user pools to categorize and manage them in different ways, such as by purpose, owner,
4777
4760
  * environment, or other criteria.</p>
4778
4761
  */
4779
- UserPoolTags?: {
4780
- [key: string]: string;
4781
- };
4762
+ UserPoolTags?: Record<string, string>;
4782
4763
  /**
4783
4764
  * <p>The reason why the SMS configuration can't send the messages to your users.</p>
4784
4765
  * <p>This message might include comma-separated values to describe why your SMS
@@ -4910,18 +4891,22 @@ export declare enum TimeUnitsType {
4910
4891
  */
4911
4892
  export interface TokenValidityUnitsType {
4912
4893
  /**
4913
- * <p> A time unit in seconds”, minutes”, hours”, or “days” for the value in
4914
- * AccessTokenValidity, defaulting to hours.</p>
4894
+ * <p> A time unit of <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or
4895
+ * <code>days</code> for the value that you set in the <code>AccessTokenValidity</code>
4896
+ * parameter. The default <code>AccessTokenValidity</code> time unit is hours.</p>
4915
4897
  */
4916
4898
  AccessToken?: TimeUnitsType | string;
4917
4899
  /**
4918
- * <p>A time unit in seconds”, minutes”, hours”, or “days” for the value in
4919
- * IdTokenValidity, defaulting to hours.</p>
4900
+ * <p>A time unit of <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or
4901
+ * <code>days</code> for the value that you set in the <code>IdTokenValidity</code>
4902
+ * parameter. The default <code>IdTokenValidity</code> time unit is hours.</p>
4920
4903
  */
4921
4904
  IdToken?: TimeUnitsType | string;
4922
4905
  /**
4923
- * <p>A time unit in seconds”, minutes”, hours”, or “days” for the value in
4924
- * RefreshTokenValidity, defaulting to days.</p>
4906
+ * <p>A time unit of <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or
4907
+ * <code>days</code> for the value that you set in the
4908
+ * <code>RefreshTokenValidity</code> parameter. The default
4909
+ * <code>RefreshTokenValidity</code> time unit is days.</p>
4925
4910
  */
4926
4911
  RefreshToken?: TimeUnitsType | string;
4927
4912
  }
@@ -5177,6 +5162,15 @@ export interface CreateUserPoolClientRequest {
5177
5162
  * the new user pool client.</p>
5178
5163
  */
5179
5164
  EnableTokenRevocation?: boolean;
5165
+ /**
5166
+ * <p>Activates the propagation of additional user context data. For more information about
5167
+ * 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
5168
+ * parameter, you can't send device fingerprint information, including source IP address,
5169
+ * to Amazon Cognito advanced security. You can only activate
5170
+ * <code>EnablePropagateAdditionalUserContextData</code> in an app client that has a
5171
+ * client secret.</p>
5172
+ */
5173
+ EnablePropagateAdditionalUserContextData?: boolean;
5180
5174
  }
5181
5175
  export declare namespace CreateUserPoolClientRequest {
5182
5176
  /**
@@ -5427,6 +5421,24 @@ export interface UserPoolClientType {
5427
5421
  * information about revoking tokens, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
5428
5422
  */
5429
5423
  EnableTokenRevocation?: boolean;
5424
+ /**
5425
+ * <p>When <code>EnablePropagateAdditionalUserContextData</code> is true, Amazon Cognito accepts an
5426
+ * <code>IpAddress</code> value that you send in the <code>UserContextData</code>
5427
+ * parameter. The <code>UserContextData</code> parameter sends information to Amazon Cognito
5428
+ * advanced security for risk analysis. You can send <code>UserContextData</code> when you
5429
+ * sign in Amazon Cognito native users with the <code>InitiateAuth</code> and
5430
+ * <code>RespondToAuthChallenge</code> API operations.</p>
5431
+ * <p>When <code>EnablePropagateAdditionalUserContextData</code> is false, you can't send
5432
+ * your user's source IP address to Amazon Cognito advanced security with unauthenticated API
5433
+ * operations. <code>EnablePropagateAdditionalUserContextData</code> doesn't affect whether
5434
+ * you can send a source IP address in a <code>ContextData</code> parameter with the
5435
+ * authenticated API operations <code>AdminInitiateAuth</code> and
5436
+ * <code>AdminRespondToAuthChallenge</code>.</p>
5437
+ * <p>You can only activate <code>EnablePropagateAdditionalUserContextData</code> in an app
5438
+ * client that has a client secret. For more information about propagation of user context
5439
+ * 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>
5440
+ */
5441
+ EnablePropagateAdditionalUserContextData?: boolean;
5430
5442
  }
5431
5443
  export declare namespace UserPoolClientType {
5432
5444
  /**
@@ -6097,8 +6109,9 @@ export interface ForgotPasswordRequest {
6097
6109
  */
6098
6110
  SecretHash?: string;
6099
6111
  /**
6100
- * <p>Contextual data such as the user's device fingerprint, IP address, or location used
6101
- * for evaluating the risk of an unexpected event by Amazon Cognito advanced security.</p>
6112
+ * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
6113
+ * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
6114
+ * when it makes API requests.</p>
6102
6115
  */
6103
6116
  UserContextData?: UserContextDataType;
6104
6117
  /**
@@ -6148,9 +6161,7 @@ export interface ForgotPasswordRequest {
6148
6161
  * </ul>
6149
6162
  * </note>
6150
6163
  */
6151
- ClientMetadata?: {
6152
- [key: string]: string;
6153
- };
6164
+ ClientMetadata?: Record<string, string>;
6154
6165
  }
6155
6166
  export declare namespace ForgotPasswordRequest {
6156
6167
  /**
@@ -6183,8 +6194,7 @@ export declare namespace CodeDeliveryDetailsType {
6183
6194
  const filterSensitiveLog: (obj: CodeDeliveryDetailsType) => any;
6184
6195
  }
6185
6196
  /**
6186
- * <p>Represents the response from the server regarding the request to reset a
6187
- * password.</p>
6197
+ * <p>The response from Amazon Cognito to a request to reset a password.</p>
6188
6198
  */
6189
6199
  export interface ForgotPasswordResponse {
6190
6200
  /**
@@ -6528,9 +6538,7 @@ export interface GetUserAttributeVerificationCodeRequest {
6528
6538
  * </ul>
6529
6539
  * </note>
6530
6540
  */
6531
- ClientMetadata?: {
6532
- [key: string]: string;
6533
- };
6541
+ ClientMetadata?: Record<string, string>;
6534
6542
  }
6535
6543
  export declare namespace GetUserAttributeVerificationCodeRequest {
6536
6544
  /**
@@ -6745,9 +6753,7 @@ export interface InitiateAuthRequest {
6745
6753
  * </li>
6746
6754
  * </ul>
6747
6755
  */
6748
- AuthParameters?: {
6749
- [key: string]: string;
6750
- };
6756
+ AuthParameters?: Record<string, string>;
6751
6757
  /**
6752
6758
  * <p>A map of custom key-value pairs that you can provide as input for certain custom
6753
6759
  * workflows that this action triggers.</p>
@@ -6818,9 +6824,7 @@ export interface InitiateAuthRequest {
6818
6824
  * </ul>
6819
6825
  * </note>
6820
6826
  */
6821
- ClientMetadata?: {
6822
- [key: string]: string;
6823
- };
6827
+ ClientMetadata?: Record<string, string>;
6824
6828
  /**
6825
6829
  * <p>The app client ID.</p>
6826
6830
  */
@@ -6831,8 +6835,9 @@ export interface InitiateAuthRequest {
6831
6835
  */
6832
6836
  AnalyticsMetadata?: AnalyticsMetadataType;
6833
6837
  /**
6834
- * <p>Contextual data such as the user's device fingerprint, IP address, or location used
6835
- * for evaluating the risk of an unexpected event by Amazon Cognito advanced security.</p>
6838
+ * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
6839
+ * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
6840
+ * when it makes API requests.</p>
6836
6841
  */
6837
6842
  UserContextData?: UserContextDataType;
6838
6843
  }
@@ -6933,9 +6938,7 @@ export interface InitiateAuthResponse {
6933
6938
  * <p>All challenges require <code>USERNAME</code> and <code>SECRET_HASH</code> (if
6934
6939
  * applicable).</p>
6935
6940
  */
6936
- ChallengeParameters?: {
6937
- [key: string]: string;
6938
- };
6941
+ ChallengeParameters?: Record<string, string>;
6939
6942
  /**
6940
6943
  * <p>The result of the authentication response. This result is only returned if the caller
6941
6944
  * doesn't need to pass another challenge. If the caller does need to pass another
@@ -7146,9 +7149,7 @@ export interface ListTagsForResourceResponse {
7146
7149
  /**
7147
7150
  * <p>The tags that are assigned to the user pool.</p>
7148
7151
  */
7149
- Tags?: {
7150
- [key: string]: string;
7151
- };
7152
+ Tags?: Record<string, string>;
7152
7153
  }
7153
7154
  export declare namespace ListTagsForResourceResponse {
7154
7155
  /**
@@ -7546,8 +7547,9 @@ export interface ResendConfirmationCodeRequest {
7546
7547
  */
7547
7548
  SecretHash?: string;
7548
7549
  /**
7549
- * <p>Contextual data such as the user's device fingerprint, IP address, or location used
7550
- * for evaluating the risk of an unexpected event by Amazon Cognito advanced security.</p>
7550
+ * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
7551
+ * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
7552
+ * when it makes API requests.</p>
7551
7553
  */
7552
7554
  UserContextData?: UserContextDataType;
7553
7555
  /**
@@ -7595,9 +7597,7 @@ export interface ResendConfirmationCodeRequest {
7595
7597
  * </ul>
7596
7598
  * </note>
7597
7599
  */
7598
- ClientMetadata?: {
7599
- [key: string]: string;
7600
- };
7600
+ ClientMetadata?: Record<string, string>;
7601
7601
  }
7602
7602
  export declare namespace ResendConfirmationCodeRequest {
7603
7603
  /**
@@ -7711,17 +7711,16 @@ export interface RespondToAuthChallengeRequest {
7711
7711
  * </li>
7712
7712
  * </ul>
7713
7713
  */
7714
- ChallengeResponses?: {
7715
- [key: string]: string;
7716
- };
7714
+ ChallengeResponses?: Record<string, string>;
7717
7715
  /**
7718
7716
  * <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for
7719
7717
  * <code>RespondToAuthChallenge</code> calls.</p>
7720
7718
  */
7721
7719
  AnalyticsMetadata?: AnalyticsMetadataType;
7722
7720
  /**
7723
- * <p>Contextual data such as the user's device fingerprint, IP address, or location used
7724
- * for evaluating the risk of an unexpected event by Amazon Cognito advanced security.</p>
7721
+ * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
7722
+ * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
7723
+ * when it makes API requests.</p>
7725
7724
  */
7726
7725
  UserContextData?: UserContextDataType;
7727
7726
  /**
@@ -7763,9 +7762,7 @@ export interface RespondToAuthChallengeRequest {
7763
7762
  * </ul>
7764
7763
  * </note>
7765
7764
  */
7766
- ClientMetadata?: {
7767
- [key: string]: string;
7768
- };
7765
+ ClientMetadata?: Record<string, string>;
7769
7766
  }
7770
7767
  export declare namespace RespondToAuthChallengeRequest {
7771
7768
  /**
@@ -7791,9 +7788,7 @@ export interface RespondToAuthChallengeResponse {
7791
7788
  /**
7792
7789
  * <p>The challenge parameters. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a>.</p>
7793
7790
  */
7794
- ChallengeParameters?: {
7795
- [key: string]: string;
7796
- };
7791
+ ChallengeParameters?: Record<string, string>;
7797
7792
  /**
7798
7793
  * <p>The result returned by the server in response to the request to respond to the
7799
7794
  * authentication challenge.</p>
@@ -8125,8 +8120,9 @@ export interface SignUpRequest {
8125
8120
  */
8126
8121
  AnalyticsMetadata?: AnalyticsMetadataType;
8127
8122
  /**
8128
- * <p>Contextual data such as the user's device fingerprint, IP address, or location used
8129
- * for evaluating the risk of an unexpected event by Amazon Cognito advanced security.</p>
8123
+ * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
8124
+ * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
8125
+ * when it makes API requests.</p>
8130
8126
  */
8131
8127
  UserContextData?: UserContextDataType;
8132
8128
  /**
@@ -8165,9 +8161,7 @@ export interface SignUpRequest {
8165
8161
  * </ul>
8166
8162
  * </note>
8167
8163
  */
8168
- ClientMetadata?: {
8169
- [key: string]: string;
8170
- };
8164
+ ClientMetadata?: Record<string, string>;
8171
8165
  }
8172
8166
  export declare namespace SignUpRequest {
8173
8167
  /**
@@ -79,9 +79,7 @@ export interface TagResourceRequest {
79
79
  /**
80
80
  * <p>The tags to assign to the user pool.</p>
81
81
  */
82
- Tags: {
83
- [key: string]: string;
84
- } | undefined;
82
+ Tags: Record<string, string> | undefined;
85
83
  }
86
84
  export declare namespace TagResourceRequest {
87
85
  /**
@@ -248,15 +246,11 @@ export interface UpdateIdentityProviderRequest {
248
246
  * <p>The IdP details to be updated, such as <code>MetadataURL</code> and
249
247
  * <code>MetadataFile</code>.</p>
250
248
  */
251
- ProviderDetails?: {
252
- [key: string]: string;
253
- };
249
+ ProviderDetails?: Record<string, string>;
254
250
  /**
255
251
  * <p>The IdP attribute mapping to be changed.</p>
256
252
  */
257
- AttributeMapping?: {
258
- [key: string]: string;
259
- };
253
+ AttributeMapping?: Record<string, string>;
260
254
  /**
261
255
  * <p>A list of IdP identifiers.</p>
262
256
  */
@@ -371,9 +365,7 @@ export interface UpdateUserAttributesRequest {
371
365
  * </ul>
372
366
  * </note>
373
367
  */
374
- ClientMetadata?: {
375
- [key: string]: string;
376
- };
368
+ ClientMetadata?: Record<string, string>;
377
369
  }
378
370
  export declare namespace UpdateUserAttributesRequest {
379
371
  /**
@@ -440,7 +432,10 @@ export interface UpdateUserPoolRequest {
440
432
  */
441
433
  SmsAuthenticationMessage?: string;
442
434
  /**
443
- * <p></p>
435
+ * <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>,
436
+ * 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
437
+ * 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">
438
+ * Verifying updates to to email addresses and phone numbers</a>.</p>
444
439
  */
445
440
  UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType;
446
441
  /**
@@ -488,9 +483,7 @@ export interface UpdateUserPoolRequest {
488
483
  * to categorize and manage user pools in different ways, such as by purpose, owner,
489
484
  * environment, or other criteria.</p>
490
485
  */
491
- UserPoolTags?: {
492
- [key: string]: string;
493
- };
486
+ UserPoolTags?: Record<string, string>;
494
487
  /**
495
488
  * <p>The configuration for <code>AdminCreateUser</code> requests.</p>
496
489
  */
@@ -759,6 +752,15 @@ export interface UpdateUserPoolClientRequest {
759
752
  * see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
760
753
  */
761
754
  EnableTokenRevocation?: boolean;
755
+ /**
756
+ * <p>Activates the propagation of additional user context data. For more information about
757
+ * 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
758
+ * parameter, you can't send device fingerprint information, including source IP address,
759
+ * to Amazon Cognito advanced security. You can only activate
760
+ * <code>EnablePropagateAdditionalUserContextData</code> in an app client that has a
761
+ * client secret.</p>
762
+ */
763
+ EnablePropagateAdditionalUserContextData?: boolean;
762
764
  }
763
765
  export declare namespace UpdateUserPoolClientRequest {
764
766
  /**
@@ -233,9 +233,7 @@ export interface AdminConfirmSignUpRequest {
233
233
 
234
234
  Username: string | undefined;
235
235
 
236
- ClientMetadata?: {
237
- [key: string]: string;
238
- };
236
+ ClientMetadata?: Record<string, string>;
239
237
  }
240
238
  export declare namespace AdminConfirmSignUpRequest {
241
239
 
@@ -321,9 +319,7 @@ export interface AdminCreateUserRequest {
321
319
 
322
320
  DesiredDeliveryMediums?: (DeliveryMediumType | string)[];
323
321
 
324
- ClientMetadata?: {
325
- [key: string]: string;
326
- };
322
+ ClientMetadata?: Record<string, string>;
327
323
  }
328
324
  export declare namespace AdminCreateUserRequest {
329
325
 
@@ -707,13 +703,9 @@ export interface AdminInitiateAuthRequest {
707
703
 
708
704
  AuthFlow: AuthFlowType | string | undefined;
709
705
 
710
- AuthParameters?: {
711
- [key: string]: string;
712
- };
706
+ AuthParameters?: Record<string, string>;
713
707
 
714
- ClientMetadata?: {
715
- [key: string]: string;
716
- };
708
+ ClientMetadata?: Record<string, string>;
717
709
 
718
710
  AnalyticsMetadata?: AnalyticsMetadataType;
719
711
 
@@ -772,9 +764,7 @@ export interface AdminInitiateAuthResponse {
772
764
 
773
765
  Session?: string;
774
766
 
775
- ChallengeParameters?: {
776
- [key: string]: string;
777
- };
767
+ ChallengeParameters?: Record<string, string>;
778
768
 
779
769
  AuthenticationResult?: AuthenticationResultType;
780
770
  }
@@ -1050,9 +1040,7 @@ export interface AdminResetUserPasswordRequest {
1050
1040
 
1051
1041
  Username: string | undefined;
1052
1042
 
1053
- ClientMetadata?: {
1054
- [key: string]: string;
1055
- };
1043
+ ClientMetadata?: Record<string, string>;
1056
1044
  }
1057
1045
  export declare namespace AdminResetUserPasswordRequest {
1058
1046
 
@@ -1081,9 +1069,7 @@ export interface AdminRespondToAuthChallengeRequest {
1081
1069
 
1082
1070
  ChallengeName: ChallengeNameType | string | undefined;
1083
1071
 
1084
- ChallengeResponses?: {
1085
- [key: string]: string;
1086
- };
1072
+ ChallengeResponses?: Record<string, string>;
1087
1073
 
1088
1074
  Session?: string;
1089
1075
 
@@ -1091,9 +1077,7 @@ export interface AdminRespondToAuthChallengeRequest {
1091
1077
 
1092
1078
  ContextData?: ContextDataType;
1093
1079
 
1094
- ClientMetadata?: {
1095
- [key: string]: string;
1096
- };
1080
+ ClientMetadata?: Record<string, string>;
1097
1081
  }
1098
1082
  export declare namespace AdminRespondToAuthChallengeRequest {
1099
1083
 
@@ -1106,9 +1090,7 @@ export interface AdminRespondToAuthChallengeResponse {
1106
1090
 
1107
1091
  Session?: string;
1108
1092
 
1109
- ChallengeParameters?: {
1110
- [key: string]: string;
1111
- };
1093
+ ChallengeParameters?: Record<string, string>;
1112
1094
 
1113
1095
  AuthenticationResult?: AuthenticationResultType;
1114
1096
  }
@@ -1274,9 +1256,7 @@ export interface AdminUpdateUserAttributesRequest {
1274
1256
 
1275
1257
  UserAttributes: AttributeType[] | undefined;
1276
1258
 
1277
- ClientMetadata?: {
1278
- [key: string]: string;
1279
- };
1259
+ ClientMetadata?: Record<string, string>;
1280
1260
  }
1281
1261
  export declare namespace AdminUpdateUserAttributesRequest {
1282
1262
 
@@ -1423,6 +1403,8 @@ export declare namespace ConfirmDeviceResponse {
1423
1403
 
1424
1404
  export interface UserContextDataType {
1425
1405
 
1406
+ IpAddress?: string;
1407
+
1426
1408
  EncodedData?: string;
1427
1409
  }
1428
1410
  export declare namespace UserContextDataType {
@@ -1446,9 +1428,7 @@ export interface ConfirmForgotPasswordRequest {
1446
1428
 
1447
1429
  UserContextData?: UserContextDataType;
1448
1430
 
1449
- ClientMetadata?: {
1450
- [key: string]: string;
1451
- };
1431
+ ClientMetadata?: Record<string, string>;
1452
1432
  }
1453
1433
  export declare namespace ConfirmForgotPasswordRequest {
1454
1434
 
@@ -1478,9 +1458,7 @@ export interface ConfirmSignUpRequest {
1478
1458
 
1479
1459
  UserContextData?: UserContextDataType;
1480
1460
 
1481
- ClientMetadata?: {
1482
- [key: string]: string;
1483
- };
1461
+ ClientMetadata?: Record<string, string>;
1484
1462
  }
1485
1463
  export declare namespace ConfirmSignUpRequest {
1486
1464
 
@@ -1540,13 +1518,9 @@ export interface CreateIdentityProviderRequest {
1540
1518
 
1541
1519
  ProviderType: IdentityProviderTypeType | string | undefined;
1542
1520
 
1543
- ProviderDetails: {
1544
- [key: string]: string;
1545
- } | undefined;
1521
+ ProviderDetails: Record<string, string> | undefined;
1546
1522
 
1547
- AttributeMapping?: {
1548
- [key: string]: string;
1549
- };
1523
+ AttributeMapping?: Record<string, string>;
1550
1524
 
1551
1525
  IdpIdentifiers?: string[];
1552
1526
  }
@@ -1563,13 +1537,9 @@ export interface IdentityProviderType {
1563
1537
 
1564
1538
  ProviderType?: IdentityProviderTypeType | string;
1565
1539
 
1566
- ProviderDetails?: {
1567
- [key: string]: string;
1568
- };
1540
+ ProviderDetails?: Record<string, string>;
1569
1541
 
1570
- AttributeMapping?: {
1571
- [key: string]: string;
1572
- };
1542
+ AttributeMapping?: Record<string, string>;
1573
1543
 
1574
1544
  IdpIdentifiers?: string[];
1575
1545
 
@@ -1937,9 +1907,7 @@ export interface CreateUserPoolRequest {
1937
1907
 
1938
1908
  SmsConfiguration?: SmsConfigurationType;
1939
1909
 
1940
- UserPoolTags?: {
1941
- [key: string]: string;
1942
- };
1910
+ UserPoolTags?: Record<string, string>;
1943
1911
 
1944
1912
  AdminCreateUserConfig?: AdminCreateUserConfigType;
1945
1913
 
@@ -2006,9 +1974,7 @@ export interface UserPoolType {
2006
1974
 
2007
1975
  SmsConfiguration?: SmsConfigurationType;
2008
1976
 
2009
- UserPoolTags?: {
2010
- [key: string]: string;
2011
- };
1977
+ UserPoolTags?: Record<string, string>;
2012
1978
 
2013
1979
  SmsConfigurationFailure?: string;
2014
1980
 
@@ -2128,6 +2094,8 @@ export interface CreateUserPoolClientRequest {
2128
2094
  PreventUserExistenceErrors?: PreventUserExistenceErrorTypes | string;
2129
2095
 
2130
2096
  EnableTokenRevocation?: boolean;
2097
+
2098
+ EnablePropagateAdditionalUserContextData?: boolean;
2131
2099
  }
2132
2100
  export declare namespace CreateUserPoolClientRequest {
2133
2101
 
@@ -2181,6 +2149,8 @@ export interface UserPoolClientType {
2181
2149
  PreventUserExistenceErrors?: PreventUserExistenceErrorTypes | string;
2182
2150
 
2183
2151
  EnableTokenRevocation?: boolean;
2152
+
2153
+ EnablePropagateAdditionalUserContextData?: boolean;
2184
2154
  }
2185
2155
  export declare namespace UserPoolClientType {
2186
2156
 
@@ -2579,9 +2549,7 @@ export interface ForgotPasswordRequest {
2579
2549
 
2580
2550
  AnalyticsMetadata?: AnalyticsMetadataType;
2581
2551
 
2582
- ClientMetadata?: {
2583
- [key: string]: string;
2584
- };
2552
+ ClientMetadata?: Record<string, string>;
2585
2553
  }
2586
2554
  export declare namespace ForgotPasswordRequest {
2587
2555
 
@@ -2775,9 +2743,7 @@ export interface GetUserAttributeVerificationCodeRequest {
2775
2743
 
2776
2744
  AttributeName: string | undefined;
2777
2745
 
2778
- ClientMetadata?: {
2779
- [key: string]: string;
2780
- };
2746
+ ClientMetadata?: Record<string, string>;
2781
2747
  }
2782
2748
  export declare namespace GetUserAttributeVerificationCodeRequest {
2783
2749
 
@@ -2853,13 +2819,9 @@ export interface InitiateAuthRequest {
2853
2819
 
2854
2820
  AuthFlow: AuthFlowType | string | undefined;
2855
2821
 
2856
- AuthParameters?: {
2857
- [key: string]: string;
2858
- };
2822
+ AuthParameters?: Record<string, string>;
2859
2823
 
2860
- ClientMetadata?: {
2861
- [key: string]: string;
2862
- };
2824
+ ClientMetadata?: Record<string, string>;
2863
2825
 
2864
2826
  ClientId: string | undefined;
2865
2827
 
@@ -2878,9 +2840,7 @@ export interface InitiateAuthResponse {
2878
2840
 
2879
2841
  Session?: string;
2880
2842
 
2881
- ChallengeParameters?: {
2882
- [key: string]: string;
2883
- };
2843
+ ChallengeParameters?: Record<string, string>;
2884
2844
 
2885
2845
  AuthenticationResult?: AuthenticationResultType;
2886
2846
  }
@@ -3003,9 +2963,7 @@ export declare namespace ListTagsForResourceRequest {
3003
2963
  }
3004
2964
  export interface ListTagsForResourceResponse {
3005
2965
 
3006
- Tags?: {
3007
- [key: string]: string;
3008
- };
2966
+ Tags?: Record<string, string>;
3009
2967
  }
3010
2968
  export declare namespace ListTagsForResourceResponse {
3011
2969
 
@@ -3178,9 +3136,7 @@ export interface ResendConfirmationCodeRequest {
3178
3136
 
3179
3137
  AnalyticsMetadata?: AnalyticsMetadataType;
3180
3138
 
3181
- ClientMetadata?: {
3182
- [key: string]: string;
3183
- };
3139
+ ClientMetadata?: Record<string, string>;
3184
3140
  }
3185
3141
  export declare namespace ResendConfirmationCodeRequest {
3186
3142
 
@@ -3204,17 +3160,13 @@ export interface RespondToAuthChallengeRequest {
3204
3160
 
3205
3161
  Session?: string;
3206
3162
 
3207
- ChallengeResponses?: {
3208
- [key: string]: string;
3209
- };
3163
+ ChallengeResponses?: Record<string, string>;
3210
3164
 
3211
3165
  AnalyticsMetadata?: AnalyticsMetadataType;
3212
3166
 
3213
3167
  UserContextData?: UserContextDataType;
3214
3168
 
3215
- ClientMetadata?: {
3216
- [key: string]: string;
3217
- };
3169
+ ClientMetadata?: Record<string, string>;
3218
3170
  }
3219
3171
  export declare namespace RespondToAuthChallengeRequest {
3220
3172
 
@@ -3227,9 +3179,7 @@ export interface RespondToAuthChallengeResponse {
3227
3179
 
3228
3180
  Session?: string;
3229
3181
 
3230
- ChallengeParameters?: {
3231
- [key: string]: string;
3232
- };
3182
+ ChallengeParameters?: Record<string, string>;
3233
3183
 
3234
3184
  AuthenticationResult?: AuthenticationResultType;
3235
3185
  }
@@ -3403,9 +3353,7 @@ export interface SignUpRequest {
3403
3353
 
3404
3354
  UserContextData?: UserContextDataType;
3405
3355
 
3406
- ClientMetadata?: {
3407
- [key: string]: string;
3408
- };
3356
+ ClientMetadata?: Record<string, string>;
3409
3357
  }
3410
3358
  export declare namespace SignUpRequest {
3411
3359
 
@@ -45,9 +45,7 @@ export interface TagResourceRequest {
45
45
 
46
46
  ResourceArn: string | undefined;
47
47
 
48
- Tags: {
49
- [key: string]: string;
50
- } | undefined;
48
+ Tags: Record<string, string> | undefined;
51
49
  }
52
50
  export declare namespace TagResourceRequest {
53
51
 
@@ -147,13 +145,9 @@ export interface UpdateIdentityProviderRequest {
147
145
 
148
146
  ProviderName: string | undefined;
149
147
 
150
- ProviderDetails?: {
151
- [key: string]: string;
152
- };
148
+ ProviderDetails?: Record<string, string>;
153
149
 
154
- AttributeMapping?: {
155
- [key: string]: string;
156
- };
150
+ AttributeMapping?: Record<string, string>;
157
151
 
158
152
  IdpIdentifiers?: string[];
159
153
  }
@@ -198,9 +192,7 @@ export interface UpdateUserAttributesRequest {
198
192
 
199
193
  AccessToken: string | undefined;
200
194
 
201
- ClientMetadata?: {
202
- [key: string]: string;
203
- };
195
+ ClientMetadata?: Record<string, string>;
204
196
  }
205
197
  export declare namespace UpdateUserAttributesRequest {
206
198
 
@@ -246,9 +238,7 @@ export interface UpdateUserPoolRequest {
246
238
 
247
239
  SmsConfiguration?: SmsConfigurationType;
248
240
 
249
- UserPoolTags?: {
250
- [key: string]: string;
251
- };
241
+ UserPoolTags?: Record<string, string>;
252
242
 
253
243
  AdminCreateUserConfig?: AdminCreateUserConfigType;
254
244
 
@@ -309,6 +299,8 @@ export interface UpdateUserPoolClientRequest {
309
299
  PreventUserExistenceErrors?: PreventUserExistenceErrorTypes | string;
310
300
 
311
301
  EnableTokenRevocation?: boolean;
302
+
303
+ EnablePropagateAdditionalUserContextData?: boolean;
312
304
  }
313
305
  export declare namespace UpdateUserPoolClientRequest {
314
306
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-cognito-identity-provider",
3
3
  "description": "AWS SDK for JavaScript Cognito Identity Provider Client for Node.js, Browser and React Native",
4
- "version": "3.99.0",
4
+ "version": "3.105.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -18,15 +18,16 @@
18
18
  "dependencies": {
19
19
  "@aws-crypto/sha256-browser": "2.0.0",
20
20
  "@aws-crypto/sha256-js": "2.0.0",
21
- "@aws-sdk/client-sts": "3.99.0",
21
+ "@aws-sdk/client-sts": "3.105.0",
22
22
  "@aws-sdk/config-resolver": "3.80.0",
23
- "@aws-sdk/credential-provider-node": "3.99.0",
23
+ "@aws-sdk/credential-provider-node": "3.105.0",
24
24
  "@aws-sdk/fetch-http-handler": "3.78.0",
25
25
  "@aws-sdk/hash-node": "3.78.0",
26
26
  "@aws-sdk/invalid-dependency": "3.78.0",
27
27
  "@aws-sdk/middleware-content-length": "3.78.0",
28
28
  "@aws-sdk/middleware-host-header": "3.78.0",
29
29
  "@aws-sdk/middleware-logger": "3.78.0",
30
+ "@aws-sdk/middleware-recursion-detection": "3.105.0",
30
31
  "@aws-sdk/middleware-retry": "3.80.0",
31
32
  "@aws-sdk/middleware-serde": "3.78.0",
32
33
  "@aws-sdk/middleware-signing": "3.78.0",