@aws-sdk/client-cognito-identity-provider 3.774.0 → 3.777.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/dist-cjs/auth/httpAuthSchemeProvider.js +1 -3
- package/dist-cjs/index.js +17 -18
- package/dist-es/CognitoIdentityProviderClient.js +2 -1
- package/dist-es/auth/httpAuthSchemeProvider.js +1 -3
- package/dist-es/endpoint/EndpointParameters.js +2 -3
- package/dist-es/runtimeExtensions.js +2 -14
- package/dist-types/commands/AddCustomAttributesCommand.d.ts +1 -0
- package/dist-types/commands/AdminAddUserToGroupCommand.d.ts +1 -0
- package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +1 -0
- package/dist-types/commands/AdminCreateUserCommand.d.ts +30 -30
- package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +1 -0
- package/dist-types/commands/AdminDeleteUserCommand.d.ts +1 -0
- package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +1 -0
- package/dist-types/commands/AdminDisableUserCommand.d.ts +1 -0
- package/dist-types/commands/AdminEnableUserCommand.d.ts +1 -0
- package/dist-types/commands/AdminForgetDeviceCommand.d.ts +1 -0
- package/dist-types/commands/AdminGetDeviceCommand.d.ts +1 -0
- package/dist-types/commands/AdminGetUserCommand.d.ts +1 -0
- package/dist-types/commands/AdminInitiateAuthCommand.d.ts +1 -0
- package/dist-types/commands/AdminLinkProviderForUserCommand.d.ts +1 -0
- package/dist-types/commands/AdminListDevicesCommand.d.ts +1 -0
- package/dist-types/commands/AdminListGroupsForUserCommand.d.ts +1 -0
- package/dist-types/commands/AdminListUserAuthEventsCommand.d.ts +1 -0
- package/dist-types/commands/AdminRemoveUserFromGroupCommand.d.ts +1 -0
- package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +1 -0
- package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +1 -0
- package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +1 -0
- package/dist-types/commands/AdminSetUserPasswordCommand.d.ts +1 -0
- package/dist-types/commands/AdminSetUserSettingsCommand.d.ts +1 -0
- package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts +1 -0
- package/dist-types/commands/AdminUpdateDeviceStatusCommand.d.ts +1 -0
- package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +1 -0
- package/dist-types/commands/AdminUserGlobalSignOutCommand.d.ts +1 -0
- package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +1 -0
- package/dist-types/commands/ChangePasswordCommand.d.ts +1 -0
- package/dist-types/commands/CompleteWebAuthnRegistrationCommand.d.ts +1 -0
- package/dist-types/commands/ConfirmDeviceCommand.d.ts +1 -0
- package/dist-types/commands/ConfirmForgotPasswordCommand.d.ts +1 -0
- package/dist-types/commands/ConfirmSignUpCommand.d.ts +1 -0
- package/dist-types/commands/CreateGroupCommand.d.ts +1 -0
- package/dist-types/commands/CreateIdentityProviderCommand.d.ts +1 -0
- package/dist-types/commands/CreateManagedLoginBrandingCommand.d.ts +1 -0
- package/dist-types/commands/CreateResourceServerCommand.d.ts +1 -0
- package/dist-types/commands/CreateUserImportJobCommand.d.ts +1 -0
- package/dist-types/commands/CreateUserPoolClientCommand.d.ts +62 -62
- package/dist-types/commands/CreateUserPoolCommand.d.ts +327 -327
- package/dist-types/commands/CreateUserPoolDomainCommand.d.ts +1 -0
- package/dist-types/commands/DeleteGroupCommand.d.ts +1 -0
- package/dist-types/commands/DeleteIdentityProviderCommand.d.ts +1 -0
- package/dist-types/commands/DeleteManagedLoginBrandingCommand.d.ts +1 -0
- package/dist-types/commands/DeleteResourceServerCommand.d.ts +1 -0
- package/dist-types/commands/DeleteUserAttributesCommand.d.ts +1 -0
- package/dist-types/commands/DeleteUserCommand.d.ts +1 -0
- package/dist-types/commands/DeleteUserPoolClientCommand.d.ts +2 -1
- package/dist-types/commands/DeleteUserPoolCommand.d.ts +1 -0
- package/dist-types/commands/DeleteUserPoolDomainCommand.d.ts +1 -0
- package/dist-types/commands/DeleteWebAuthnCredentialCommand.d.ts +1 -0
- package/dist-types/commands/DescribeIdentityProviderCommand.d.ts +1 -0
- package/dist-types/commands/DescribeManagedLoginBrandingByClientCommand.d.ts +1 -0
- package/dist-types/commands/DescribeManagedLoginBrandingCommand.d.ts +1 -0
- package/dist-types/commands/DescribeResourceServerCommand.d.ts +1 -0
- package/dist-types/commands/DescribeRiskConfigurationCommand.d.ts +1 -0
- package/dist-types/commands/DescribeUserImportJobCommand.d.ts +1 -0
- package/dist-types/commands/DescribeUserPoolClientCommand.d.ts +1 -0
- package/dist-types/commands/DescribeUserPoolCommand.d.ts +1 -0
- package/dist-types/commands/DescribeUserPoolDomainCommand.d.ts +1 -0
- package/dist-types/commands/ForgetDeviceCommand.d.ts +1 -0
- package/dist-types/commands/ForgotPasswordCommand.d.ts +1 -0
- package/dist-types/commands/GetCSVHeaderCommand.d.ts +1 -0
- package/dist-types/commands/GetDeviceCommand.d.ts +1 -0
- package/dist-types/commands/GetGroupCommand.d.ts +1 -0
- package/dist-types/commands/GetIdentityProviderByIdentifierCommand.d.ts +1 -0
- package/dist-types/commands/GetLogDeliveryConfigurationCommand.d.ts +1 -0
- package/dist-types/commands/GetSigningCertificateCommand.d.ts +1 -0
- package/dist-types/commands/GetUICustomizationCommand.d.ts +1 -0
- package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +1 -0
- package/dist-types/commands/GetUserAuthFactorsCommand.d.ts +1 -0
- package/dist-types/commands/GetUserCommand.d.ts +1 -0
- package/dist-types/commands/GetUserPoolMfaConfigCommand.d.ts +1 -0
- package/dist-types/commands/GlobalSignOutCommand.d.ts +1 -0
- package/dist-types/commands/InitiateAuthCommand.d.ts +21 -21
- package/dist-types/commands/ListDevicesCommand.d.ts +1 -0
- package/dist-types/commands/ListGroupsCommand.d.ts +1 -0
- package/dist-types/commands/ListIdentityProvidersCommand.d.ts +1 -0
- package/dist-types/commands/ListResourceServersCommand.d.ts +1 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -0
- package/dist-types/commands/ListUserImportJobsCommand.d.ts +1 -0
- package/dist-types/commands/ListUserPoolClientsCommand.d.ts +1 -0
- package/dist-types/commands/ListUserPoolsCommand.d.ts +1 -0
- package/dist-types/commands/ListUsersCommand.d.ts +40 -40
- package/dist-types/commands/ListUsersInGroupCommand.d.ts +1 -0
- package/dist-types/commands/ListWebAuthnCredentialsCommand.d.ts +1 -0
- package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +1 -0
- package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +1 -0
- package/dist-types/commands/RevokeTokenCommand.d.ts +1 -0
- package/dist-types/commands/SetLogDeliveryConfigurationCommand.d.ts +1 -0
- package/dist-types/commands/SetRiskConfigurationCommand.d.ts +1 -0
- package/dist-types/commands/SetUICustomizationCommand.d.ts +1 -0
- package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +1 -0
- package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +1 -0
- package/dist-types/commands/SetUserSettingsCommand.d.ts +1 -0
- package/dist-types/commands/SignUpCommand.d.ts +1 -0
- package/dist-types/commands/StartUserImportJobCommand.d.ts +1 -0
- package/dist-types/commands/StartWebAuthnRegistrationCommand.d.ts +1 -0
- package/dist-types/commands/StopUserImportJobCommand.d.ts +1 -0
- package/dist-types/commands/TagResourceCommand.d.ts +1 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -0
- package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts +1 -0
- package/dist-types/commands/UpdateDeviceStatusCommand.d.ts +1 -0
- package/dist-types/commands/UpdateGroupCommand.d.ts +1 -0
- package/dist-types/commands/UpdateIdentityProviderCommand.d.ts +1 -0
- package/dist-types/commands/UpdateManagedLoginBrandingCommand.d.ts +1 -0
- package/dist-types/commands/UpdateResourceServerCommand.d.ts +1 -0
- package/dist-types/commands/UpdateUserAttributesCommand.d.ts +1 -0
- package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +1 -0
- package/dist-types/commands/UpdateUserPoolCommand.d.ts +1 -0
- package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts +1 -0
- package/dist-types/commands/VerifySoftwareTokenCommand.d.ts +1 -0
- package/dist-types/commands/VerifyUserAttributeCommand.d.ts +1 -0
- package/package.json +33 -33
|
@@ -414,463 +414,463 @@ declare const CreateUserPoolCommand_base: {
|
|
|
414
414
|
* @throws {@link CognitoIdentityProviderServiceException}
|
|
415
415
|
* <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
|
|
416
416
|
*
|
|
417
|
-
*
|
|
417
|
+
*
|
|
418
418
|
* @example Example user pool with email and username sign-in
|
|
419
419
|
* ```javascript
|
|
420
420
|
* // The following example creates a user pool with all configurable properties set to an example value. The resulting user pool allows sign-in with username or email address, has optional MFA, and has a Lambda function assigned to each possible trigger.
|
|
421
421
|
* const input = {
|
|
422
|
-
*
|
|
423
|
-
*
|
|
422
|
+
* AccountRecoverySetting: {
|
|
423
|
+
* RecoveryMechanisms: [
|
|
424
424
|
* {
|
|
425
|
-
*
|
|
426
|
-
*
|
|
425
|
+
* Name: "verified_email",
|
|
426
|
+
* Priority: 1
|
|
427
427
|
* }
|
|
428
428
|
* ]
|
|
429
429
|
* },
|
|
430
|
-
*
|
|
431
|
-
*
|
|
432
|
-
*
|
|
433
|
-
*
|
|
434
|
-
*
|
|
435
|
-
*
|
|
430
|
+
* AdminCreateUserConfig: {
|
|
431
|
+
* AllowAdminCreateUserOnly: false,
|
|
432
|
+
* InviteMessageTemplate: {
|
|
433
|
+
* EmailMessage: "Your username is {username} and temporary password is {####}.",
|
|
434
|
+
* EmailSubject: "Your sign-in information",
|
|
435
|
+
* SMSMessage: "Your username is {username} and temporary password is {####}."
|
|
436
436
|
* }
|
|
437
437
|
* },
|
|
438
|
-
*
|
|
438
|
+
* AliasAttributes: [
|
|
439
439
|
* "email"
|
|
440
440
|
* ],
|
|
441
|
-
*
|
|
441
|
+
* AutoVerifiedAttributes: [
|
|
442
442
|
* "email"
|
|
443
443
|
* ],
|
|
444
|
-
*
|
|
445
|
-
*
|
|
446
|
-
*
|
|
447
|
-
*
|
|
444
|
+
* DeletionProtection: "ACTIVE",
|
|
445
|
+
* DeviceConfiguration: {
|
|
446
|
+
* ChallengeRequiredOnNewDevice: true,
|
|
447
|
+
* DeviceOnlyRememberedOnUserPrompt: true
|
|
448
448
|
* },
|
|
449
|
-
*
|
|
450
|
-
*
|
|
451
|
-
*
|
|
452
|
-
*
|
|
453
|
-
*
|
|
454
|
-
*
|
|
449
|
+
* EmailConfiguration: {
|
|
450
|
+
* ConfigurationSet: "my-test-ses-configuration-set",
|
|
451
|
+
* EmailSendingAccount: "DEVELOPER",
|
|
452
|
+
* From: "support@example.com",
|
|
453
|
+
* ReplyToEmailAddress: "support@example.com",
|
|
454
|
+
* SourceArn: "arn:aws:ses:us-east-1:123456789012:identity/support@example.com"
|
|
455
455
|
* },
|
|
456
|
-
*
|
|
457
|
-
*
|
|
458
|
-
*
|
|
459
|
-
*
|
|
460
|
-
*
|
|
461
|
-
*
|
|
456
|
+
* EmailVerificationMessage: "Your verification code is {####}.",
|
|
457
|
+
* EmailVerificationSubject: "Verify your email address",
|
|
458
|
+
* LambdaConfig: {
|
|
459
|
+
* CustomEmailSender: {
|
|
460
|
+
* LambdaArn: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
|
|
461
|
+
* LambdaVersion: "V1_0"
|
|
462
462
|
* },
|
|
463
|
-
*
|
|
464
|
-
*
|
|
465
|
-
*
|
|
466
|
-
*
|
|
463
|
+
* CustomMessage: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
|
|
464
|
+
* CustomSMSSender: {
|
|
465
|
+
* LambdaArn: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
|
|
466
|
+
* LambdaVersion: "V1_0"
|
|
467
467
|
* },
|
|
468
|
-
*
|
|
469
|
-
*
|
|
470
|
-
*
|
|
471
|
-
*
|
|
472
|
-
*
|
|
473
|
-
*
|
|
474
|
-
*
|
|
475
|
-
*
|
|
476
|
-
*
|
|
468
|
+
* DefineAuthChallenge: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
|
|
469
|
+
* KMSKeyID: "arn:aws:kms:us-east-1:123456789012:key/a6c4f8e2-0c45-47db-925f-87854bc9e357",
|
|
470
|
+
* PostAuthentication: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
|
|
471
|
+
* PostConfirmation: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
|
|
472
|
+
* PreAuthentication: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
|
|
473
|
+
* PreSignUp: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
|
|
474
|
+
* PreTokenGeneration: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
|
|
475
|
+
* UserMigration: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
|
|
476
|
+
* VerifyAuthChallengeResponse: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction"
|
|
477
477
|
* },
|
|
478
|
-
*
|
|
479
|
-
*
|
|
480
|
-
*
|
|
481
|
-
*
|
|
482
|
-
*
|
|
483
|
-
*
|
|
484
|
-
*
|
|
485
|
-
*
|
|
486
|
-
*
|
|
478
|
+
* MfaConfiguration: "OPTIONAL",
|
|
479
|
+
* Policies: {
|
|
480
|
+
* PasswordPolicy: {
|
|
481
|
+
* MinimumLength: 6,
|
|
482
|
+
* RequireLowercase: true,
|
|
483
|
+
* RequireNumbers: true,
|
|
484
|
+
* RequireSymbols: true,
|
|
485
|
+
* RequireUppercase: true,
|
|
486
|
+
* TemporaryPasswordValidityDays: 7
|
|
487
487
|
* }
|
|
488
488
|
* },
|
|
489
|
-
*
|
|
490
|
-
*
|
|
489
|
+
* PoolName: "my-test-user-pool",
|
|
490
|
+
* Schema: [
|
|
491
491
|
* {
|
|
492
|
-
*
|
|
493
|
-
*
|
|
494
|
-
*
|
|
495
|
-
*
|
|
496
|
-
*
|
|
497
|
-
*
|
|
498
|
-
*
|
|
492
|
+
* AttributeDataType: "Number",
|
|
493
|
+
* DeveloperOnlyAttribute: true,
|
|
494
|
+
* Mutable: true,
|
|
495
|
+
* Name: "mydev",
|
|
496
|
+
* NumberAttributeConstraints: {
|
|
497
|
+
* MaxValue: "99",
|
|
498
|
+
* MinValue: "1"
|
|
499
499
|
* },
|
|
500
|
-
*
|
|
501
|
-
*
|
|
502
|
-
*
|
|
503
|
-
*
|
|
500
|
+
* Required: false,
|
|
501
|
+
* StringAttributeConstraints: {
|
|
502
|
+
* MaxLength: "99",
|
|
503
|
+
* MinLength: "1"
|
|
504
504
|
* }
|
|
505
505
|
* }
|
|
506
506
|
* ],
|
|
507
|
-
*
|
|
508
|
-
*
|
|
509
|
-
*
|
|
510
|
-
*
|
|
507
|
+
* SmsAuthenticationMessage: "Your verification code is {####}.",
|
|
508
|
+
* SmsConfiguration: {
|
|
509
|
+
* ExternalId: "my-role-external-id",
|
|
510
|
+
* SnsCallerArn: "arn:aws:iam::123456789012:role/service-role/test-cognito-SMS-Role"
|
|
511
511
|
* },
|
|
512
|
-
*
|
|
513
|
-
*
|
|
514
|
-
*
|
|
512
|
+
* SmsVerificationMessage: "Your verification code is {####}.",
|
|
513
|
+
* UserAttributeUpdateSettings: {
|
|
514
|
+
* AttributesRequireVerificationBeforeUpdate: [
|
|
515
515
|
* "email"
|
|
516
516
|
* ]
|
|
517
517
|
* },
|
|
518
|
-
*
|
|
519
|
-
*
|
|
518
|
+
* UserPoolAddOns: {
|
|
519
|
+
* AdvancedSecurityMode: "OFF"
|
|
520
520
|
* },
|
|
521
|
-
*
|
|
522
|
-
*
|
|
521
|
+
* UserPoolTags: {
|
|
522
|
+
* my-test-tag-key: "my-test-tag-key"
|
|
523
523
|
* },
|
|
524
|
-
*
|
|
525
|
-
*
|
|
524
|
+
* UsernameConfiguration: {
|
|
525
|
+
* CaseSensitive: true
|
|
526
526
|
* },
|
|
527
|
-
*
|
|
528
|
-
*
|
|
529
|
-
*
|
|
530
|
-
*
|
|
531
|
-
*
|
|
532
|
-
*
|
|
533
|
-
*
|
|
527
|
+
* VerificationMessageTemplate: {
|
|
528
|
+
* DefaultEmailOption: "CONFIRM_WITH_CODE",
|
|
529
|
+
* EmailMessage: "Your confirmation code is {####}",
|
|
530
|
+
* EmailMessageByLink: "Choose this link to {##verify your email##}",
|
|
531
|
+
* EmailSubject: "Here is your confirmation code",
|
|
532
|
+
* EmailSubjectByLink: "Here is your confirmation link",
|
|
533
|
+
* SmsMessage: "Your confirmation code is {####}"
|
|
534
534
|
* }
|
|
535
535
|
* };
|
|
536
536
|
* const command = new CreateUserPoolCommand(input);
|
|
537
537
|
* const response = await client.send(command);
|
|
538
|
-
* /* response
|
|
538
|
+
* /* response is
|
|
539
539
|
* {
|
|
540
|
-
*
|
|
541
|
-
*
|
|
542
|
-
*
|
|
540
|
+
* UserPool: {
|
|
541
|
+
* AccountRecoverySetting: {
|
|
542
|
+
* RecoveryMechanisms: [
|
|
543
543
|
* {
|
|
544
|
-
*
|
|
545
|
-
*
|
|
544
|
+
* Name: "verified_email",
|
|
545
|
+
* Priority: 1
|
|
546
546
|
* }
|
|
547
547
|
* ]
|
|
548
548
|
* },
|
|
549
|
-
*
|
|
550
|
-
*
|
|
551
|
-
*
|
|
552
|
-
*
|
|
553
|
-
*
|
|
554
|
-
*
|
|
549
|
+
* AdminCreateUserConfig: {
|
|
550
|
+
* AllowAdminCreateUserOnly: false,
|
|
551
|
+
* InviteMessageTemplate: {
|
|
552
|
+
* EmailMessage: "Your username is {username} and temporary password is {####}.",
|
|
553
|
+
* EmailSubject: "Your sign-in information",
|
|
554
|
+
* SMSMessage: "Your username is {username} and temporary password is {####}."
|
|
555
555
|
* },
|
|
556
|
-
*
|
|
556
|
+
* UnusedAccountValidityDays: 7
|
|
557
557
|
* },
|
|
558
|
-
*
|
|
558
|
+
* AliasAttributes: [
|
|
559
559
|
* "email"
|
|
560
560
|
* ],
|
|
561
|
-
*
|
|
562
|
-
*
|
|
561
|
+
* Arn: "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_EXAMPLE",
|
|
562
|
+
* AutoVerifiedAttributes: [
|
|
563
563
|
* "email"
|
|
564
564
|
* ],
|
|
565
|
-
*
|
|
566
|
-
*
|
|
567
|
-
*
|
|
568
|
-
*
|
|
569
|
-
*
|
|
565
|
+
* CreationDate: 1.689721665239E9,
|
|
566
|
+
* DeletionProtection: "ACTIVE",
|
|
567
|
+
* DeviceConfiguration: {
|
|
568
|
+
* ChallengeRequiredOnNewDevice: true,
|
|
569
|
+
* DeviceOnlyRememberedOnUserPrompt: true
|
|
570
570
|
* },
|
|
571
|
-
*
|
|
572
|
-
*
|
|
573
|
-
*
|
|
574
|
-
*
|
|
575
|
-
*
|
|
576
|
-
*
|
|
571
|
+
* EmailConfiguration: {
|
|
572
|
+
* ConfigurationSet: "my-test-ses-configuration-set",
|
|
573
|
+
* EmailSendingAccount: "DEVELOPER",
|
|
574
|
+
* From: "support@example.com",
|
|
575
|
+
* ReplyToEmailAddress: "support@example.com",
|
|
576
|
+
* SourceArn: "arn:aws:ses:us-east-1:123456789012:identity/support@example.com"
|
|
577
577
|
* },
|
|
578
|
-
*
|
|
579
|
-
*
|
|
580
|
-
*
|
|
581
|
-
*
|
|
582
|
-
*
|
|
583
|
-
*
|
|
584
|
-
*
|
|
585
|
-
*
|
|
578
|
+
* EmailVerificationMessage: "Your verification code is {####}.",
|
|
579
|
+
* EmailVerificationSubject: "Verify your email address",
|
|
580
|
+
* EstimatedNumberOfUsers: 0,
|
|
581
|
+
* Id: "us-east-1_EXAMPLE",
|
|
582
|
+
* LambdaConfig: {
|
|
583
|
+
* CustomEmailSender: {
|
|
584
|
+
* LambdaArn: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
|
|
585
|
+
* LambdaVersion: "V1_0"
|
|
586
586
|
* },
|
|
587
|
-
*
|
|
588
|
-
*
|
|
589
|
-
*
|
|
590
|
-
*
|
|
587
|
+
* CustomMessage: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
|
|
588
|
+
* CustomSMSSender: {
|
|
589
|
+
* LambdaArn: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
|
|
590
|
+
* LambdaVersion: "V1_0"
|
|
591
591
|
* },
|
|
592
|
-
*
|
|
593
|
-
*
|
|
594
|
-
*
|
|
595
|
-
*
|
|
596
|
-
*
|
|
597
|
-
*
|
|
598
|
-
*
|
|
599
|
-
*
|
|
600
|
-
*
|
|
592
|
+
* DefineAuthChallenge: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
|
|
593
|
+
* KMSKeyID: "arn:aws:kms:us-east-1:767671399759:key/4d43904c-8edf-4bb4-9fca-fb1a80e41cbe",
|
|
594
|
+
* PostAuthentication: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
|
|
595
|
+
* PostConfirmation: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
|
|
596
|
+
* PreAuthentication: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
|
|
597
|
+
* PreSignUp: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
|
|
598
|
+
* PreTokenGeneration: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
|
|
599
|
+
* UserMigration: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
|
|
600
|
+
* VerifyAuthChallengeResponse: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction"
|
|
601
601
|
* },
|
|
602
|
-
*
|
|
603
|
-
*
|
|
604
|
-
*
|
|
605
|
-
*
|
|
606
|
-
*
|
|
607
|
-
*
|
|
608
|
-
*
|
|
609
|
-
*
|
|
610
|
-
*
|
|
611
|
-
*
|
|
612
|
-
*
|
|
602
|
+
* LastModifiedDate: 1.689721665239E9,
|
|
603
|
+
* MfaConfiguration: "OPTIONAL",
|
|
604
|
+
* Name: "my-test-user-pool",
|
|
605
|
+
* Policies: {
|
|
606
|
+
* PasswordPolicy: {
|
|
607
|
+
* MinimumLength: 6,
|
|
608
|
+
* RequireLowercase: true,
|
|
609
|
+
* RequireNumbers: true,
|
|
610
|
+
* RequireSymbols: true,
|
|
611
|
+
* RequireUppercase: true,
|
|
612
|
+
* TemporaryPasswordValidityDays: 7
|
|
613
613
|
* }
|
|
614
614
|
* },
|
|
615
|
-
*
|
|
615
|
+
* SchemaAttributes: [
|
|
616
616
|
* {
|
|
617
|
-
*
|
|
618
|
-
*
|
|
619
|
-
*
|
|
620
|
-
*
|
|
621
|
-
*
|
|
622
|
-
*
|
|
623
|
-
*
|
|
624
|
-
*
|
|
617
|
+
* AttributeDataType: "String",
|
|
618
|
+
* DeveloperOnlyAttribute: false,
|
|
619
|
+
* Mutable: false,
|
|
620
|
+
* Name: "sub",
|
|
621
|
+
* Required: true,
|
|
622
|
+
* StringAttributeConstraints: {
|
|
623
|
+
* MaxLength: "2048",
|
|
624
|
+
* MinLength: "1"
|
|
625
625
|
* }
|
|
626
626
|
* },
|
|
627
627
|
* {
|
|
628
|
-
*
|
|
629
|
-
*
|
|
630
|
-
*
|
|
631
|
-
*
|
|
632
|
-
*
|
|
633
|
-
*
|
|
634
|
-
*
|
|
635
|
-
*
|
|
628
|
+
* AttributeDataType: "String",
|
|
629
|
+
* DeveloperOnlyAttribute: false,
|
|
630
|
+
* Mutable: true,
|
|
631
|
+
* Name: "name",
|
|
632
|
+
* Required: false,
|
|
633
|
+
* StringAttributeConstraints: {
|
|
634
|
+
* MaxLength: "2048",
|
|
635
|
+
* MinLength: "0"
|
|
636
636
|
* }
|
|
637
637
|
* },
|
|
638
638
|
* {
|
|
639
|
-
*
|
|
640
|
-
*
|
|
641
|
-
*
|
|
642
|
-
*
|
|
643
|
-
*
|
|
644
|
-
*
|
|
645
|
-
*
|
|
646
|
-
*
|
|
639
|
+
* AttributeDataType: "String",
|
|
640
|
+
* DeveloperOnlyAttribute: false,
|
|
641
|
+
* Mutable: true,
|
|
642
|
+
* Name: "given_name",
|
|
643
|
+
* Required: false,
|
|
644
|
+
* StringAttributeConstraints: {
|
|
645
|
+
* MaxLength: "2048",
|
|
646
|
+
* MinLength: "0"
|
|
647
647
|
* }
|
|
648
648
|
* },
|
|
649
649
|
* {
|
|
650
|
-
*
|
|
651
|
-
*
|
|
652
|
-
*
|
|
653
|
-
*
|
|
654
|
-
*
|
|
655
|
-
*
|
|
656
|
-
*
|
|
657
|
-
*
|
|
650
|
+
* AttributeDataType: "String",
|
|
651
|
+
* DeveloperOnlyAttribute: false,
|
|
652
|
+
* Mutable: true,
|
|
653
|
+
* Name: "family_name",
|
|
654
|
+
* Required: false,
|
|
655
|
+
* StringAttributeConstraints: {
|
|
656
|
+
* MaxLength: "2048",
|
|
657
|
+
* MinLength: "0"
|
|
658
658
|
* }
|
|
659
659
|
* },
|
|
660
660
|
* {
|
|
661
|
-
*
|
|
662
|
-
*
|
|
663
|
-
*
|
|
664
|
-
*
|
|
665
|
-
*
|
|
666
|
-
*
|
|
667
|
-
*
|
|
668
|
-
*
|
|
661
|
+
* AttributeDataType: "String",
|
|
662
|
+
* DeveloperOnlyAttribute: false,
|
|
663
|
+
* Mutable: true,
|
|
664
|
+
* Name: "middle_name",
|
|
665
|
+
* Required: false,
|
|
666
|
+
* StringAttributeConstraints: {
|
|
667
|
+
* MaxLength: "2048",
|
|
668
|
+
* MinLength: "0"
|
|
669
669
|
* }
|
|
670
670
|
* },
|
|
671
671
|
* {
|
|
672
|
-
*
|
|
673
|
-
*
|
|
674
|
-
*
|
|
675
|
-
*
|
|
676
|
-
*
|
|
677
|
-
*
|
|
678
|
-
*
|
|
679
|
-
*
|
|
672
|
+
* AttributeDataType: "String",
|
|
673
|
+
* DeveloperOnlyAttribute: false,
|
|
674
|
+
* Mutable: true,
|
|
675
|
+
* Name: "nickname",
|
|
676
|
+
* Required: false,
|
|
677
|
+
* StringAttributeConstraints: {
|
|
678
|
+
* MaxLength: "2048",
|
|
679
|
+
* MinLength: "0"
|
|
680
680
|
* }
|
|
681
681
|
* },
|
|
682
682
|
* {
|
|
683
|
-
*
|
|
684
|
-
*
|
|
685
|
-
*
|
|
686
|
-
*
|
|
687
|
-
*
|
|
688
|
-
*
|
|
689
|
-
*
|
|
690
|
-
*
|
|
683
|
+
* AttributeDataType: "String",
|
|
684
|
+
* DeveloperOnlyAttribute: false,
|
|
685
|
+
* Mutable: true,
|
|
686
|
+
* Name: "preferred_username",
|
|
687
|
+
* Required: false,
|
|
688
|
+
* StringAttributeConstraints: {
|
|
689
|
+
* MaxLength: "2048",
|
|
690
|
+
* MinLength: "0"
|
|
691
691
|
* }
|
|
692
692
|
* },
|
|
693
693
|
* {
|
|
694
|
-
*
|
|
695
|
-
*
|
|
696
|
-
*
|
|
697
|
-
*
|
|
698
|
-
*
|
|
699
|
-
*
|
|
700
|
-
*
|
|
701
|
-
*
|
|
694
|
+
* AttributeDataType: "String",
|
|
695
|
+
* DeveloperOnlyAttribute: false,
|
|
696
|
+
* Mutable: true,
|
|
697
|
+
* Name: "profile",
|
|
698
|
+
* Required: false,
|
|
699
|
+
* StringAttributeConstraints: {
|
|
700
|
+
* MaxLength: "2048",
|
|
701
|
+
* MinLength: "0"
|
|
702
702
|
* }
|
|
703
703
|
* },
|
|
704
704
|
* {
|
|
705
|
-
*
|
|
706
|
-
*
|
|
707
|
-
*
|
|
708
|
-
*
|
|
709
|
-
*
|
|
710
|
-
*
|
|
711
|
-
*
|
|
712
|
-
*
|
|
705
|
+
* AttributeDataType: "String",
|
|
706
|
+
* DeveloperOnlyAttribute: false,
|
|
707
|
+
* Mutable: true,
|
|
708
|
+
* Name: "picture",
|
|
709
|
+
* Required: false,
|
|
710
|
+
* StringAttributeConstraints: {
|
|
711
|
+
* MaxLength: "2048",
|
|
712
|
+
* MinLength: "0"
|
|
713
713
|
* }
|
|
714
714
|
* },
|
|
715
715
|
* {
|
|
716
|
-
*
|
|
717
|
-
*
|
|
718
|
-
*
|
|
719
|
-
*
|
|
720
|
-
*
|
|
721
|
-
*
|
|
722
|
-
*
|
|
723
|
-
*
|
|
716
|
+
* AttributeDataType: "String",
|
|
717
|
+
* DeveloperOnlyAttribute: false,
|
|
718
|
+
* Mutable: true,
|
|
719
|
+
* Name: "website",
|
|
720
|
+
* Required: false,
|
|
721
|
+
* StringAttributeConstraints: {
|
|
722
|
+
* MaxLength: "2048",
|
|
723
|
+
* MinLength: "0"
|
|
724
724
|
* }
|
|
725
725
|
* },
|
|
726
726
|
* {
|
|
727
|
-
*
|
|
728
|
-
*
|
|
729
|
-
*
|
|
730
|
-
*
|
|
731
|
-
*
|
|
732
|
-
*
|
|
733
|
-
*
|
|
734
|
-
*
|
|
727
|
+
* AttributeDataType: "String",
|
|
728
|
+
* DeveloperOnlyAttribute: false,
|
|
729
|
+
* Mutable: true,
|
|
730
|
+
* Name: "email",
|
|
731
|
+
* Required: false,
|
|
732
|
+
* StringAttributeConstraints: {
|
|
733
|
+
* MaxLength: "2048",
|
|
734
|
+
* MinLength: "0"
|
|
735
735
|
* }
|
|
736
736
|
* },
|
|
737
737
|
* {
|
|
738
|
-
*
|
|
739
|
-
*
|
|
740
|
-
*
|
|
741
|
-
*
|
|
742
|
-
*
|
|
738
|
+
* AttributeDataType: "Boolean",
|
|
739
|
+
* DeveloperOnlyAttribute: false,
|
|
740
|
+
* Mutable: true,
|
|
741
|
+
* Name: "email_verified",
|
|
742
|
+
* Required: false
|
|
743
743
|
* },
|
|
744
744
|
* {
|
|
745
|
-
*
|
|
746
|
-
*
|
|
747
|
-
*
|
|
748
|
-
*
|
|
749
|
-
*
|
|
750
|
-
*
|
|
751
|
-
*
|
|
752
|
-
*
|
|
745
|
+
* AttributeDataType: "String",
|
|
746
|
+
* DeveloperOnlyAttribute: false,
|
|
747
|
+
* Mutable: true,
|
|
748
|
+
* Name: "gender",
|
|
749
|
+
* Required: false,
|
|
750
|
+
* StringAttributeConstraints: {
|
|
751
|
+
* MaxLength: "2048",
|
|
752
|
+
* MinLength: "0"
|
|
753
753
|
* }
|
|
754
754
|
* },
|
|
755
755
|
* {
|
|
756
|
-
*
|
|
757
|
-
*
|
|
758
|
-
*
|
|
759
|
-
*
|
|
760
|
-
*
|
|
761
|
-
*
|
|
762
|
-
*
|
|
763
|
-
*
|
|
756
|
+
* AttributeDataType: "String",
|
|
757
|
+
* DeveloperOnlyAttribute: false,
|
|
758
|
+
* Mutable: true,
|
|
759
|
+
* Name: "birthdate",
|
|
760
|
+
* Required: false,
|
|
761
|
+
* StringAttributeConstraints: {
|
|
762
|
+
* MaxLength: "10",
|
|
763
|
+
* MinLength: "10"
|
|
764
764
|
* }
|
|
765
765
|
* },
|
|
766
766
|
* {
|
|
767
|
-
*
|
|
768
|
-
*
|
|
769
|
-
*
|
|
770
|
-
*
|
|
771
|
-
*
|
|
772
|
-
*
|
|
773
|
-
*
|
|
774
|
-
*
|
|
767
|
+
* AttributeDataType: "String",
|
|
768
|
+
* DeveloperOnlyAttribute: false,
|
|
769
|
+
* Mutable: true,
|
|
770
|
+
* Name: "zoneinfo",
|
|
771
|
+
* Required: false,
|
|
772
|
+
* StringAttributeConstraints: {
|
|
773
|
+
* MaxLength: "2048",
|
|
774
|
+
* MinLength: "0"
|
|
775
775
|
* }
|
|
776
776
|
* },
|
|
777
777
|
* {
|
|
778
|
-
*
|
|
779
|
-
*
|
|
780
|
-
*
|
|
781
|
-
*
|
|
782
|
-
*
|
|
783
|
-
*
|
|
784
|
-
*
|
|
785
|
-
*
|
|
778
|
+
* AttributeDataType: "String",
|
|
779
|
+
* DeveloperOnlyAttribute: false,
|
|
780
|
+
* Mutable: true,
|
|
781
|
+
* Name: "locale",
|
|
782
|
+
* Required: false,
|
|
783
|
+
* StringAttributeConstraints: {
|
|
784
|
+
* MaxLength: "2048",
|
|
785
|
+
* MinLength: "0"
|
|
786
786
|
* }
|
|
787
787
|
* },
|
|
788
788
|
* {
|
|
789
|
-
*
|
|
790
|
-
*
|
|
791
|
-
*
|
|
792
|
-
*
|
|
793
|
-
*
|
|
794
|
-
*
|
|
795
|
-
*
|
|
796
|
-
*
|
|
789
|
+
* AttributeDataType: "String",
|
|
790
|
+
* DeveloperOnlyAttribute: false,
|
|
791
|
+
* Mutable: true,
|
|
792
|
+
* Name: "phone_number",
|
|
793
|
+
* Required: false,
|
|
794
|
+
* StringAttributeConstraints: {
|
|
795
|
+
* MaxLength: "2048",
|
|
796
|
+
* MinLength: "0"
|
|
797
797
|
* }
|
|
798
798
|
* },
|
|
799
799
|
* {
|
|
800
|
-
*
|
|
801
|
-
*
|
|
802
|
-
*
|
|
803
|
-
*
|
|
804
|
-
*
|
|
800
|
+
* AttributeDataType: "Boolean",
|
|
801
|
+
* DeveloperOnlyAttribute: false,
|
|
802
|
+
* Mutable: true,
|
|
803
|
+
* Name: "phone_number_verifie",
|
|
804
|
+
* Required: false
|
|
805
805
|
* },
|
|
806
806
|
* {
|
|
807
|
-
*
|
|
808
|
-
*
|
|
809
|
-
*
|
|
810
|
-
*
|
|
811
|
-
*
|
|
812
|
-
*
|
|
813
|
-
*
|
|
814
|
-
*
|
|
807
|
+
* AttributeDataType: "String",
|
|
808
|
+
* DeveloperOnlyAttribute: false,
|
|
809
|
+
* Mutable: true,
|
|
810
|
+
* Name: "address",
|
|
811
|
+
* Required: false,
|
|
812
|
+
* StringAttributeConstraints: {
|
|
813
|
+
* MaxLength: "2048",
|
|
814
|
+
* MinLength: "0"
|
|
815
815
|
* }
|
|
816
816
|
* },
|
|
817
817
|
* {
|
|
818
|
-
*
|
|
819
|
-
*
|
|
820
|
-
*
|
|
821
|
-
*
|
|
822
|
-
*
|
|
823
|
-
*
|
|
818
|
+
* AttributeDataType: "Number",
|
|
819
|
+
* DeveloperOnlyAttribute: false,
|
|
820
|
+
* Mutable: true,
|
|
821
|
+
* Name: "updated_at",
|
|
822
|
+
* NumberAttributeConstraints: {
|
|
823
|
+
* MinValue: "0"
|
|
824
824
|
* },
|
|
825
|
-
*
|
|
825
|
+
* Required: false
|
|
826
826
|
* },
|
|
827
827
|
* {
|
|
828
|
-
*
|
|
829
|
-
*
|
|
830
|
-
*
|
|
831
|
-
*
|
|
832
|
-
*
|
|
833
|
-
*
|
|
834
|
-
*
|
|
828
|
+
* AttributeDataType: "Number",
|
|
829
|
+
* DeveloperOnlyAttribute: true,
|
|
830
|
+
* Mutable: true,
|
|
831
|
+
* Name: "dev:custom:mydev",
|
|
832
|
+
* NumberAttributeConstraints: {
|
|
833
|
+
* MaxValue: "99",
|
|
834
|
+
* MinValue: "1"
|
|
835
835
|
* },
|
|
836
|
-
*
|
|
836
|
+
* Required: false
|
|
837
837
|
* }
|
|
838
838
|
* ],
|
|
839
|
-
*
|
|
840
|
-
*
|
|
841
|
-
*
|
|
842
|
-
*
|
|
843
|
-
*
|
|
839
|
+
* SmsAuthenticationMessage: "Your verification code is {####}.",
|
|
840
|
+
* SmsConfiguration: {
|
|
841
|
+
* ExternalId: "my-role-external-id",
|
|
842
|
+
* SnsCallerArn: "arn:aws:iam::123456789012:role/service-role/test-cognito-SMS-Role",
|
|
843
|
+
* SnsRegion: "us-east-1"
|
|
844
844
|
* },
|
|
845
|
-
*
|
|
846
|
-
*
|
|
847
|
-
*
|
|
845
|
+
* SmsVerificationMessage: "Your verification code is {####}.",
|
|
846
|
+
* UserAttributeUpdateSettings: {
|
|
847
|
+
* AttributesRequireVerificationBeforeUpdate: [
|
|
848
848
|
* "email"
|
|
849
849
|
* ]
|
|
850
850
|
* },
|
|
851
|
-
*
|
|
852
|
-
*
|
|
851
|
+
* UserPoolAddOns: {
|
|
852
|
+
* AdvancedSecurityMode: "OFF"
|
|
853
853
|
* },
|
|
854
|
-
*
|
|
855
|
-
*
|
|
854
|
+
* UserPoolTags: {
|
|
855
|
+
* my-test-tag-key: "my-test-tag-value"
|
|
856
856
|
* },
|
|
857
|
-
*
|
|
858
|
-
*
|
|
857
|
+
* UsernameConfiguration: {
|
|
858
|
+
* CaseSensitive: true
|
|
859
859
|
* },
|
|
860
|
-
*
|
|
861
|
-
*
|
|
862
|
-
*
|
|
863
|
-
*
|
|
864
|
-
*
|
|
865
|
-
*
|
|
866
|
-
*
|
|
860
|
+
* VerificationMessageTemplate: {
|
|
861
|
+
* DefaultEmailOption: "CONFIRM_WITH_CODE",
|
|
862
|
+
* EmailMessage: "Your confirmation code is {####}",
|
|
863
|
+
* EmailMessageByLink: "Choose this link to {##verify your email##}",
|
|
864
|
+
* EmailSubject: "Here is your confirmation code",
|
|
865
|
+
* EmailSubjectByLink: "Here is your confirmation link",
|
|
866
|
+
* SmsMessage: "Your confirmation code is {####}"
|
|
867
867
|
* }
|
|
868
868
|
* }
|
|
869
869
|
* }
|
|
870
870
|
* *\/
|
|
871
|
-
* // example id: example-user-pool-with-email-and-username-sign-in-1689722835145
|
|
872
871
|
* ```
|
|
873
872
|
*
|
|
873
|
+
* @public
|
|
874
874
|
*/
|
|
875
875
|
export declare class CreateUserPoolCommand extends CreateUserPoolCommand_base {
|
|
876
876
|
/** @internal type navigation helper, not in runtime. */
|