@aws-sdk/client-cognito-identity-provider 3.100.0 → 3.109.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 +30 -0
- package/dist-cjs/CognitoIdentityProviderClient.js +2 -0
- package/dist-cjs/protocols/Aws_json1_1.js +10 -0
- package/dist-es/CognitoIdentityProviderClient.js +2 -0
- package/dist-es/protocols/Aws_json1_1.js +12 -5
- package/dist-types/CognitoIdentityProvider.d.ts +15 -8
- package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +15 -8
- package/dist-types/models/models_0.d.ts +121 -127
- package/dist-types/models/models_1.d.ts +18 -16
- package/dist-types/ts3.4/models/models_0.d.ts +35 -87
- package/dist-types/ts3.4/models/models_1.d.ts +7 -15
- package/package.json +29 -28
|
@@ -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
|
|
1085
|
-
*
|
|
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>
|
|
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
|
|
1428
|
-
* context data collection library
|
|
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
|
|
1616
|
-
*
|
|
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
|
|
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
|
|
2478
|
-
*
|
|
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>
|
|
3168
|
-
*
|
|
3169
|
-
*
|
|
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>
|
|
3174
|
-
|
|
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
|
|
3218
|
-
*
|
|
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
|
|
3315
|
-
*
|
|
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
|
|
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
|
|
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
|
|
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
|
|
4914
|
-
*
|
|
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
|
|
4919
|
-
*
|
|
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
|
|
4924
|
-
*
|
|
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
|
|
6101
|
-
*
|
|
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>
|
|
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
|
|
6835
|
-
*
|
|
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
|
|
7550
|
-
*
|
|
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
|
|
7724
|
-
*
|
|
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
|
|
8129
|
-
*
|
|
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
|
|
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
|
/**
|