@aws-sdk/client-cognito-identity-provider 3.382.0 → 3.383.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/README.md +83 -6
- package/dist-cjs/CognitoIdentityProvider.js +4 -0
- package/dist-cjs/commands/GetLogDeliveryConfigurationCommand.js +48 -0
- package/dist-cjs/commands/SetLogDeliveryConfigurationCommand.js +48 -0
- package/dist-cjs/commands/SetRiskConfigurationCommand.js +2 -1
- package/dist-cjs/commands/SetUICustomizationCommand.js +3 -3
- package/dist-cjs/commands/SetUserMFAPreferenceCommand.js +2 -2
- package/dist-cjs/commands/SetUserSettingsCommand.js +2 -2
- package/dist-cjs/commands/VerifySoftwareTokenCommand.js +1 -1
- package/dist-cjs/commands/index.js +2 -0
- package/dist-cjs/models/models_0.js +9 -48
- package/dist-cjs/models/models_1.js +26 -9
- package/dist-cjs/protocols/Aws_json1_1.js +108 -4
- package/dist-es/CognitoIdentityProvider.js +4 -0
- package/dist-es/commands/GetLogDeliveryConfigurationCommand.js +44 -0
- package/dist-es/commands/SetLogDeliveryConfigurationCommand.js +44 -0
- package/dist-es/commands/SetRiskConfigurationCommand.js +2 -1
- package/dist-es/commands/SetUICustomizationCommand.js +1 -1
- package/dist-es/commands/SetUserMFAPreferenceCommand.js +1 -1
- package/dist-es/commands/SetUserSettingsCommand.js +1 -1
- package/dist-es/commands/VerifySoftwareTokenCommand.js +2 -2
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +6 -39
- package/dist-es/models/models_1.js +21 -8
- package/dist-es/protocols/Aws_json1_1.js +100 -0
- package/dist-types/CognitoIdentityProvider.d.ts +81 -6
- package/dist-types/CognitoIdentityProviderClient.d.ts +71 -8
- package/dist-types/commands/AddCustomAttributesCommand.d.ts +20 -0
- package/dist-types/commands/AdminAddUserToGroupCommand.d.ts +20 -1
- package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +20 -1
- package/dist-types/commands/AdminCreateUserCommand.d.ts +22 -4
- package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +20 -1
- package/dist-types/commands/AdminDeleteUserCommand.d.ts +20 -1
- package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +22 -4
- package/dist-types/commands/AdminDisableUserCommand.d.ts +23 -3
- package/dist-types/commands/AdminEnableUserCommand.d.ts +20 -1
- package/dist-types/commands/AdminForgetDeviceCommand.d.ts +20 -1
- package/dist-types/commands/AdminGetDeviceCommand.d.ts +20 -1
- package/dist-types/commands/AdminGetUserCommand.d.ts +20 -1
- package/dist-types/commands/AdminInitiateAuthCommand.d.ts +22 -3
- package/dist-types/commands/AdminLinkProviderForUserCommand.d.ts +22 -3
- package/dist-types/commands/AdminListDevicesCommand.d.ts +20 -1
- package/dist-types/commands/AdminListGroupsForUserCommand.d.ts +20 -1
- package/dist-types/commands/AdminListUserAuthEventsCommand.d.ts +20 -0
- package/dist-types/commands/AdminRemoveUserFromGroupCommand.d.ts +20 -1
- package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +30 -11
- package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +24 -5
- package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +20 -0
- package/dist-types/commands/AdminSetUserPasswordCommand.d.ts +31 -0
- package/dist-types/commands/AdminSetUserSettingsCommand.d.ts +20 -0
- package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts +20 -0
- package/dist-types/commands/AdminUpdateDeviceStatusCommand.d.ts +20 -1
- package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +31 -12
- package/dist-types/commands/AdminUserGlobalSignOutCommand.d.ts +28 -7
- package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +8 -1
- package/dist-types/commands/ChangePasswordCommand.d.ts +8 -1
- package/dist-types/commands/ConfirmDeviceCommand.d.ts +8 -1
- package/dist-types/commands/ConfirmForgotPasswordCommand.d.ts +8 -1
- package/dist-types/commands/ConfirmSignUpCommand.d.ts +10 -3
- package/dist-types/commands/CreateGroupCommand.d.ts +20 -1
- package/dist-types/commands/CreateIdentityProviderCommand.d.ts +20 -0
- package/dist-types/commands/CreateResourceServerCommand.d.ts +20 -0
- package/dist-types/commands/CreateUserImportJobCommand.d.ts +21 -1
- package/dist-types/commands/CreateUserPoolClientCommand.d.ts +23 -0
- package/dist-types/commands/CreateUserPoolCommand.d.ts +28 -5
- package/dist-types/commands/CreateUserPoolDomainCommand.d.ts +20 -0
- package/dist-types/commands/DeleteUserAttributesCommand.d.ts +8 -1
- package/dist-types/commands/DeleteUserCommand.d.ts +9 -2
- package/dist-types/commands/DescribeUserPoolClientCommand.d.ts +20 -0
- package/dist-types/commands/DescribeUserPoolCommand.d.ts +20 -0
- package/dist-types/commands/ForgetDeviceCommand.d.ts +8 -1
- package/dist-types/commands/ForgotPasswordCommand.d.ts +16 -7
- package/dist-types/commands/GetDeviceCommand.d.ts +8 -1
- package/dist-types/commands/GetLogDeliveryConfigurationCommand.d.ts +102 -0
- package/dist-types/commands/GetSigningCertificateCommand.d.ts +5 -3
- package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +10 -3
- package/dist-types/commands/GetUserCommand.d.ts +8 -1
- package/dist-types/commands/GlobalSignOutCommand.d.ts +16 -4
- package/dist-types/commands/InitiateAuthCommand.d.ts +10 -3
- package/dist-types/commands/ListDevicesCommand.d.ts +8 -1
- package/dist-types/commands/ListGroupsCommand.d.ts +20 -1
- package/dist-types/commands/ListIdentityProvidersCommand.d.ts +20 -0
- package/dist-types/commands/ListResourceServersCommand.d.ts +20 -0
- package/dist-types/commands/ListUserImportJobsCommand.d.ts +21 -1
- package/dist-types/commands/ListUserPoolClientsCommand.d.ts +20 -0
- package/dist-types/commands/ListUserPoolsCommand.d.ts +20 -0
- package/dist-types/commands/ListUsersCommand.d.ts +21 -1
- package/dist-types/commands/ListUsersInGroupCommand.d.ts +20 -1
- package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +10 -3
- package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +12 -5
- package/dist-types/commands/RevokeTokenCommand.d.ts +10 -3
- package/dist-types/commands/SetLogDeliveryConfigurationCommand.d.ts +111 -0
- package/dist-types/commands/SetRiskConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/SetUICustomizationCommand.d.ts +1 -1
- package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +9 -2
- package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +3 -3
- package/dist-types/commands/SetUserSettingsCommand.d.ts +9 -2
- package/dist-types/commands/SignUpCommand.d.ts +10 -3
- package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts +6 -0
- package/dist-types/commands/UpdateDeviceStatusCommand.d.ts +8 -1
- package/dist-types/commands/UpdateGroupCommand.d.ts +20 -1
- package/dist-types/commands/UpdateIdentityProviderCommand.d.ts +20 -0
- package/dist-types/commands/UpdateResourceServerCommand.d.ts +20 -0
- package/dist-types/commands/UpdateUserAttributesCommand.d.ts +12 -5
- package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +21 -2
- package/dist-types/commands/UpdateUserPoolCommand.d.ts +28 -7
- package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts +20 -0
- package/dist-types/commands/VerifySoftwareTokenCommand.d.ts +8 -1
- package/dist-types/commands/VerifyUserAttributeCommand.d.ts +13 -9
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/index.d.ts +67 -6
- package/dist-types/models/models_0.d.ts +371 -319
- package/dist-types/models/models_1.d.ts +242 -18
- package/dist-types/protocols/Aws_json1_1.d.ts +18 -0
- package/dist-types/ts3.4/CognitoIdentityProvider.d.ts +34 -0
- package/dist-types/ts3.4/CognitoIdentityProviderClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/GetLogDeliveryConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/SetLogDeliveryConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/SetRiskConfigurationCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/SetUICustomizationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SetUserMFAPreferenceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SetUserPoolMfaConfigCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SetUserSettingsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +34 -52
- package/dist-types/ts3.4/models/models_1.d.ts +56 -3
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +24 -0
- package/package.json +1 -1
|
@@ -239,17 +239,25 @@ export interface StringAttributeConstraintsType {
|
|
|
239
239
|
}
|
|
240
240
|
/**
|
|
241
241
|
* @public
|
|
242
|
-
* <p>
|
|
242
|
+
* <p>A list of the user attributes and their properties in your user pool. The attribute
|
|
243
|
+
* schema contains standard attributes, custom attributes with a <code>custom:</code>
|
|
244
|
+
* prefix, and developer attributes with a <code>dev:</code> prefix. For more information,
|
|
245
|
+
* see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html">User pool
|
|
246
|
+
* attributes</a>.</p>
|
|
247
|
+
* <p>Developer-only attributes are a legacy feature of user pools, are read-only to all app
|
|
248
|
+
* clients. You can create and update developer-only attributes only with IAM-authenticated
|
|
249
|
+
* API operations. Use app client read/write permissions instead.</p>
|
|
243
250
|
*/
|
|
244
251
|
export interface SchemaAttributeType {
|
|
245
252
|
/**
|
|
246
253
|
* @public
|
|
247
|
-
* <p>
|
|
254
|
+
* <p>The name of your user pool attribute, for example <code>username</code> or
|
|
255
|
+
* <code>custom:costcenter</code>.</p>
|
|
248
256
|
*/
|
|
249
257
|
Name?: string;
|
|
250
258
|
/**
|
|
251
259
|
* @public
|
|
252
|
-
* <p>The
|
|
260
|
+
* <p>The data format of the values for your attribute.</p>
|
|
253
261
|
*/
|
|
254
262
|
AttributeDataType?: AttributeDataType | string;
|
|
255
263
|
/**
|
|
@@ -268,10 +276,10 @@ export interface SchemaAttributeType {
|
|
|
268
276
|
/**
|
|
269
277
|
* @public
|
|
270
278
|
* <p>Specifies whether the value of the attribute can be changed.</p>
|
|
271
|
-
* <p>
|
|
272
|
-
* parameter
|
|
273
|
-
* your application through an IdP. If an attribute is immutable, Amazon Cognito throws
|
|
274
|
-
* when it attempts to update the attribute. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html">Specifying Identity Provider Attribute Mappings for Your User
|
|
279
|
+
* <p>Any user pool attribute whose value you map from an IdP attribute must be mutable,
|
|
280
|
+
* with a parameter value of <code>true</code>. Amazon Cognito updates mapped attributes when users
|
|
281
|
+
* sign in to your application through an IdP. If an attribute is immutable, Amazon Cognito throws
|
|
282
|
+
* an error when it attempts to update the attribute. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html">Specifying Identity Provider Attribute Mappings for Your User
|
|
275
283
|
* Pool</a>.</p>
|
|
276
284
|
*/
|
|
277
285
|
Mutable?: boolean;
|
|
@@ -425,7 +433,7 @@ export declare class UserNotFoundException extends __BaseException {
|
|
|
425
433
|
}
|
|
426
434
|
/**
|
|
427
435
|
* @public
|
|
428
|
-
* <p>
|
|
436
|
+
* <p>Confirm a user's registration as a user pool administrator.</p>
|
|
429
437
|
*/
|
|
430
438
|
export interface AdminConfirmSignUpRequest {
|
|
431
439
|
/**
|
|
@@ -662,9 +670,9 @@ export interface AdminCreateUserRequest {
|
|
|
662
670
|
* <p>This parameter isn't required. If you don't specify a value, Amazon Cognito generates one for
|
|
663
671
|
* you.</p>
|
|
664
672
|
* <p>The temporary password can only be used until the user account expiration limit that
|
|
665
|
-
* you
|
|
666
|
-
*
|
|
667
|
-
* <code>
|
|
673
|
+
* you set for your user pool. To reset the account after that time limit, you must call
|
|
674
|
+
* <code>AdminCreateUser</code> again and specify <code>RESEND</code> for the
|
|
675
|
+
* <code>MessageAction</code> parameter.</p>
|
|
668
676
|
*/
|
|
669
677
|
TemporaryPassword?: string;
|
|
670
678
|
/**
|
|
@@ -792,7 +800,7 @@ export interface UserType {
|
|
|
792
800
|
UserCreateDate?: Date;
|
|
793
801
|
/**
|
|
794
802
|
* @public
|
|
795
|
-
* <p>The
|
|
803
|
+
* <p>The date and time, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format, when the item was modified.</p>
|
|
796
804
|
*/
|
|
797
805
|
UserLastModifiedDate?: Date;
|
|
798
806
|
/**
|
|
@@ -814,9 +822,6 @@ export interface UserType {
|
|
|
814
822
|
* <p>EXTERNAL_PROVIDER - User signed in with a third-party IdP.</p>
|
|
815
823
|
* </li>
|
|
816
824
|
* <li>
|
|
817
|
-
* <p>ARCHIVED - User is no longer active.</p>
|
|
818
|
-
* </li>
|
|
819
|
-
* <li>
|
|
820
825
|
* <p>UNKNOWN - User status isn't known.</p>
|
|
821
826
|
* </li>
|
|
822
827
|
* <li>
|
|
@@ -890,7 +895,7 @@ export declare class InvalidSmsRoleAccessPolicyException extends __BaseException
|
|
|
890
895
|
* @public
|
|
891
896
|
* <p>This exception is thrown when the trust relationship is not valid for the role
|
|
892
897
|
* provided for SMS configuration. This can happen if you don't trust
|
|
893
|
-
*
|
|
898
|
+
* <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
|
|
894
899
|
* not match what is provided in the SMS configuration for the user pool.</p>
|
|
895
900
|
*/
|
|
896
901
|
export declare class InvalidSmsRoleTrustRelationshipException extends __BaseException {
|
|
@@ -1082,8 +1087,8 @@ export interface AdminDisableProviderForUserResponse {
|
|
|
1082
1087
|
/**
|
|
1083
1088
|
* @public
|
|
1084
1089
|
* <p>This exception is thrown when a user tries to confirm the account with an email
|
|
1085
|
-
* address or phone number that has already been supplied as an alias for a different
|
|
1086
|
-
*
|
|
1090
|
+
* address or phone number that has already been supplied as an alias for a different user
|
|
1091
|
+
* profile. This exception indicates that an account with this email address or phone
|
|
1087
1092
|
* already exists in a user pool that you've configured to use email address or phone
|
|
1088
1093
|
* number as a sign-in alias.</p>
|
|
1089
1094
|
*/
|
|
@@ -1217,7 +1222,7 @@ export interface DeviceType {
|
|
|
1217
1222
|
DeviceCreateDate?: Date;
|
|
1218
1223
|
/**
|
|
1219
1224
|
* @public
|
|
1220
|
-
* <p>The
|
|
1225
|
+
* <p>The date and time, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format, when the item was modified.</p>
|
|
1221
1226
|
*/
|
|
1222
1227
|
DeviceLastModifiedDate?: Date;
|
|
1223
1228
|
/**
|
|
@@ -1262,7 +1267,7 @@ export interface AdminGetUserRequest {
|
|
|
1262
1267
|
export interface AdminGetUserResponse {
|
|
1263
1268
|
/**
|
|
1264
1269
|
* @public
|
|
1265
|
-
* <p>The
|
|
1270
|
+
* <p>The username of the user that you requested.</p>
|
|
1266
1271
|
*/
|
|
1267
1272
|
Username: string | undefined;
|
|
1268
1273
|
/**
|
|
@@ -1277,7 +1282,7 @@ export interface AdminGetUserResponse {
|
|
|
1277
1282
|
UserCreateDate?: Date;
|
|
1278
1283
|
/**
|
|
1279
1284
|
* @public
|
|
1280
|
-
* <p>The date the
|
|
1285
|
+
* <p>The date and time, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format, when the item was modified.</p>
|
|
1281
1286
|
*/
|
|
1282
1287
|
UserLastModifiedDate?: Date;
|
|
1283
1288
|
/**
|
|
@@ -1296,9 +1301,6 @@ export interface AdminGetUserResponse {
|
|
|
1296
1301
|
* <p>CONFIRMED - User has been confirmed.</p>
|
|
1297
1302
|
* </li>
|
|
1298
1303
|
* <li>
|
|
1299
|
-
* <p>ARCHIVED - User is no longer active.</p>
|
|
1300
|
-
* </li>
|
|
1301
|
-
* <li>
|
|
1302
1304
|
* <p>UNKNOWN - User status isn't known.</p>
|
|
1303
1305
|
* </li>
|
|
1304
1306
|
* <li>
|
|
@@ -1497,16 +1499,16 @@ export interface AdminInitiateAuthRequest {
|
|
|
1497
1499
|
* client is configured with a client secret), <code>DEVICE_KEY</code>.</p>
|
|
1498
1500
|
* </li>
|
|
1499
1501
|
* <li>
|
|
1502
|
+
* <p>For <code>ADMIN_USER_PASSWORD_AUTH</code>: <code>USERNAME</code> (required),
|
|
1503
|
+
* <code>PASSWORD</code> (required), <code>SECRET_HASH</code> (required if the
|
|
1504
|
+
* app client is configured with a client secret), <code>DEVICE_KEY</code>.</p>
|
|
1505
|
+
* </li>
|
|
1506
|
+
* <li>
|
|
1500
1507
|
* <p>For <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code>
|
|
1501
1508
|
* (required), <code>SECRET_HASH</code> (required if the app client is configured
|
|
1502
1509
|
* with a client secret), <code>DEVICE_KEY</code>.</p>
|
|
1503
1510
|
* </li>
|
|
1504
1511
|
* <li>
|
|
1505
|
-
* <p>For <code>ADMIN_NO_SRP_AUTH</code>: <code>USERNAME</code> (required),
|
|
1506
|
-
* <code>SECRET_HASH</code> (if app client is configured with client secret),
|
|
1507
|
-
* <code>PASSWORD</code> (required), <code>DEVICE_KEY</code>.</p>
|
|
1508
|
-
* </li>
|
|
1509
|
-
* <li>
|
|
1510
1512
|
* <p>For <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required),
|
|
1511
1513
|
* <code>SECRET_HASH</code> (if app client is configured with client secret),
|
|
1512
1514
|
* <code>DEVICE_KEY</code>. To start the authentication flow with password
|
|
@@ -1514,6 +1516,8 @@ export interface AdminInitiateAuthRequest {
|
|
|
1514
1516
|
* SRP_A Value)</code>.</p>
|
|
1515
1517
|
* </li>
|
|
1516
1518
|
* </ul>
|
|
1519
|
+
* <p>For more information about <code>SECRET_HASH</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash">Computing secret hash values</a>. For information about
|
|
1520
|
+
* <code>DEVICE_KEY</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>
|
|
1517
1521
|
*/
|
|
1518
1522
|
AuthParameters?: Record<string, string>;
|
|
1519
1523
|
/**
|
|
@@ -1845,7 +1849,7 @@ export interface AdminLinkProviderForUserRequest {
|
|
|
1845
1849
|
/**
|
|
1846
1850
|
* @public
|
|
1847
1851
|
* <p>The existing user in the user pool that you want to assign to the external IdP user
|
|
1848
|
-
* account. This user can be a
|
|
1852
|
+
* account. This user can be a local (Username + Password) Amazon Cognito user pools user or a
|
|
1849
1853
|
* federated user (for example, a SAML or Facebook user). If the user doesn't exist, Amazon Cognito
|
|
1850
1854
|
* generates an exception. Amazon Cognito returns this user when the new user (with the linked IdP
|
|
1851
1855
|
* attribute) signs in.</p>
|
|
@@ -1878,13 +1882,19 @@ export interface AdminLinkProviderForUserRequest {
|
|
|
1878
1882
|
* <code>id</code>, <code>sub</code>, or <code>user_id</code> value found in the social
|
|
1879
1883
|
* IdP token.</p>
|
|
1880
1884
|
* <p></p>
|
|
1885
|
+
* <p>For OIDC, the <code>ProviderAttributeName</code> can be any value that matches a claim
|
|
1886
|
+
* in the ID token, or that your app retrieves from the <code>userInfo</code> endpoint. You
|
|
1887
|
+
* must map the claim to a user pool attribute in your IdP configuration, and set the user
|
|
1888
|
+
* pool attribute name as the value of <code>ProviderAttributeName</code> in your
|
|
1889
|
+
* <code>AdminLinkProviderForUser</code> request.</p>
|
|
1881
1890
|
* <p>For SAML, the <code>ProviderAttributeName</code> can be any value that matches a claim
|
|
1882
|
-
* in the SAML assertion.
|
|
1883
|
-
*
|
|
1884
|
-
*
|
|
1885
|
-
*
|
|
1886
|
-
*
|
|
1887
|
-
*
|
|
1891
|
+
* in the SAML assertion. To link SAML users based on the subject of the SAML assertion,
|
|
1892
|
+
* map the subject to a claim through the SAML IdP and set that claim name as the value of
|
|
1893
|
+
* <code>ProviderAttributeName</code> in your <code>AdminLinkProviderForUser</code>
|
|
1894
|
+
* request.</p>
|
|
1895
|
+
* <p>For both OIDC and SAML users, when you set <code>ProviderAttributeName</code> to
|
|
1896
|
+
* <code>Cognito_Subject</code>, Amazon Cognito will automatically parse the default unique
|
|
1897
|
+
* identifier found in the subject from the IdP token.</p>
|
|
1888
1898
|
*/
|
|
1889
1899
|
SourceUser: ProviderUserIdentifierType | undefined;
|
|
1890
1900
|
}
|
|
@@ -2006,12 +2016,12 @@ export interface GroupType {
|
|
|
2006
2016
|
Precedence?: number;
|
|
2007
2017
|
/**
|
|
2008
2018
|
* @public
|
|
2009
|
-
* <p>The date the
|
|
2019
|
+
* <p>The date and time, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format, when the item was modified.</p>
|
|
2010
2020
|
*/
|
|
2011
2021
|
LastModifiedDate?: Date;
|
|
2012
2022
|
/**
|
|
2013
2023
|
* @public
|
|
2014
|
-
* <p>The date the
|
|
2024
|
+
* <p>The date and time, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format, when the item was created.</p>
|
|
2015
2025
|
*/
|
|
2016
2026
|
CreationDate?: Date;
|
|
2017
2027
|
}
|
|
@@ -2148,7 +2158,11 @@ export type FeedbackValueType = (typeof FeedbackValueType)[keyof typeof Feedback
|
|
|
2148
2158
|
export interface EventFeedbackType {
|
|
2149
2159
|
/**
|
|
2150
2160
|
* @public
|
|
2151
|
-
* <p>The event feedback value
|
|
2161
|
+
* <p>The authentication event feedback value. When you provide a <code>FeedbackValue</code>
|
|
2162
|
+
* value of <code>valid</code>, you tell Amazon Cognito that you trust a user session where Amazon Cognito
|
|
2163
|
+
* has evaluated some level of risk. When you provide a <code>FeedbackValue</code> value of
|
|
2164
|
+
* <code>invalid</code>, you tell Amazon Cognito that you don't trust a user session, or you
|
|
2165
|
+
* don't believe that Amazon Cognito evaluated a high-enough risk level.</p>
|
|
2152
2166
|
*/
|
|
2153
2167
|
FeedbackValue: FeedbackValueType | string | undefined;
|
|
2154
2168
|
/**
|
|
@@ -2255,7 +2269,7 @@ export interface AuthEventType {
|
|
|
2255
2269
|
EventType?: EventType | string;
|
|
2256
2270
|
/**
|
|
2257
2271
|
* @public
|
|
2258
|
-
* <p>The
|
|
2272
|
+
* <p>The date and time, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format, when the item was created.</p>
|
|
2259
2273
|
*/
|
|
2260
2274
|
CreationDate?: Date;
|
|
2261
2275
|
/**
|
|
@@ -2483,6 +2497,8 @@ export interface AdminRespondToAuthChallengeRequest {
|
|
|
2483
2497
|
* <code>AdminInitiateAuth</code> response includes the actual username value in the
|
|
2484
2498
|
* <code>USERNAMEUSER_ID_FOR_SRP</code> attribute. This happens even if you specified
|
|
2485
2499
|
* an alias in your call to <code>AdminInitiateAuth</code>.</p>
|
|
2500
|
+
* <p>For more information about <code>SECRET_HASH</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash">Computing secret hash values</a>. For information about
|
|
2501
|
+
* <code>DEVICE_KEY</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>
|
|
2486
2502
|
*/
|
|
2487
2503
|
ChallengeResponses?: Record<string, string>;
|
|
2488
2504
|
/**
|
|
@@ -2795,7 +2811,11 @@ export interface AdminUpdateAuthEventFeedbackRequest {
|
|
|
2795
2811
|
EventId: string | undefined;
|
|
2796
2812
|
/**
|
|
2797
2813
|
* @public
|
|
2798
|
-
* <p>The authentication event feedback value
|
|
2814
|
+
* <p>The authentication event feedback value. When you provide a <code>FeedbackValue</code>
|
|
2815
|
+
* value of <code>valid</code>, you tell Amazon Cognito that you trust a user session where Amazon Cognito
|
|
2816
|
+
* has evaluated some level of risk. When you provide a <code>FeedbackValue</code> value of
|
|
2817
|
+
* <code>invalid</code>, you tell Amazon Cognito that you don't trust a user session, or you
|
|
2818
|
+
* don't believe that Amazon Cognito evaluated a high-enough risk level.</p>
|
|
2799
2819
|
*/
|
|
2800
2820
|
FeedbackValue: FeedbackValueType | string | undefined;
|
|
2801
2821
|
}
|
|
@@ -2978,9 +2998,9 @@ export type AliasAttributeType = (typeof AliasAttributeType)[keyof typeof AliasA
|
|
|
2978
2998
|
* <p>The Amazon Pinpoint analytics configuration necessary to collect metrics for a user
|
|
2979
2999
|
* pool.</p>
|
|
2980
3000
|
* <note>
|
|
2981
|
-
* <p>In Regions where Amazon
|
|
2982
|
-
* Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user
|
|
2983
|
-
* support sending events to Amazon Pinpoint projects within that same Region.</p>
|
|
3001
|
+
* <p>In Regions where Amazon Pinpoint isn't available, user pools only support sending
|
|
3002
|
+
* events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user
|
|
3003
|
+
* pools support sending events to Amazon Pinpoint projects within that same Region.</p>
|
|
2984
3004
|
* </note>
|
|
2985
3005
|
*/
|
|
2986
3006
|
export interface AnalyticsConfigurationType {
|
|
@@ -3037,8 +3057,8 @@ export interface AssociateSoftwareTokenRequest {
|
|
|
3037
3057
|
export interface AssociateSoftwareTokenResponse {
|
|
3038
3058
|
/**
|
|
3039
3059
|
* @public
|
|
3040
|
-
* <p>A unique generated shared secret code that is used in the
|
|
3041
|
-
*
|
|
3060
|
+
* <p>A unique generated shared secret code that is used in the TOTP algorithm to generate a
|
|
3061
|
+
* one-time code.</p>
|
|
3042
3062
|
*/
|
|
3043
3063
|
SecretCode?: string;
|
|
3044
3064
|
/**
|
|
@@ -3063,7 +3083,8 @@ export declare class ConcurrentModificationException extends __BaseException {
|
|
|
3063
3083
|
}
|
|
3064
3084
|
/**
|
|
3065
3085
|
* @public
|
|
3066
|
-
* <p>This exception is thrown when WAF doesn't allow your request based on a web
|
|
3086
|
+
* <p>This exception is thrown when WAF doesn't allow your request based on a web
|
|
3087
|
+
* ACL that's associated with your user pool.</p>
|
|
3067
3088
|
*/
|
|
3068
3089
|
export declare class ForbiddenException extends __BaseException {
|
|
3069
3090
|
readonly name: "ForbiddenException";
|
|
@@ -3171,8 +3192,7 @@ export interface ConfirmDeviceResponse {
|
|
|
3171
3192
|
/**
|
|
3172
3193
|
* @public
|
|
3173
3194
|
* <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
|
|
3175
|
-
* security.</p>
|
|
3195
|
+
* for evaluating the risk of an unexpected event by Amazon Cognito advanced security.</p>
|
|
3176
3196
|
*/
|
|
3177
3197
|
export interface UserContextDataType {
|
|
3178
3198
|
/**
|
|
@@ -3200,7 +3220,8 @@ export interface ConfirmForgotPasswordRequest {
|
|
|
3200
3220
|
/**
|
|
3201
3221
|
* @public
|
|
3202
3222
|
* <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a
|
|
3203
|
-
* user pool client and username plus the client ID in the message
|
|
3223
|
+
* user pool client and username plus the client ID in the message. For more information
|
|
3224
|
+
* about <code>SecretHash</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash">Computing secret hash values</a>.</p>
|
|
3204
3225
|
*/
|
|
3205
3226
|
SecretHash?: string;
|
|
3206
3227
|
/**
|
|
@@ -3211,8 +3232,8 @@ export interface ConfirmForgotPasswordRequest {
|
|
|
3211
3232
|
Username: string | undefined;
|
|
3212
3233
|
/**
|
|
3213
3234
|
* @public
|
|
3214
|
-
* <p>The confirmation code from your user's request to reset their password. For
|
|
3215
|
-
*
|
|
3235
|
+
* <p>The confirmation code from your user's request to reset their password. For more
|
|
3236
|
+
* information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ForgotPassword.html">ForgotPassword</a>.</p>
|
|
3216
3237
|
*/
|
|
3217
3238
|
ConfirmationCode: string | undefined;
|
|
3218
3239
|
/**
|
|
@@ -3752,12 +3773,12 @@ export interface IdentityProviderType {
|
|
|
3752
3773
|
IdpIdentifiers?: string[];
|
|
3753
3774
|
/**
|
|
3754
3775
|
* @public
|
|
3755
|
-
* <p>The date the
|
|
3776
|
+
* <p>The date and time, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format, when the item was modified.</p>
|
|
3756
3777
|
*/
|
|
3757
3778
|
LastModifiedDate?: Date;
|
|
3758
3779
|
/**
|
|
3759
3780
|
* @public
|
|
3760
|
-
* <p>The date the
|
|
3781
|
+
* <p>The date and time, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format, when the item was created.</p>
|
|
3761
3782
|
*/
|
|
3762
3783
|
CreationDate?: Date;
|
|
3763
3784
|
}
|
|
@@ -3930,7 +3951,7 @@ export interface UserImportJobType {
|
|
|
3930
3951
|
PreSignedUrl?: string;
|
|
3931
3952
|
/**
|
|
3932
3953
|
* @public
|
|
3933
|
-
* <p>The date
|
|
3954
|
+
* <p>The date and time, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format, when the item was created.</p>
|
|
3934
3955
|
*/
|
|
3935
3956
|
CreationDate?: Date;
|
|
3936
3957
|
/**
|
|
@@ -4067,20 +4088,19 @@ export interface DeviceConfigurationType {
|
|
|
4067
4088
|
* and time-based one-time password (TOTP) factors for multi-factor authentication
|
|
4068
4089
|
* (MFA).</p>
|
|
4069
4090
|
* <note>
|
|
4070
|
-
* <p>Whether or not <code>ChallengeRequiredOnNewDevice</code> is true, users who sign
|
|
4071
|
-
* with devices that have not been confirmed or remembered must still provide a
|
|
4072
|
-
* factor in a user pool that requires MFA.</p>
|
|
4091
|
+
* <p>Whether or not <code>ChallengeRequiredOnNewDevice</code> is true, users who sign
|
|
4092
|
+
* in with devices that have not been confirmed or remembered must still provide a
|
|
4093
|
+
* second factor in a user pool that requires MFA.</p>
|
|
4073
4094
|
* </note>
|
|
4074
4095
|
*/
|
|
4075
4096
|
ChallengeRequiredOnNewDevice?: boolean;
|
|
4076
4097
|
/**
|
|
4077
4098
|
* @public
|
|
4078
4099
|
* <p>When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a
|
|
4079
|
-
*
|
|
4080
|
-
*
|
|
4081
|
-
*
|
|
4082
|
-
*
|
|
4083
|
-
* UpdateDeviceStatus</a> API request.</p>
|
|
4100
|
+
* <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html">
|
|
4101
|
+
* ConfirmDevice</a> API request. In your app, create a prompt for your user to
|
|
4102
|
+
* choose whether they want to remember their device. Return the user's choice in an <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html">
|
|
4103
|
+
* UpdateDeviceStatus</a> API request.</p>
|
|
4084
4104
|
* <p>When <code>DeviceOnlyRememberedOnUserPrompt</code> is <code>false</code>, Amazon
|
|
4085
4105
|
* Cognito immediately remembers devices that you register in a <code>ConfirmDevice</code>
|
|
4086
4106
|
* API request.</p>
|
|
@@ -4113,9 +4133,12 @@ export type EmailSendingAccountType = (typeof EmailSendingAccountType)[keyof typ
|
|
|
4113
4133
|
export interface EmailConfigurationType {
|
|
4114
4134
|
/**
|
|
4115
4135
|
* @public
|
|
4116
|
-
* <p>The ARN of a verified email address
|
|
4117
|
-
*
|
|
4118
|
-
*
|
|
4136
|
+
* <p>The ARN of a verified email address or an address from a verified domain in Amazon SES. You
|
|
4137
|
+
* can set a <code>SourceArn</code> email from a verified domain only with an API request.
|
|
4138
|
+
* You can set a verified email address, but not an address in a verified domain, in the
|
|
4139
|
+
* Amazon Cognito console. Amazon Cognito uses the email address that you provide in one of the following
|
|
4140
|
+
* ways, depending on the value that you specify for the <code>EmailSendingAccount</code>
|
|
4141
|
+
* parameter:</p>
|
|
4119
4142
|
* <ul>
|
|
4120
4143
|
* <li>
|
|
4121
4144
|
* <p>If you specify <code>COGNITO_DEFAULT</code>, Amazon Cognito uses this address as the
|
|
@@ -4152,7 +4175,8 @@ export interface EmailConfigurationType {
|
|
|
4152
4175
|
* default email limit is less than the required delivery volume. To achieve a
|
|
4153
4176
|
* higher delivery volume, specify DEVELOPER to use your Amazon SES email
|
|
4154
4177
|
* configuration.</p>
|
|
4155
|
-
* <p>To look up the email delivery limit for the default option, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/limits.html">Limits</a> in the <i>Amazon Cognito Developer
|
|
4178
|
+
* <p>To look up the email delivery limit for the default option, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/limits.html">Limits</a> in the <i>Amazon Cognito Developer
|
|
4179
|
+
* Guide</i>.</p>
|
|
4156
4180
|
* <p>The default FROM address is <code>no-reply@verificationemail.com</code>.
|
|
4157
4181
|
* To customize the FROM address, provide the Amazon Resource Name (ARN) of an
|
|
4158
4182
|
* Amazon SES verified email address for the <code>SourceArn</code>
|
|
@@ -4170,9 +4194,9 @@ export interface EmailConfigurationType {
|
|
|
4170
4194
|
* call Amazon SES on your behalf. When you update your user pool with this option,
|
|
4171
4195
|
* Amazon Cognito creates a <i>service-linked role</i>, which is a type of
|
|
4172
4196
|
* role in your Amazon Web Services account. This role contains the permissions
|
|
4173
|
-
* that allow you to access Amazon SES and send email messages from your email
|
|
4174
|
-
* more information about the service-linked role that Amazon Cognito
|
|
4175
|
-
*
|
|
4197
|
+
* that allow you to access Amazon SES and send email messages from your email
|
|
4198
|
+
* address. For more information about the service-linked role that Amazon Cognito
|
|
4199
|
+
* creates, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/using-service-linked-roles.html">Using Service-Linked Roles for Amazon Cognito</a> in the
|
|
4176
4200
|
* <i>Amazon Cognito Developer Guide</i>.</p>
|
|
4177
4201
|
* </dd>
|
|
4178
4202
|
* </dl>
|
|
@@ -4471,7 +4495,7 @@ export interface UserAttributeUpdateSettingsType {
|
|
|
4471
4495
|
* this option activated, Amazon Cognito sends a verification message to the new phone number or
|
|
4472
4496
|
* email address. Amazon Cognito doesn’t change the value of the attribute until your user responds
|
|
4473
4497
|
* to the verification message and confirms the new value.</p>
|
|
4474
|
-
* <p>You can verify an updated email address or phone number with a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifyUserAttribute.html">VerifyUserAttribute</a> API request. You can also call the <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/
|
|
4498
|
+
* <p>You can verify an updated email address or phone number with a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifyUserAttribute.html">VerifyUserAttribute</a> API request. You can also call the <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html">AdminUpdateUserAttributes</a> API and set <code>email_verified</code> or
|
|
4475
4499
|
* <code>phone_number_verified</code> to true.</p>
|
|
4476
4500
|
* <p>When <code>AttributesRequireVerificationBeforeUpdate</code> is false, your user pool
|
|
4477
4501
|
* doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a
|
|
@@ -4501,7 +4525,10 @@ export interface UsernameConfigurationType {
|
|
|
4501
4525
|
/**
|
|
4502
4526
|
* @public
|
|
4503
4527
|
* <p>Specifies whether user name case sensitivity will be applied for all users in the user
|
|
4504
|
-
* pool through Amazon Cognito APIs
|
|
4528
|
+
* pool through Amazon Cognito APIs. For most use cases, set case sensitivity to <code>False</code>
|
|
4529
|
+
* (case insensitive) as a best practice. When usernames and email addresses are case
|
|
4530
|
+
* insensitive, users can sign in as the same user when they enter a different
|
|
4531
|
+
* capitalization of their user name.</p>
|
|
4505
4532
|
* <p>Valid values include:</p>
|
|
4506
4533
|
* <dl>
|
|
4507
4534
|
* <dt>True</dt>
|
|
@@ -4513,10 +4540,11 @@ export interface UsernameConfigurationType {
|
|
|
4513
4540
|
* <dt>False</dt>
|
|
4514
4541
|
* <dd>
|
|
4515
4542
|
* <p>Enables case insensitivity for all username input. For example, when this
|
|
4516
|
-
* option is set to <code>False</code>, users can sign in using
|
|
4517
|
-
*
|
|
4518
|
-
*
|
|
4519
|
-
*
|
|
4543
|
+
* option is set to <code>False</code>, users can sign in using
|
|
4544
|
+
* <code>username</code>, <code>USERNAME</code>, or <code>UserName</code>.
|
|
4545
|
+
* This option also enables both <code>preferred_username</code> and
|
|
4546
|
+
* <code>email</code> alias to be case insensitive, in addition to the
|
|
4547
|
+
* <code>username</code> attribute.</p>
|
|
4520
4548
|
* </dd>
|
|
4521
4549
|
* </dl>
|
|
4522
4550
|
*/
|
|
@@ -4524,12 +4552,16 @@ export interface UsernameConfigurationType {
|
|
|
4524
4552
|
}
|
|
4525
4553
|
/**
|
|
4526
4554
|
* @public
|
|
4527
|
-
* <p>
|
|
4555
|
+
* <p>User pool add-ons. Contains settings for activation of advanced security features. To
|
|
4556
|
+
* log user security information but take no action, set to <code>AUDIT</code>. To
|
|
4557
|
+
* configure automatic security responses to risky traffic to your user pool, set to
|
|
4558
|
+
* <code>ENFORCED</code>.</p>
|
|
4559
|
+
* <p>For more information, 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>.</p>
|
|
4528
4560
|
*/
|
|
4529
4561
|
export interface UserPoolAddOnsType {
|
|
4530
4562
|
/**
|
|
4531
4563
|
* @public
|
|
4532
|
-
* <p>The advanced security
|
|
4564
|
+
* <p>The operating mode of advanced security features in your user pool.</p>
|
|
4533
4565
|
*/
|
|
4534
4566
|
AdvancedSecurityMode: AdvancedSecurityModeType | string | undefined;
|
|
4535
4567
|
}
|
|
@@ -4689,9 +4721,11 @@ export interface CreateUserPoolRequest {
|
|
|
4689
4721
|
UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType;
|
|
4690
4722
|
/**
|
|
4691
4723
|
* @public
|
|
4692
|
-
* <p>The device-remembering configuration for a user pool. A null value indicates that you
|
|
4724
|
+
* <p>The device-remembering configuration for a user pool. A null value indicates that you
|
|
4725
|
+
* have deactivated device remembering in your user pool.</p>
|
|
4693
4726
|
* <note>
|
|
4694
|
-
* <p>When you provide a value for any <code>DeviceConfiguration</code> field, you
|
|
4727
|
+
* <p>When you provide a value for any <code>DeviceConfiguration</code> field, you
|
|
4728
|
+
* activate the Amazon Cognito device-remembering feature.</p>
|
|
4695
4729
|
* </note>
|
|
4696
4730
|
*/
|
|
4697
4731
|
DeviceConfiguration?: DeviceConfigurationType;
|
|
@@ -4730,16 +4764,25 @@ export interface CreateUserPoolRequest {
|
|
|
4730
4764
|
Schema?: SchemaAttributeType[];
|
|
4731
4765
|
/**
|
|
4732
4766
|
* @public
|
|
4733
|
-
* <p>
|
|
4734
|
-
*
|
|
4767
|
+
* <p>User pool add-ons. Contains settings for activation of advanced security features. To
|
|
4768
|
+
* log user security information but take no action, set to <code>AUDIT</code>. To
|
|
4769
|
+
* configure automatic security responses to risky traffic to your user pool, set to
|
|
4770
|
+
* <code>ENFORCED</code>.</p>
|
|
4771
|
+
* <p>For more information, 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>.</p>
|
|
4735
4772
|
*/
|
|
4736
4773
|
UserPoolAddOns?: UserPoolAddOnsType;
|
|
4737
4774
|
/**
|
|
4738
4775
|
* @public
|
|
4739
|
-
* <p>Case sensitivity on the username input for the selected sign-in option.
|
|
4740
|
-
*
|
|
4741
|
-
*
|
|
4742
|
-
*
|
|
4776
|
+
* <p>Case sensitivity on the username input for the selected sign-in option. When case
|
|
4777
|
+
* sensitivity is set to <code>False</code> (case insensitive), users can sign in with any
|
|
4778
|
+
* combination of capital and lowercase letters. For example, <code>username</code>,
|
|
4779
|
+
* <code>USERNAME</code>, or <code>UserName</code>, or for email,
|
|
4780
|
+
* <code>email@example.com</code> or <code>EMaiL@eXamplE.Com</code>. For most use
|
|
4781
|
+
* cases, set case sensitivity to <code>False</code> (case insensitive) as a best practice.
|
|
4782
|
+
* When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in
|
|
4783
|
+
* case as the same user, and prevents a case variation from being assigned to the same
|
|
4784
|
+
* attribute for a different user.</p>
|
|
4785
|
+
* <p>This configuration is immutable after you set it. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html">UsernameConfigurationType</a>.</p>
|
|
4743
4786
|
*/
|
|
4744
4787
|
UsernameConfiguration?: UsernameConfigurationType;
|
|
4745
4788
|
/**
|
|
@@ -4808,17 +4851,24 @@ export interface UserPoolType {
|
|
|
4808
4851
|
Status?: StatusType | string;
|
|
4809
4852
|
/**
|
|
4810
4853
|
* @public
|
|
4811
|
-
* <p>The date the
|
|
4854
|
+
* <p>The date and time, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format, when the item was modified.</p>
|
|
4812
4855
|
*/
|
|
4813
4856
|
LastModifiedDate?: Date;
|
|
4814
4857
|
/**
|
|
4815
4858
|
* @public
|
|
4816
|
-
* <p>The date the
|
|
4859
|
+
* <p>The date and time, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format, when the item was created.</p>
|
|
4817
4860
|
*/
|
|
4818
4861
|
CreationDate?: Date;
|
|
4819
4862
|
/**
|
|
4820
4863
|
* @public
|
|
4821
|
-
* <p>A
|
|
4864
|
+
* <p>A list of the user attributes and their properties in your user pool. The attribute
|
|
4865
|
+
* schema contains standard attributes, custom attributes with a <code>custom:</code>
|
|
4866
|
+
* prefix, and developer attributes with a <code>dev:</code> prefix. For more information,
|
|
4867
|
+
* see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html">User pool
|
|
4868
|
+
* attributes</a>.</p>
|
|
4869
|
+
* <p>Developer-only attributes are a legacy feature of user pools, are read-only to all app
|
|
4870
|
+
* clients. You can create and update developer-only attributes only with IAM-authenticated
|
|
4871
|
+
* API operations. Use app client read/write permissions instead.</p>
|
|
4822
4872
|
*/
|
|
4823
4873
|
SchemaAttributes?: SchemaAttributeType[];
|
|
4824
4874
|
/**
|
|
@@ -4894,9 +4944,11 @@ export interface UserPoolType {
|
|
|
4894
4944
|
MfaConfiguration?: UserPoolMfaType | string;
|
|
4895
4945
|
/**
|
|
4896
4946
|
* @public
|
|
4897
|
-
* <p>The device-remembering configuration for a user pool. A null value indicates that you
|
|
4947
|
+
* <p>The device-remembering configuration for a user pool. A null value indicates that you
|
|
4948
|
+
* have deactivated device remembering in your user pool.</p>
|
|
4898
4949
|
* <note>
|
|
4899
|
-
* <p>When you provide a value for any <code>DeviceConfiguration</code> field, you
|
|
4950
|
+
* <p>When you provide a value for any <code>DeviceConfiguration</code> field, you
|
|
4951
|
+
* activate the Amazon Cognito device-remembering feature.</p>
|
|
4900
4952
|
* </note>
|
|
4901
4953
|
*/
|
|
4902
4954
|
DeviceConfiguration?: DeviceConfigurationType;
|
|
@@ -4908,7 +4960,7 @@ export interface UserPoolType {
|
|
|
4908
4960
|
/**
|
|
4909
4961
|
* @public
|
|
4910
4962
|
* <p>The email configuration of your user pool. The email configuration type sets your
|
|
4911
|
-
* preferred sending method, Amazon Web Services Region, and sender for messages
|
|
4963
|
+
* preferred sending method, Amazon Web Services Region, and sender for messages from your user
|
|
4912
4964
|
* pool.</p>
|
|
4913
4965
|
*/
|
|
4914
4966
|
EmailConfiguration?: EmailConfigurationType;
|
|
@@ -4942,9 +4994,9 @@ export interface UserPoolType {
|
|
|
4942
4994
|
* <dd>
|
|
4943
4995
|
* <p>The Amazon Web Services account is in the SNS SMS Sandbox and messages will
|
|
4944
4996
|
* only reach verified end users. This parameter won’t get populated with
|
|
4945
|
-
* SNSSandbox if the
|
|
4946
|
-
*
|
|
4947
|
-
*
|
|
4997
|
+
* SNSSandbox if the user creating the user pool doesn’t have SNS permissions.
|
|
4998
|
+
* To learn how to move your Amazon Web Services account out of the sandbox, see
|
|
4999
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox-moving-to-production.html">Moving out
|
|
4948
5000
|
* of the SMS sandbox</a>.</p>
|
|
4949
5001
|
* </dd>
|
|
4950
5002
|
* </dl>
|
|
@@ -4977,7 +5029,11 @@ export interface UserPoolType {
|
|
|
4977
5029
|
AdminCreateUserConfig?: AdminCreateUserConfigType;
|
|
4978
5030
|
/**
|
|
4979
5031
|
* @public
|
|
4980
|
-
* <p>
|
|
5032
|
+
* <p>User pool add-ons. Contains settings for activation of advanced security features. To
|
|
5033
|
+
* log user security information but take no action, set to <code>AUDIT</code>. To
|
|
5034
|
+
* configure automatic security responses to risky traffic to your user pool, set to
|
|
5035
|
+
* <code>ENFORCED</code>.</p>
|
|
5036
|
+
* <p>For more information, 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>.</p>
|
|
4981
5037
|
*/
|
|
4982
5038
|
UserPoolAddOns?: UserPoolAddOnsType;
|
|
4983
5039
|
/**
|
|
@@ -5094,14 +5150,17 @@ export interface TokenValidityUnitsType {
|
|
|
5094
5150
|
* @public
|
|
5095
5151
|
* <p> A time unit of <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or
|
|
5096
5152
|
* <code>days</code> for the value that you set in the <code>AccessTokenValidity</code>
|
|
5097
|
-
* parameter. The default <code>AccessTokenValidity</code> time unit is hours
|
|
5153
|
+
* parameter. The default <code>AccessTokenValidity</code> time unit is hours.
|
|
5154
|
+
* <code>AccessTokenValidity</code> duration can range from five minutes to one
|
|
5155
|
+
* day.</p>
|
|
5098
5156
|
*/
|
|
5099
5157
|
AccessToken?: TimeUnitsType | string;
|
|
5100
5158
|
/**
|
|
5101
5159
|
* @public
|
|
5102
5160
|
* <p>A time unit of <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or
|
|
5103
5161
|
* <code>days</code> for the value that you set in the <code>IdTokenValidity</code>
|
|
5104
|
-
* parameter. The default <code>IdTokenValidity</code> time unit is hours
|
|
5162
|
+
* parameter. The default <code>IdTokenValidity</code> time unit is hours.
|
|
5163
|
+
* <code>IdTokenValidity</code> duration can range from five minutes to one day.</p>
|
|
5105
5164
|
*/
|
|
5106
5165
|
IdToken?: TimeUnitsType | string;
|
|
5107
5166
|
/**
|
|
@@ -5109,7 +5168,9 @@ export interface TokenValidityUnitsType {
|
|
|
5109
5168
|
* <p>A time unit of <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or
|
|
5110
5169
|
* <code>days</code> for the value that you set in the
|
|
5111
5170
|
* <code>RefreshTokenValidity</code> parameter. The default
|
|
5112
|
-
* <code>RefreshTokenValidity</code> time unit is days
|
|
5171
|
+
* <code>RefreshTokenValidity</code> time unit is days.
|
|
5172
|
+
* <code>RefreshTokenValidity</code> duration can range from 60 minutes to 10
|
|
5173
|
+
* years.</p>
|
|
5113
5174
|
*/
|
|
5114
5175
|
RefreshToken?: TimeUnitsType | string;
|
|
5115
5176
|
}
|
|
@@ -5175,7 +5236,7 @@ export interface CreateUserPoolClientRequest {
|
|
|
5175
5236
|
* <p>For example, when you set <code>IdTokenValidity</code> as <code>10</code> and
|
|
5176
5237
|
* <code>TokenValidityUnits</code> as <code>hours</code>, your user can authenticate their
|
|
5177
5238
|
* session with their ID token for 10 hours.</p>
|
|
5178
|
-
* <p>The default time unit for <code>
|
|
5239
|
+
* <p>The default time unit for <code>IdTokenValidity</code> in an API request is hours.
|
|
5179
5240
|
* <i>Valid range</i> is displayed below in seconds.</p>
|
|
5180
5241
|
* <p>If you don't specify otherwise in the configuration of your app client, your ID
|
|
5181
5242
|
* tokens are valid for one hour.</p>
|
|
@@ -5251,9 +5312,9 @@ export interface CreateUserPoolClientRequest {
|
|
|
5251
5312
|
* @public
|
|
5252
5313
|
* <p>A list of provider names for the identity providers (IdPs) that are supported on this
|
|
5253
5314
|
* client. The following are supported: <code>COGNITO</code>, <code>Facebook</code>,
|
|
5254
|
-
*
|
|
5255
|
-
* that you configured for the SAML and OIDC IdPs in your
|
|
5256
|
-
*
|
|
5315
|
+
* <code>Google</code>, <code>SignInWithApple</code>, and <code>LoginWithAmazon</code>.
|
|
5316
|
+
* You can also specify the names that you configured for the SAML and OIDC IdPs in your
|
|
5317
|
+
* user pool, for example <code>MySAMLIdP</code> or <code>MyOIDCIdP</code>.</p>
|
|
5257
5318
|
*/
|
|
5258
5319
|
SupportedIdentityProviders?: string[];
|
|
5259
5320
|
/**
|
|
@@ -5339,8 +5400,33 @@ export interface CreateUserPoolClientRequest {
|
|
|
5339
5400
|
AllowedOAuthScopes?: string[];
|
|
5340
5401
|
/**
|
|
5341
5402
|
* @public
|
|
5342
|
-
* <p>Set to true
|
|
5343
|
-
*
|
|
5403
|
+
* <p>Set to <code>true</code> to use OAuth 2.0 features in your user pool app client.</p>
|
|
5404
|
+
* <p>
|
|
5405
|
+
* <code>AllowedOAuthFlowsUserPoolClient</code> must be <code>true</code> before you can configure
|
|
5406
|
+
* the following features in your app client.</p>
|
|
5407
|
+
* <ul>
|
|
5408
|
+
* <li>
|
|
5409
|
+
* <p>
|
|
5410
|
+
* <code>CallBackURLs</code>: Callback URLs.</p>
|
|
5411
|
+
* </li>
|
|
5412
|
+
* <li>
|
|
5413
|
+
* <p>
|
|
5414
|
+
* <code>LogoutURLs</code>: Sign-out redirect URLs.</p>
|
|
5415
|
+
* </li>
|
|
5416
|
+
* <li>
|
|
5417
|
+
* <p>
|
|
5418
|
+
* <code>AllowedOAuthScopes</code>: OAuth 2.0 scopes.</p>
|
|
5419
|
+
* </li>
|
|
5420
|
+
* <li>
|
|
5421
|
+
* <p>
|
|
5422
|
+
* <code>AllowedOAuthFlows</code>: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.</p>
|
|
5423
|
+
* </li>
|
|
5424
|
+
* </ul>
|
|
5425
|
+
* <p>To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set
|
|
5426
|
+
* <code>AllowedOAuthFlowsUserPoolClient</code> to <code>true</code> in a <code>CreateUserPoolClient</code> or
|
|
5427
|
+
* <code>UpdateUserPoolClient</code> API request. If you don't set a value for
|
|
5428
|
+
* <code>AllowedOAuthFlowsUserPoolClient</code> in a request with the CLI or SDKs, it defaults
|
|
5429
|
+
* to <code>false</code>.</p>
|
|
5344
5430
|
*/
|
|
5345
5431
|
AllowedOAuthFlowsUserPoolClient?: boolean;
|
|
5346
5432
|
/**
|
|
@@ -5393,7 +5479,7 @@ export interface CreateUserPoolClientRequest {
|
|
|
5393
5479
|
* 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
|
|
5394
5480
|
* parameter, you can't send device fingerprint information, including source IP address,
|
|
5395
5481
|
* to Amazon Cognito advanced security. You can only activate
|
|
5396
|
-
*
|
|
5482
|
+
* <code>EnablePropagateAdditionalUserContextData</code> in an app client that has a
|
|
5397
5483
|
* client secret.</p>
|
|
5398
5484
|
*/
|
|
5399
5485
|
EnablePropagateAdditionalUserContextData?: boolean;
|
|
@@ -5431,12 +5517,12 @@ export interface UserPoolClientType {
|
|
|
5431
5517
|
ClientSecret?: string;
|
|
5432
5518
|
/**
|
|
5433
5519
|
* @public
|
|
5434
|
-
* <p>The date
|
|
5520
|
+
* <p>The date and time, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format, when the item was modified.</p>
|
|
5435
5521
|
*/
|
|
5436
5522
|
LastModifiedDate?: Date;
|
|
5437
5523
|
/**
|
|
5438
5524
|
* @public
|
|
5439
|
-
* <p>The date
|
|
5525
|
+
* <p>The date and time, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format, when the item was created.</p>
|
|
5440
5526
|
*/
|
|
5441
5527
|
CreationDate?: Date;
|
|
5442
5528
|
/**
|
|
@@ -5480,7 +5566,7 @@ export interface UserPoolClientType {
|
|
|
5480
5566
|
* <p>For example, when you set <code>IdTokenValidity</code> as <code>10</code> and
|
|
5481
5567
|
* <code>TokenValidityUnits</code> as <code>hours</code>, your user can authenticate their
|
|
5482
5568
|
* session with their ID token for 10 hours.</p>
|
|
5483
|
-
* <p>The default time unit for <code>
|
|
5569
|
+
* <p>The default time unit for <code>IdTokenValidity</code> in an API request is hours.
|
|
5484
5570
|
* <i>Valid range</i> is displayed below in seconds.</p>
|
|
5485
5571
|
* <p>If you don't specify otherwise in the configuration of your app client, your ID
|
|
5486
5572
|
* tokens are valid for one hour.</p>
|
|
@@ -5549,8 +5635,9 @@ export interface UserPoolClientType {
|
|
|
5549
5635
|
/**
|
|
5550
5636
|
* @public
|
|
5551
5637
|
* <p>A list of provider names for the IdPs that this client supports. The following are
|
|
5552
|
-
* supported: <code>COGNITO</code>, <code>Facebook</code>, <code>Google</code>,
|
|
5553
|
-
*
|
|
5638
|
+
* supported: <code>COGNITO</code>, <code>Facebook</code>, <code>Google</code>,
|
|
5639
|
+
* <code>SignInWithApple</code>, <code>LoginWithAmazon</code>, and the names of your
|
|
5640
|
+
* own SAML and OIDC providers.</p>
|
|
5554
5641
|
*/
|
|
5555
5642
|
SupportedIdentityProviders?: string[];
|
|
5556
5643
|
/**
|
|
@@ -5637,8 +5724,33 @@ export interface UserPoolClientType {
|
|
|
5637
5724
|
AllowedOAuthScopes?: string[];
|
|
5638
5725
|
/**
|
|
5639
5726
|
* @public
|
|
5640
|
-
* <p>Set to true
|
|
5641
|
-
*
|
|
5727
|
+
* <p>Set to <code>true</code> to use OAuth 2.0 features in your user pool app client.</p>
|
|
5728
|
+
* <p>
|
|
5729
|
+
* <code>AllowedOAuthFlowsUserPoolClient</code> must be <code>true</code> before you can configure
|
|
5730
|
+
* the following features in your app client.</p>
|
|
5731
|
+
* <ul>
|
|
5732
|
+
* <li>
|
|
5733
|
+
* <p>
|
|
5734
|
+
* <code>CallBackURLs</code>: Callback URLs.</p>
|
|
5735
|
+
* </li>
|
|
5736
|
+
* <li>
|
|
5737
|
+
* <p>
|
|
5738
|
+
* <code>LogoutURLs</code>: Sign-out redirect URLs.</p>
|
|
5739
|
+
* </li>
|
|
5740
|
+
* <li>
|
|
5741
|
+
* <p>
|
|
5742
|
+
* <code>AllowedOAuthScopes</code>: OAuth 2.0 scopes.</p>
|
|
5743
|
+
* </li>
|
|
5744
|
+
* <li>
|
|
5745
|
+
* <p>
|
|
5746
|
+
* <code>AllowedOAuthFlows</code>: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.</p>
|
|
5747
|
+
* </li>
|
|
5748
|
+
* </ul>
|
|
5749
|
+
* <p>To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set
|
|
5750
|
+
* <code>AllowedOAuthFlowsUserPoolClient</code> to <code>true</code> in a <code>CreateUserPoolClient</code> or
|
|
5751
|
+
* <code>UpdateUserPoolClient</code> API request. If you don't set a value for
|
|
5752
|
+
* <code>AllowedOAuthFlowsUserPoolClient</code> in a request with the CLI or SDKs, it defaults
|
|
5753
|
+
* to <code>false</code>.</p>
|
|
5642
5754
|
*/
|
|
5643
5755
|
AllowedOAuthFlowsUserPoolClient?: boolean;
|
|
5644
5756
|
/**
|
|
@@ -6109,7 +6221,7 @@ export interface RiskConfigurationType {
|
|
|
6109
6221
|
RiskExceptionConfiguration?: RiskExceptionConfigurationType;
|
|
6110
6222
|
/**
|
|
6111
6223
|
* @public
|
|
6112
|
-
* <p>The
|
|
6224
|
+
* <p>The date and time, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format, when the item was modified.</p>
|
|
6113
6225
|
*/
|
|
6114
6226
|
LastModifiedDate?: Date;
|
|
6115
6227
|
}
|
|
@@ -6257,7 +6369,8 @@ export interface DomainDescriptionType {
|
|
|
6257
6369
|
S3Bucket?: string;
|
|
6258
6370
|
/**
|
|
6259
6371
|
* @public
|
|
6260
|
-
* <p>The Amazon
|
|
6372
|
+
* <p>The Amazon CloudFront endpoint that you use as the target of the alias that you set up with
|
|
6373
|
+
* your Domain Name Service (DNS) provider.</p>
|
|
6261
6374
|
*/
|
|
6262
6375
|
CloudFrontDistribution?: string;
|
|
6263
6376
|
/**
|
|
@@ -6518,6 +6631,98 @@ export interface GetIdentityProviderByIdentifierResponse {
|
|
|
6518
6631
|
*/
|
|
6519
6632
|
IdentityProvider: IdentityProviderType | undefined;
|
|
6520
6633
|
}
|
|
6634
|
+
/**
|
|
6635
|
+
* @public
|
|
6636
|
+
*/
|
|
6637
|
+
export interface GetLogDeliveryConfigurationRequest {
|
|
6638
|
+
/**
|
|
6639
|
+
* @public
|
|
6640
|
+
* <p>The ID of the user pool where you want to view detailed activity logging configuration.</p>
|
|
6641
|
+
*/
|
|
6642
|
+
UserPoolId: string | undefined;
|
|
6643
|
+
}
|
|
6644
|
+
/**
|
|
6645
|
+
* @public
|
|
6646
|
+
* <p>The CloudWatch logging destination of a user pool detailed activity logging configuration.</p>
|
|
6647
|
+
*/
|
|
6648
|
+
export interface CloudWatchLogsConfigurationType {
|
|
6649
|
+
/**
|
|
6650
|
+
* @public
|
|
6651
|
+
* <p>The Amazon Resource Name (arn) of a CloudWatch Logs log group where your user pool sends logs.
|
|
6652
|
+
* The log group must not be encrypted with Key Management Service and must be in the same Amazon Web Services account
|
|
6653
|
+
* as your user pool.</p>
|
|
6654
|
+
*/
|
|
6655
|
+
LogGroupArn?: string;
|
|
6656
|
+
}
|
|
6657
|
+
/**
|
|
6658
|
+
* @public
|
|
6659
|
+
* @enum
|
|
6660
|
+
*/
|
|
6661
|
+
export declare const EventSourceName: {
|
|
6662
|
+
readonly USER_NOTIFICATION: "userNotification";
|
|
6663
|
+
};
|
|
6664
|
+
/**
|
|
6665
|
+
* @public
|
|
6666
|
+
*/
|
|
6667
|
+
export type EventSourceName = (typeof EventSourceName)[keyof typeof EventSourceName];
|
|
6668
|
+
/**
|
|
6669
|
+
* @public
|
|
6670
|
+
* @enum
|
|
6671
|
+
*/
|
|
6672
|
+
export declare const LogLevel: {
|
|
6673
|
+
readonly ERROR: "ERROR";
|
|
6674
|
+
};
|
|
6675
|
+
/**
|
|
6676
|
+
* @public
|
|
6677
|
+
*/
|
|
6678
|
+
export type LogLevel = (typeof LogLevel)[keyof typeof LogLevel];
|
|
6679
|
+
/**
|
|
6680
|
+
* @public
|
|
6681
|
+
* <p>The logging parameters of a user pool.</p>
|
|
6682
|
+
*/
|
|
6683
|
+
export interface LogConfigurationType {
|
|
6684
|
+
/**
|
|
6685
|
+
* @public
|
|
6686
|
+
* <p>The <code>errorlevel</code> selection of logs that a user pool sends for detailed activity logging.</p>
|
|
6687
|
+
*/
|
|
6688
|
+
LogLevel: LogLevel | string | undefined;
|
|
6689
|
+
/**
|
|
6690
|
+
* @public
|
|
6691
|
+
* <p>The source of events that your user pool sends for detailed activity logging.</p>
|
|
6692
|
+
*/
|
|
6693
|
+
EventSource: EventSourceName | string | undefined;
|
|
6694
|
+
/**
|
|
6695
|
+
* @public
|
|
6696
|
+
* <p>The CloudWatch logging destination of a user pool.</p>
|
|
6697
|
+
*/
|
|
6698
|
+
CloudWatchLogsConfiguration?: CloudWatchLogsConfigurationType;
|
|
6699
|
+
}
|
|
6700
|
+
/**
|
|
6701
|
+
* @public
|
|
6702
|
+
* <p>The logging parameters of a user pool.</p>
|
|
6703
|
+
*/
|
|
6704
|
+
export interface LogDeliveryConfigurationType {
|
|
6705
|
+
/**
|
|
6706
|
+
* @public
|
|
6707
|
+
* <p>The ID of the user pool where you configured detailed activity logging.</p>
|
|
6708
|
+
*/
|
|
6709
|
+
UserPoolId: string | undefined;
|
|
6710
|
+
/**
|
|
6711
|
+
* @public
|
|
6712
|
+
* <p>The detailed activity logging destination of a user pool.</p>
|
|
6713
|
+
*/
|
|
6714
|
+
LogConfigurations: LogConfigurationType[] | undefined;
|
|
6715
|
+
}
|
|
6716
|
+
/**
|
|
6717
|
+
* @public
|
|
6718
|
+
*/
|
|
6719
|
+
export interface GetLogDeliveryConfigurationResponse {
|
|
6720
|
+
/**
|
|
6721
|
+
* @public
|
|
6722
|
+
* <p>The detailed activity logging configuration of the requested user pool.</p>
|
|
6723
|
+
*/
|
|
6724
|
+
LogDeliveryConfiguration?: LogDeliveryConfigurationType;
|
|
6725
|
+
}
|
|
6521
6726
|
/**
|
|
6522
6727
|
* @public
|
|
6523
6728
|
* <p>Request to get a signing certificate from Amazon Cognito.</p>
|
|
@@ -6588,12 +6793,12 @@ export interface UICustomizationType {
|
|
|
6588
6793
|
CSSVersion?: string;
|
|
6589
6794
|
/**
|
|
6590
6795
|
* @public
|
|
6591
|
-
* <p>The
|
|
6796
|
+
* <p>The date and time, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format, when the item was modified.</p>
|
|
6592
6797
|
*/
|
|
6593
6798
|
LastModifiedDate?: Date;
|
|
6594
6799
|
/**
|
|
6595
6800
|
* @public
|
|
6596
|
-
* <p>The
|
|
6801
|
+
* <p>The date and time, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format, when the item was created.</p>
|
|
6597
6802
|
*/
|
|
6598
6803
|
CreationDate?: Date;
|
|
6599
6804
|
}
|
|
@@ -6626,7 +6831,7 @@ export interface GetUserRequest {
|
|
|
6626
6831
|
export interface GetUserResponse {
|
|
6627
6832
|
/**
|
|
6628
6833
|
* @public
|
|
6629
|
-
* <p>The
|
|
6834
|
+
* <p>The username of the user that you requested.</p>
|
|
6630
6835
|
*/
|
|
6631
6836
|
Username: string | undefined;
|
|
6632
6837
|
/**
|
|
@@ -6886,6 +7091,11 @@ export interface InitiateAuthRequest {
|
|
|
6886
7091
|
* client is configured with a client secret), <code>DEVICE_KEY</code>.</p>
|
|
6887
7092
|
* </li>
|
|
6888
7093
|
* <li>
|
|
7094
|
+
* <p>For <code>USER_PASSWORD_AUTH</code>: <code>USERNAME</code> (required),
|
|
7095
|
+
* <code>PASSWORD</code> (required), <code>SECRET_HASH</code> (required if the
|
|
7096
|
+
* app client is configured with a client secret), <code>DEVICE_KEY</code>.</p>
|
|
7097
|
+
* </li>
|
|
7098
|
+
* <li>
|
|
6889
7099
|
* <p>For <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code>
|
|
6890
7100
|
* (required), <code>SECRET_HASH</code> (required if the app client is configured
|
|
6891
7101
|
* with a client secret), <code>DEVICE_KEY</code>.</p>
|
|
@@ -6898,6 +7108,8 @@ export interface InitiateAuthRequest {
|
|
|
6898
7108
|
* SRP_A Value)</code>.</p>
|
|
6899
7109
|
* </li>
|
|
6900
7110
|
* </ul>
|
|
7111
|
+
* <p>For more information about <code>SECRET_HASH</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash">Computing secret hash values</a>. For information about
|
|
7112
|
+
* <code>DEVICE_KEY</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>
|
|
6901
7113
|
*/
|
|
6902
7114
|
AuthParameters?: Record<string, string>;
|
|
6903
7115
|
/**
|
|
@@ -7209,7 +7421,7 @@ export interface ProviderDescription {
|
|
|
7209
7421
|
LastModifiedDate?: Date;
|
|
7210
7422
|
/**
|
|
7211
7423
|
* @public
|
|
7212
|
-
* <p>The date
|
|
7424
|
+
* <p>The date and time, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format, when the item was created.</p>
|
|
7213
7425
|
*/
|
|
7214
7426
|
CreationDate?: Date;
|
|
7215
7427
|
}
|
|
@@ -7431,12 +7643,12 @@ export interface UserPoolDescriptionType {
|
|
|
7431
7643
|
Status?: StatusType | string;
|
|
7432
7644
|
/**
|
|
7433
7645
|
* @public
|
|
7434
|
-
* <p>The date
|
|
7646
|
+
* <p>The date and time, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format, when the item was modified.</p>
|
|
7435
7647
|
*/
|
|
7436
7648
|
LastModifiedDate?: Date;
|
|
7437
7649
|
/**
|
|
7438
7650
|
* @public
|
|
7439
|
-
* <p>The date
|
|
7651
|
+
* <p>The date and time, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format, when the item was created.</p>
|
|
7440
7652
|
*/
|
|
7441
7653
|
CreationDate?: Date;
|
|
7442
7654
|
}
|
|
@@ -7469,9 +7681,10 @@ export interface ListUsersRequest {
|
|
|
7469
7681
|
UserPoolId: string | undefined;
|
|
7470
7682
|
/**
|
|
7471
7683
|
* @public
|
|
7472
|
-
* <p>
|
|
7473
|
-
*
|
|
7474
|
-
*
|
|
7684
|
+
* <p>A JSON array of user attribute names, for example <code>given_name</code>, that you
|
|
7685
|
+
* want Amazon Cognito to include in the response for each user. When you don't provide an
|
|
7686
|
+
* <code>AttributesToGet</code> parameter, Amazon Cognito returns all attributes for each
|
|
7687
|
+
* user.</p>
|
|
7475
7688
|
*/
|
|
7476
7689
|
AttributesToGet?: string[];
|
|
7477
7690
|
/**
|
|
@@ -7587,7 +7800,15 @@ export interface ListUsersRequest {
|
|
|
7587
7800
|
export interface ListUsersResponse {
|
|
7588
7801
|
/**
|
|
7589
7802
|
* @public
|
|
7590
|
-
* <p>
|
|
7803
|
+
* <p>A list of the user pool users, and their attributes, that match your query.</p>
|
|
7804
|
+
* <note>
|
|
7805
|
+
* <p>Amazon Cognito creates a profile in your user pool for each native user in your user pool,
|
|
7806
|
+
* and each unique user ID from your third-party identity providers (IdPs). When you
|
|
7807
|
+
* link users with the <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html">AdminLinkProviderForUser</a> API operation, the output of
|
|
7808
|
+
* <code>ListUsers</code> displays both the IdP user and the native user that you
|
|
7809
|
+
* linked. You can identify IdP users in the <code>Users</code> object of this API
|
|
7810
|
+
* response by the IdP prefix that Amazon Cognito appends to <code>Username</code>.</p>
|
|
7811
|
+
* </note>
|
|
7591
7812
|
*/
|
|
7592
7813
|
Users?: UserType[];
|
|
7593
7814
|
/**
|
|
@@ -7777,9 +7998,9 @@ export interface RespondToAuthChallengeRequest {
|
|
|
7777
7998
|
* <li>
|
|
7778
7999
|
* <p>
|
|
7779
8000
|
* <code>NEW_PASSWORD_REQUIRED</code>: <code>NEW_PASSWORD</code>,
|
|
7780
|
-
*
|
|
8001
|
+
* <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured
|
|
7781
8002
|
* with client secret). To set any required attributes that Amazon Cognito returned as
|
|
7782
|
-
*
|
|
8003
|
+
* <code>requiredAttributes</code> in the <code>InitiateAuth</code> response,
|
|
7783
8004
|
* add a <code>userAttributes.<i>attributename</i>
|
|
7784
8005
|
* </code> parameter.
|
|
7785
8006
|
* This parameter can also set values for writable attributes that aren't required
|
|
@@ -7814,6 +8035,8 @@ export interface RespondToAuthChallengeRequest {
|
|
|
7814
8035
|
* <code>Session</code> parameter.</p>
|
|
7815
8036
|
* </li>
|
|
7816
8037
|
* </ul>
|
|
8038
|
+
* <p>For more information about <code>SECRET_HASH</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash">Computing secret hash values</a>. For information about
|
|
8039
|
+
* <code>DEVICE_KEY</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>
|
|
7817
8040
|
*/
|
|
7818
8041
|
ChallengeResponses?: Record<string, string>;
|
|
7819
8042
|
/**
|
|
@@ -7966,209 +8189,62 @@ export declare class UnsupportedTokenTypeException extends __BaseException {
|
|
|
7966
8189
|
/**
|
|
7967
8190
|
* @public
|
|
7968
8191
|
*/
|
|
7969
|
-
export interface
|
|
8192
|
+
export interface SetLogDeliveryConfigurationRequest {
|
|
7970
8193
|
/**
|
|
7971
8194
|
* @public
|
|
7972
|
-
* <p>The user pool
|
|
8195
|
+
* <p>The ID of the user pool where you want to configure detailed activity logging .</p>
|
|
7973
8196
|
*/
|
|
7974
8197
|
UserPoolId: string | undefined;
|
|
7975
8198
|
/**
|
|
7976
8199
|
* @public
|
|
7977
|
-
* <p>
|
|
7978
|
-
* mapped to <code>userPoolId</code>. When the client ID is null, the same risk
|
|
7979
|
-
* configuration is applied to all the clients in the userPool.</p>
|
|
7980
|
-
* <p>Otherwise, <code>ClientId</code> is mapped to the client. When the client ID isn't
|
|
7981
|
-
* null, the user pool configuration is overridden and the risk configuration for the
|
|
7982
|
-
* client is used instead.</p>
|
|
7983
|
-
*/
|
|
7984
|
-
ClientId?: string;
|
|
7985
|
-
/**
|
|
7986
|
-
* @public
|
|
7987
|
-
* <p>The compromised credentials risk configuration.</p>
|
|
7988
|
-
*/
|
|
7989
|
-
CompromisedCredentialsRiskConfiguration?: CompromisedCredentialsRiskConfigurationType;
|
|
7990
|
-
/**
|
|
7991
|
-
* @public
|
|
7992
|
-
* <p>The account takeover risk configuration.</p>
|
|
7993
|
-
*/
|
|
7994
|
-
AccountTakeoverRiskConfiguration?: AccountTakeoverRiskConfigurationType;
|
|
7995
|
-
/**
|
|
7996
|
-
* @public
|
|
7997
|
-
* <p>The configuration to override the risk decision.</p>
|
|
8200
|
+
* <p>A collection of all of the detailed activity logging configurations for a user pool.</p>
|
|
7998
8201
|
*/
|
|
7999
|
-
|
|
8202
|
+
LogConfigurations: LogConfigurationType[] | undefined;
|
|
8000
8203
|
}
|
|
8001
8204
|
/**
|
|
8002
8205
|
* @public
|
|
8003
8206
|
*/
|
|
8004
|
-
export interface
|
|
8207
|
+
export interface SetLogDeliveryConfigurationResponse {
|
|
8005
8208
|
/**
|
|
8006
8209
|
* @public
|
|
8007
|
-
* <p>The
|
|
8210
|
+
* <p>The detailed activity logging configuration that you applied to the requested user pool.</p>
|
|
8008
8211
|
*/
|
|
8009
|
-
|
|
8212
|
+
LogDeliveryConfiguration?: LogDeliveryConfigurationType;
|
|
8010
8213
|
}
|
|
8011
8214
|
/**
|
|
8012
8215
|
* @public
|
|
8013
8216
|
*/
|
|
8014
|
-
export interface
|
|
8217
|
+
export interface SetRiskConfigurationRequest {
|
|
8015
8218
|
/**
|
|
8016
8219
|
* @public
|
|
8017
|
-
* <p>The user pool ID
|
|
8220
|
+
* <p>The user pool ID. </p>
|
|
8018
8221
|
*/
|
|
8019
8222
|
UserPoolId: string | undefined;
|
|
8020
8223
|
/**
|
|
8021
8224
|
* @public
|
|
8022
|
-
* <p>The client ID
|
|
8225
|
+
* <p>The app client ID. If <code>ClientId</code> is null, then the risk configuration is
|
|
8226
|
+
* mapped to <code>userPoolId</code>. When the client ID is null, the same risk
|
|
8227
|
+
* configuration is applied to all the clients in the userPool.</p>
|
|
8228
|
+
* <p>Otherwise, <code>ClientId</code> is mapped to the client. When the client ID isn't
|
|
8229
|
+
* null, the user pool configuration is overridden and the risk configuration for the
|
|
8230
|
+
* client is used instead.</p>
|
|
8023
8231
|
*/
|
|
8024
8232
|
ClientId?: string;
|
|
8025
8233
|
/**
|
|
8026
8234
|
* @public
|
|
8027
|
-
* <p>The
|
|
8028
|
-
*/
|
|
8029
|
-
CSS?: string;
|
|
8030
|
-
/**
|
|
8031
|
-
* @public
|
|
8032
|
-
* <p>The uploaded logo image for the UI customization.</p>
|
|
8033
|
-
*/
|
|
8034
|
-
ImageFile?: Uint8Array;
|
|
8035
|
-
}
|
|
8036
|
-
/**
|
|
8037
|
-
* @public
|
|
8038
|
-
*/
|
|
8039
|
-
export interface SetUICustomizationResponse {
|
|
8040
|
-
/**
|
|
8041
|
-
* @public
|
|
8042
|
-
* <p>The UI customization information.</p>
|
|
8043
|
-
*/
|
|
8044
|
-
UICustomization: UICustomizationType | undefined;
|
|
8045
|
-
}
|
|
8046
|
-
/**
|
|
8047
|
-
* @public
|
|
8048
|
-
*/
|
|
8049
|
-
export interface SetUserMFAPreferenceRequest {
|
|
8050
|
-
/**
|
|
8051
|
-
* @public
|
|
8052
|
-
* <p>The SMS text message multi-factor authentication (MFA) settings.</p>
|
|
8053
|
-
*/
|
|
8054
|
-
SMSMfaSettings?: SMSMfaSettingsType;
|
|
8055
|
-
/**
|
|
8056
|
-
* @public
|
|
8057
|
-
* <p>The time-based one-time password (TOTP) software token MFA settings.</p>
|
|
8058
|
-
*/
|
|
8059
|
-
SoftwareTokenMfaSettings?: SoftwareTokenMfaSettingsType;
|
|
8060
|
-
/**
|
|
8061
|
-
* @public
|
|
8062
|
-
* <p>A valid access token that Amazon Cognito issued to the user whose MFA preference you want to
|
|
8063
|
-
* set.</p>
|
|
8064
|
-
*/
|
|
8065
|
-
AccessToken: string | undefined;
|
|
8066
|
-
}
|
|
8067
|
-
/**
|
|
8068
|
-
* @public
|
|
8069
|
-
*/
|
|
8070
|
-
export interface SetUserMFAPreferenceResponse {
|
|
8071
|
-
}
|
|
8072
|
-
/**
|
|
8073
|
-
* @public
|
|
8074
|
-
*/
|
|
8075
|
-
export interface SetUserPoolMfaConfigRequest {
|
|
8076
|
-
/**
|
|
8077
|
-
* @public
|
|
8078
|
-
* <p>The user pool ID.</p>
|
|
8079
|
-
*/
|
|
8080
|
-
UserPoolId: string | undefined;
|
|
8081
|
-
/**
|
|
8082
|
-
* @public
|
|
8083
|
-
* <p>The SMS text message MFA configuration.</p>
|
|
8084
|
-
*/
|
|
8085
|
-
SmsMfaConfiguration?: SmsMfaConfigType;
|
|
8086
|
-
/**
|
|
8087
|
-
* @public
|
|
8088
|
-
* <p>The software token MFA configuration.</p>
|
|
8089
|
-
*/
|
|
8090
|
-
SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType;
|
|
8091
|
-
/**
|
|
8092
|
-
* @public
|
|
8093
|
-
* <p>The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who
|
|
8094
|
-
* have set up an MFA factor can sign in. To learn more, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html">Adding Multi-Factor
|
|
8095
|
-
* Authentication (MFA) to a user pool</a>. Valid values include:</p>
|
|
8096
|
-
* <ul>
|
|
8097
|
-
* <li>
|
|
8098
|
-
* <p>
|
|
8099
|
-
* <code>OFF</code> MFA won't be used for any users.</p>
|
|
8100
|
-
* </li>
|
|
8101
|
-
* <li>
|
|
8102
|
-
* <p>
|
|
8103
|
-
* <code>ON</code> MFA is required for all users to sign in.</p>
|
|
8104
|
-
* </li>
|
|
8105
|
-
* <li>
|
|
8106
|
-
* <p>
|
|
8107
|
-
* <code>OPTIONAL</code> MFA will be required only for individual users who have
|
|
8108
|
-
* an MFA factor activated.</p>
|
|
8109
|
-
* </li>
|
|
8110
|
-
* </ul>
|
|
8111
|
-
*/
|
|
8112
|
-
MfaConfiguration?: UserPoolMfaType | string;
|
|
8113
|
-
}
|
|
8114
|
-
/**
|
|
8115
|
-
* @public
|
|
8116
|
-
*/
|
|
8117
|
-
export interface SetUserPoolMfaConfigResponse {
|
|
8118
|
-
/**
|
|
8119
|
-
* @public
|
|
8120
|
-
* <p>The SMS text message MFA configuration.</p>
|
|
8121
|
-
*/
|
|
8122
|
-
SmsMfaConfiguration?: SmsMfaConfigType;
|
|
8123
|
-
/**
|
|
8124
|
-
* @public
|
|
8125
|
-
* <p>The software token MFA configuration.</p>
|
|
8126
|
-
*/
|
|
8127
|
-
SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType;
|
|
8128
|
-
/**
|
|
8129
|
-
* @public
|
|
8130
|
-
* <p>The MFA configuration. Valid values include:</p>
|
|
8131
|
-
* <ul>
|
|
8132
|
-
* <li>
|
|
8133
|
-
* <p>
|
|
8134
|
-
* <code>OFF</code> MFA won't be used for any users.</p>
|
|
8135
|
-
* </li>
|
|
8136
|
-
* <li>
|
|
8137
|
-
* <p>
|
|
8138
|
-
* <code>ON</code> MFA is required for all users to sign in.</p>
|
|
8139
|
-
* </li>
|
|
8140
|
-
* <li>
|
|
8141
|
-
* <p>
|
|
8142
|
-
* <code>OPTIONAL</code> MFA will be required only for individual users who have
|
|
8143
|
-
* an MFA factor enabled.</p>
|
|
8144
|
-
* </li>
|
|
8145
|
-
* </ul>
|
|
8235
|
+
* <p>The compromised credentials risk configuration.</p>
|
|
8146
8236
|
*/
|
|
8147
|
-
|
|
8148
|
-
}
|
|
8149
|
-
/**
|
|
8150
|
-
* @public
|
|
8151
|
-
* <p>Represents the request to set user settings.</p>
|
|
8152
|
-
*/
|
|
8153
|
-
export interface SetUserSettingsRequest {
|
|
8237
|
+
CompromisedCredentialsRiskConfiguration?: CompromisedCredentialsRiskConfigurationType;
|
|
8154
8238
|
/**
|
|
8155
8239
|
* @public
|
|
8156
|
-
* <p>
|
|
8157
|
-
* configure.</p>
|
|
8240
|
+
* <p>The account takeover risk configuration.</p>
|
|
8158
8241
|
*/
|
|
8159
|
-
|
|
8242
|
+
AccountTakeoverRiskConfiguration?: AccountTakeoverRiskConfigurationType;
|
|
8160
8243
|
/**
|
|
8161
8244
|
* @public
|
|
8162
|
-
* <p>
|
|
8163
|
-
* delivery.</p>
|
|
8245
|
+
* <p>The configuration to override the risk decision.</p>
|
|
8164
8246
|
*/
|
|
8165
|
-
|
|
8166
|
-
}
|
|
8167
|
-
/**
|
|
8168
|
-
* @public
|
|
8169
|
-
* <p>The response from the server for a set user settings request.</p>
|
|
8170
|
-
*/
|
|
8171
|
-
export interface SetUserSettingsResponse {
|
|
8247
|
+
RiskExceptionConfiguration?: RiskExceptionConfigurationType;
|
|
8172
8248
|
}
|
|
8173
8249
|
/**
|
|
8174
8250
|
* @internal
|
|
@@ -8322,10 +8398,6 @@ export declare const ChangePasswordRequestFilterSensitiveLog: (obj: ChangePasswo
|
|
|
8322
8398
|
* @internal
|
|
8323
8399
|
*/
|
|
8324
8400
|
export declare const ConfirmDeviceRequestFilterSensitiveLog: (obj: ConfirmDeviceRequest) => any;
|
|
8325
|
-
/**
|
|
8326
|
-
* @internal
|
|
8327
|
-
*/
|
|
8328
|
-
export declare const UserContextDataTypeFilterSensitiveLog: (obj: UserContextDataType) => any;
|
|
8329
8401
|
/**
|
|
8330
8402
|
* @internal
|
|
8331
8403
|
*/
|
|
@@ -8470,23 +8542,3 @@ export declare const RevokeTokenRequestFilterSensitiveLog: (obj: RevokeTokenRequ
|
|
|
8470
8542
|
* @internal
|
|
8471
8543
|
*/
|
|
8472
8544
|
export declare const SetRiskConfigurationRequestFilterSensitiveLog: (obj: SetRiskConfigurationRequest) => any;
|
|
8473
|
-
/**
|
|
8474
|
-
* @internal
|
|
8475
|
-
*/
|
|
8476
|
-
export declare const SetRiskConfigurationResponseFilterSensitiveLog: (obj: SetRiskConfigurationResponse) => any;
|
|
8477
|
-
/**
|
|
8478
|
-
* @internal
|
|
8479
|
-
*/
|
|
8480
|
-
export declare const SetUICustomizationRequestFilterSensitiveLog: (obj: SetUICustomizationRequest) => any;
|
|
8481
|
-
/**
|
|
8482
|
-
* @internal
|
|
8483
|
-
*/
|
|
8484
|
-
export declare const SetUICustomizationResponseFilterSensitiveLog: (obj: SetUICustomizationResponse) => any;
|
|
8485
|
-
/**
|
|
8486
|
-
* @internal
|
|
8487
|
-
*/
|
|
8488
|
-
export declare const SetUserMFAPreferenceRequestFilterSensitiveLog: (obj: SetUserMFAPreferenceRequest) => any;
|
|
8489
|
-
/**
|
|
8490
|
-
* @internal
|
|
8491
|
-
*/
|
|
8492
|
-
export declare const SetUserSettingsRequestFilterSensitiveLog: (obj: SetUserSettingsRequest) => any;
|