@aws-sdk/client-cognito-identity-provider 3.295.0 → 3.297.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.
Files changed (117) hide show
  1. package/dist-types/CognitoIdentityProvider.d.ts +102 -0
  2. package/dist-types/CognitoIdentityProviderClient.d.ts +24 -4
  3. package/dist-types/commands/AddCustomAttributesCommand.d.ts +16 -0
  4. package/dist-types/commands/AdminAddUserToGroupCommand.d.ts +16 -0
  5. package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +16 -0
  6. package/dist-types/commands/AdminCreateUserCommand.d.ts +16 -0
  7. package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +16 -0
  8. package/dist-types/commands/AdminDeleteUserCommand.d.ts +16 -0
  9. package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +16 -0
  10. package/dist-types/commands/AdminDisableUserCommand.d.ts +16 -0
  11. package/dist-types/commands/AdminEnableUserCommand.d.ts +16 -0
  12. package/dist-types/commands/AdminForgetDeviceCommand.d.ts +16 -0
  13. package/dist-types/commands/AdminGetDeviceCommand.d.ts +16 -0
  14. package/dist-types/commands/AdminGetUserCommand.d.ts +16 -0
  15. package/dist-types/commands/AdminInitiateAuthCommand.d.ts +16 -0
  16. package/dist-types/commands/AdminLinkProviderForUserCommand.d.ts +16 -0
  17. package/dist-types/commands/AdminListDevicesCommand.d.ts +16 -0
  18. package/dist-types/commands/AdminListGroupsForUserCommand.d.ts +16 -0
  19. package/dist-types/commands/AdminListUserAuthEventsCommand.d.ts +16 -0
  20. package/dist-types/commands/AdminRemoveUserFromGroupCommand.d.ts +16 -0
  21. package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +16 -0
  22. package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +16 -0
  23. package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +16 -0
  24. package/dist-types/commands/AdminSetUserPasswordCommand.d.ts +16 -0
  25. package/dist-types/commands/AdminSetUserSettingsCommand.d.ts +16 -0
  26. package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts +16 -0
  27. package/dist-types/commands/AdminUpdateDeviceStatusCommand.d.ts +16 -0
  28. package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +16 -0
  29. package/dist-types/commands/AdminUserGlobalSignOutCommand.d.ts +16 -0
  30. package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +16 -0
  31. package/dist-types/commands/ChangePasswordCommand.d.ts +16 -0
  32. package/dist-types/commands/ConfirmDeviceCommand.d.ts +16 -0
  33. package/dist-types/commands/ConfirmForgotPasswordCommand.d.ts +16 -0
  34. package/dist-types/commands/ConfirmSignUpCommand.d.ts +16 -0
  35. package/dist-types/commands/CreateGroupCommand.d.ts +16 -0
  36. package/dist-types/commands/CreateIdentityProviderCommand.d.ts +16 -0
  37. package/dist-types/commands/CreateResourceServerCommand.d.ts +16 -0
  38. package/dist-types/commands/CreateUserImportJobCommand.d.ts +16 -0
  39. package/dist-types/commands/CreateUserPoolClientCommand.d.ts +16 -0
  40. package/dist-types/commands/CreateUserPoolCommand.d.ts +16 -0
  41. package/dist-types/commands/CreateUserPoolDomainCommand.d.ts +16 -0
  42. package/dist-types/commands/DeleteGroupCommand.d.ts +16 -0
  43. package/dist-types/commands/DeleteIdentityProviderCommand.d.ts +16 -0
  44. package/dist-types/commands/DeleteResourceServerCommand.d.ts +16 -0
  45. package/dist-types/commands/DeleteUserAttributesCommand.d.ts +16 -0
  46. package/dist-types/commands/DeleteUserCommand.d.ts +16 -0
  47. package/dist-types/commands/DeleteUserPoolClientCommand.d.ts +16 -0
  48. package/dist-types/commands/DeleteUserPoolCommand.d.ts +16 -0
  49. package/dist-types/commands/DeleteUserPoolDomainCommand.d.ts +16 -0
  50. package/dist-types/commands/DescribeIdentityProviderCommand.d.ts +16 -0
  51. package/dist-types/commands/DescribeResourceServerCommand.d.ts +16 -0
  52. package/dist-types/commands/DescribeRiskConfigurationCommand.d.ts +16 -0
  53. package/dist-types/commands/DescribeUserImportJobCommand.d.ts +16 -0
  54. package/dist-types/commands/DescribeUserPoolClientCommand.d.ts +16 -0
  55. package/dist-types/commands/DescribeUserPoolCommand.d.ts +16 -0
  56. package/dist-types/commands/DescribeUserPoolDomainCommand.d.ts +16 -0
  57. package/dist-types/commands/ForgetDeviceCommand.d.ts +16 -0
  58. package/dist-types/commands/ForgotPasswordCommand.d.ts +16 -0
  59. package/dist-types/commands/GetCSVHeaderCommand.d.ts +16 -0
  60. package/dist-types/commands/GetDeviceCommand.d.ts +16 -0
  61. package/dist-types/commands/GetGroupCommand.d.ts +16 -0
  62. package/dist-types/commands/GetIdentityProviderByIdentifierCommand.d.ts +16 -0
  63. package/dist-types/commands/GetSigningCertificateCommand.d.ts +16 -0
  64. package/dist-types/commands/GetUICustomizationCommand.d.ts +16 -0
  65. package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +16 -0
  66. package/dist-types/commands/GetUserCommand.d.ts +16 -0
  67. package/dist-types/commands/GetUserPoolMfaConfigCommand.d.ts +16 -0
  68. package/dist-types/commands/GlobalSignOutCommand.d.ts +16 -0
  69. package/dist-types/commands/InitiateAuthCommand.d.ts +16 -0
  70. package/dist-types/commands/ListDevicesCommand.d.ts +16 -0
  71. package/dist-types/commands/ListGroupsCommand.d.ts +16 -0
  72. package/dist-types/commands/ListIdentityProvidersCommand.d.ts +16 -0
  73. package/dist-types/commands/ListResourceServersCommand.d.ts +16 -0
  74. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  75. package/dist-types/commands/ListUserImportJobsCommand.d.ts +16 -0
  76. package/dist-types/commands/ListUserPoolClientsCommand.d.ts +16 -0
  77. package/dist-types/commands/ListUserPoolsCommand.d.ts +16 -0
  78. package/dist-types/commands/ListUsersCommand.d.ts +16 -0
  79. package/dist-types/commands/ListUsersInGroupCommand.d.ts +16 -0
  80. package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +16 -0
  81. package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +16 -0
  82. package/dist-types/commands/RevokeTokenCommand.d.ts +16 -0
  83. package/dist-types/commands/SetRiskConfigurationCommand.d.ts +16 -0
  84. package/dist-types/commands/SetUICustomizationCommand.d.ts +16 -0
  85. package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +16 -0
  86. package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +16 -0
  87. package/dist-types/commands/SetUserSettingsCommand.d.ts +16 -0
  88. package/dist-types/commands/SignUpCommand.d.ts +16 -0
  89. package/dist-types/commands/StartUserImportJobCommand.d.ts +16 -0
  90. package/dist-types/commands/StopUserImportJobCommand.d.ts +16 -0
  91. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  92. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  93. package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts +16 -0
  94. package/dist-types/commands/UpdateDeviceStatusCommand.d.ts +16 -0
  95. package/dist-types/commands/UpdateGroupCommand.d.ts +16 -0
  96. package/dist-types/commands/UpdateIdentityProviderCommand.d.ts +16 -0
  97. package/dist-types/commands/UpdateResourceServerCommand.d.ts +16 -0
  98. package/dist-types/commands/UpdateUserAttributesCommand.d.ts +16 -0
  99. package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +16 -0
  100. package/dist-types/commands/UpdateUserPoolCommand.d.ts +16 -0
  101. package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts +16 -0
  102. package/dist-types/commands/VerifySoftwareTokenCommand.d.ts +16 -0
  103. package/dist-types/commands/VerifyUserAttributeCommand.d.ts +16 -0
  104. package/dist-types/models/CognitoIdentityProviderServiceException.d.ts +2 -0
  105. package/dist-types/models/models_0.d.ts +507 -1
  106. package/dist-types/models/models_1.d.ts +64 -0
  107. package/dist-types/pagination/AdminListGroupsForUserPaginator.d.ts +3 -0
  108. package/dist-types/pagination/AdminListUserAuthEventsPaginator.d.ts +3 -0
  109. package/dist-types/pagination/Interfaces.d.ts +3 -0
  110. package/dist-types/pagination/ListGroupsPaginator.d.ts +3 -0
  111. package/dist-types/pagination/ListIdentityProvidersPaginator.d.ts +3 -0
  112. package/dist-types/pagination/ListResourceServersPaginator.d.ts +3 -0
  113. package/dist-types/pagination/ListUserPoolClientsPaginator.d.ts +3 -0
  114. package/dist-types/pagination/ListUserPoolsPaginator.d.ts +3 -0
  115. package/dist-types/pagination/ListUsersInGroupPaginator.d.ts +3 -0
  116. package/dist-types/pagination/ListUsersPaginator.d.ts +3 -0
  117. package/package.json +29 -29
@@ -1,11 +1,15 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { CognitoIdentityProviderServiceException as __BaseException } from "./CognitoIdentityProviderServiceException";
3
+ /**
4
+ * @public
5
+ */
3
6
  export declare enum RecoveryOptionNameType {
4
7
  ADMIN_ONLY = "admin_only",
5
8
  VERIFIED_EMAIL = "verified_email",
6
9
  VERIFIED_PHONE_NUMBER = "verified_phone_number"
7
10
  }
8
11
  /**
12
+ * @public
9
13
  * <p>A map containing a priority as a key, and recovery method name as a value.</p>
10
14
  */
11
15
  export interface RecoveryOptionType {
@@ -20,6 +24,7 @@ export interface RecoveryOptionType {
20
24
  Name: RecoveryOptionNameType | string | undefined;
21
25
  }
22
26
  /**
27
+ * @public
23
28
  * <p>The data type for <code>AccountRecoverySetting</code>.</p>
24
29
  */
25
30
  export interface AccountRecoverySettingType {
@@ -28,6 +33,9 @@ export interface AccountRecoverySettingType {
28
33
  */
29
34
  RecoveryMechanisms?: RecoveryOptionType[];
30
35
  }
36
+ /**
37
+ * @public
38
+ */
31
39
  export declare enum AccountTakeoverEventActionType {
32
40
  BLOCK = "BLOCK",
33
41
  MFA_IF_CONFIGURED = "MFA_IF_CONFIGURED",
@@ -35,6 +43,7 @@ export declare enum AccountTakeoverEventActionType {
35
43
  NO_ACTION = "NO_ACTION"
36
44
  }
37
45
  /**
46
+ * @public
38
47
  * <p>Account takeover action type.</p>
39
48
  */
40
49
  export interface AccountTakeoverActionType {
@@ -69,6 +78,7 @@ export interface AccountTakeoverActionType {
69
78
  EventAction: AccountTakeoverEventActionType | string | undefined;
70
79
  }
71
80
  /**
81
+ * @public
72
82
  * <p>Account takeover actions type.</p>
73
83
  */
74
84
  export interface AccountTakeoverActionsType {
@@ -86,6 +96,7 @@ export interface AccountTakeoverActionsType {
86
96
  HighAction?: AccountTakeoverActionType;
87
97
  }
88
98
  /**
99
+ * @public
89
100
  * <p>The notify email type.</p>
90
101
  */
91
102
  export interface NotifyEmailType {
@@ -103,6 +114,7 @@ export interface NotifyEmailType {
103
114
  TextBody?: string;
104
115
  }
105
116
  /**
117
+ * @public
106
118
  * <p>The notify configuration type.</p>
107
119
  */
108
120
  export interface NotifyConfigurationType {
@@ -136,6 +148,7 @@ export interface NotifyConfigurationType {
136
148
  MfaEmail?: NotifyEmailType;
137
149
  }
138
150
  /**
151
+ * @public
139
152
  * <p>Configuration for mitigation actions and notification for different levels of risk
140
153
  * detected for a potential account takeover.</p>
141
154
  */
@@ -149,6 +162,9 @@ export interface AccountTakeoverRiskConfigurationType {
149
162
  */
150
163
  Actions: AccountTakeoverActionsType | undefined;
151
164
  }
165
+ /**
166
+ * @public
167
+ */
152
168
  export declare enum AttributeDataType {
153
169
  BOOLEAN = "Boolean",
154
170
  DATETIME = "DateTime",
@@ -156,6 +172,7 @@ export declare enum AttributeDataType {
156
172
  STRING = "String"
157
173
  }
158
174
  /**
175
+ * @public
159
176
  * <p>The minimum and maximum values of an attribute that is of the number data type.</p>
160
177
  */
161
178
  export interface NumberAttributeConstraintsType {
@@ -169,6 +186,7 @@ export interface NumberAttributeConstraintsType {
169
186
  MaxValue?: string;
170
187
  }
171
188
  /**
189
+ * @public
172
190
  * <p>The constraints associated with a string attribute.</p>
173
191
  */
174
192
  export interface StringAttributeConstraintsType {
@@ -182,6 +200,7 @@ export interface StringAttributeConstraintsType {
182
200
  MaxLength?: string;
183
201
  }
184
202
  /**
203
+ * @public
185
204
  * <p>Contains information about the schema attribute.</p>
186
205
  */
187
206
  export interface SchemaAttributeType {
@@ -229,6 +248,7 @@ export interface SchemaAttributeType {
229
248
  StringAttributeConstraints?: StringAttributeConstraintsType;
230
249
  }
231
250
  /**
251
+ * @public
232
252
  * <p>Represents the request to add custom attributes.</p>
233
253
  */
234
254
  export interface AddCustomAttributesRequest {
@@ -242,12 +262,14 @@ export interface AddCustomAttributesRequest {
242
262
  CustomAttributes: SchemaAttributeType[] | undefined;
243
263
  }
244
264
  /**
265
+ * @public
245
266
  * <p>Represents the response from the server for the request to add custom
246
267
  * attributes.</p>
247
268
  */
248
269
  export interface AddCustomAttributesResponse {
249
270
  }
250
271
  /**
272
+ * @public
251
273
  * <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
252
274
  */
253
275
  export declare class InternalErrorException extends __BaseException {
@@ -259,6 +281,7 @@ export declare class InternalErrorException extends __BaseException {
259
281
  constructor(opts: __ExceptionOptionType<InternalErrorException, __BaseException>);
260
282
  }
261
283
  /**
284
+ * @public
262
285
  * <p>This exception is thrown when the Amazon Cognito service encounters an invalid
263
286
  * parameter.</p>
264
287
  */
@@ -271,6 +294,7 @@ export declare class InvalidParameterException extends __BaseException {
271
294
  constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
272
295
  }
273
296
  /**
297
+ * @public
274
298
  * <p>This exception is thrown when a user isn't authorized.</p>
275
299
  */
276
300
  export declare class NotAuthorizedException extends __BaseException {
@@ -282,6 +306,7 @@ export declare class NotAuthorizedException extends __BaseException {
282
306
  constructor(opts: __ExceptionOptionType<NotAuthorizedException, __BaseException>);
283
307
  }
284
308
  /**
309
+ * @public
285
310
  * <p>This exception is thrown when the Amazon Cognito service can't find the requested
286
311
  * resource.</p>
287
312
  */
@@ -294,6 +319,7 @@ export declare class ResourceNotFoundException extends __BaseException {
294
319
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
295
320
  }
296
321
  /**
322
+ * @public
297
323
  * <p>This exception is thrown when the user has made too many requests for a given
298
324
  * operation.</p>
299
325
  */
@@ -306,6 +332,7 @@ export declare class TooManyRequestsException extends __BaseException {
306
332
  constructor(opts: __ExceptionOptionType<TooManyRequestsException, __BaseException>);
307
333
  }
308
334
  /**
335
+ * @public
309
336
  * <p>This exception is thrown when you're trying to modify a user pool while a user import
310
337
  * job is in progress for that pool.</p>
311
338
  */
@@ -317,6 +344,9 @@ export declare class UserImportInProgressException extends __BaseException {
317
344
  */
318
345
  constructor(opts: __ExceptionOptionType<UserImportInProgressException, __BaseException>);
319
346
  }
347
+ /**
348
+ * @public
349
+ */
320
350
  export interface AdminAddUserToGroupRequest {
321
351
  /**
322
352
  * <p>The user pool ID for the user pool.</p>
@@ -332,6 +362,7 @@ export interface AdminAddUserToGroupRequest {
332
362
  GroupName: string | undefined;
333
363
  }
334
364
  /**
365
+ * @public
335
366
  * <p>This exception is thrown when a user isn't found.</p>
336
367
  */
337
368
  export declare class UserNotFoundException extends __BaseException {
@@ -343,6 +374,7 @@ export declare class UserNotFoundException extends __BaseException {
343
374
  constructor(opts: __ExceptionOptionType<UserNotFoundException, __BaseException>);
344
375
  }
345
376
  /**
377
+ * @public
346
378
  * <p>Represents the request to confirm user registration.</p>
347
379
  */
348
380
  export interface AdminConfirmSignUpRequest {
@@ -392,12 +424,14 @@ export interface AdminConfirmSignUpRequest {
392
424
  ClientMetadata?: Record<string, string>;
393
425
  }
394
426
  /**
427
+ * @public
395
428
  * <p>Represents the response from the server for the request to confirm
396
429
  * registration.</p>
397
430
  */
398
431
  export interface AdminConfirmSignUpResponse {
399
432
  }
400
433
  /**
434
+ * @public
401
435
  * <p>This exception is thrown when Amazon Cognito encounters an invalid Lambda response.</p>
402
436
  */
403
437
  export declare class InvalidLambdaResponseException extends __BaseException {
@@ -409,6 +443,7 @@ export declare class InvalidLambdaResponseException extends __BaseException {
409
443
  constructor(opts: __ExceptionOptionType<InvalidLambdaResponseException, __BaseException>);
410
444
  }
411
445
  /**
446
+ * @public
412
447
  * <p>This exception is thrown when a user exceeds the limit for a requested Amazon Web Services
413
448
  * resource.</p>
414
449
  */
@@ -421,6 +456,7 @@ export declare class LimitExceededException extends __BaseException {
421
456
  constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
422
457
  }
423
458
  /**
459
+ * @public
424
460
  * <p>This exception is thrown when the user has made too many failed attempts for a given
425
461
  * action, such as sign-in.</p>
426
462
  */
@@ -433,6 +469,7 @@ export declare class TooManyFailedAttemptsException extends __BaseException {
433
469
  constructor(opts: __ExceptionOptionType<TooManyFailedAttemptsException, __BaseException>);
434
470
  }
435
471
  /**
472
+ * @public
436
473
  * <p>This exception is thrown when Amazon Cognito encounters an unexpected exception with
437
474
  * Lambda.</p>
438
475
  */
@@ -445,6 +482,7 @@ export declare class UnexpectedLambdaException extends __BaseException {
445
482
  constructor(opts: __ExceptionOptionType<UnexpectedLambdaException, __BaseException>);
446
483
  }
447
484
  /**
485
+ * @public
448
486
  * <p>This exception is thrown when the Amazon Cognito service encounters a user validation exception
449
487
  * with the Lambda service.</p>
450
488
  */
@@ -456,15 +494,22 @@ export declare class UserLambdaValidationException extends __BaseException {
456
494
  */
457
495
  constructor(opts: __ExceptionOptionType<UserLambdaValidationException, __BaseException>);
458
496
  }
497
+ /**
498
+ * @public
499
+ */
459
500
  export declare enum DeliveryMediumType {
460
501
  EMAIL = "EMAIL",
461
502
  SMS = "SMS"
462
503
  }
504
+ /**
505
+ * @public
506
+ */
463
507
  export declare enum MessageActionType {
464
508
  RESEND = "RESEND",
465
509
  SUPPRESS = "SUPPRESS"
466
510
  }
467
511
  /**
512
+ * @public
468
513
  * <p>Specifies whether the attribute is standard or custom.</p>
469
514
  */
470
515
  export interface AttributeType {
@@ -478,6 +523,7 @@ export interface AttributeType {
478
523
  Value?: string;
479
524
  }
480
525
  /**
526
+ * @public
481
527
  * <p>Represents the request to create a user in the specified user pool.</p>
482
528
  */
483
529
  export interface AdminCreateUserRequest {
@@ -617,6 +663,7 @@ export interface AdminCreateUserRequest {
617
663
  ClientMetadata?: Record<string, string>;
618
664
  }
619
665
  /**
666
+ * @public
620
667
  * <p>
621
668
  * <i>This data type is no longer supported.</i> Applies only to SMS
622
669
  * multi-factor authentication (MFA) configurations. Does not apply to time-based one-time
@@ -634,6 +681,9 @@ export interface MFAOptionType {
634
681
  */
635
682
  AttributeName?: string;
636
683
  }
684
+ /**
685
+ * @public
686
+ */
637
687
  export declare enum UserStatusType {
638
688
  ARCHIVED = "ARCHIVED",
639
689
  COMPROMISED = "COMPROMISED",
@@ -644,6 +694,7 @@ export declare enum UserStatusType {
644
694
  UNKNOWN = "UNKNOWN"
645
695
  }
646
696
  /**
697
+ * @public
647
698
  * <p>A user profile in a Amazon Cognito user pool.</p>
648
699
  */
649
700
  export interface UserType {
@@ -703,6 +754,7 @@ export interface UserType {
703
754
  MFAOptions?: MFAOptionType[];
704
755
  }
705
756
  /**
757
+ * @public
706
758
  * <p>Represents the response from the server to the request to create the user.</p>
707
759
  */
708
760
  export interface AdminCreateUserResponse {
@@ -712,6 +764,7 @@ export interface AdminCreateUserResponse {
712
764
  User?: UserType;
713
765
  }
714
766
  /**
767
+ * @public
715
768
  * <p>This exception is thrown when a verification code fails to deliver
716
769
  * successfully.</p>
717
770
  */
@@ -724,6 +777,7 @@ export declare class CodeDeliveryFailureException extends __BaseException {
724
777
  constructor(opts: __ExceptionOptionType<CodeDeliveryFailureException, __BaseException>);
725
778
  }
726
779
  /**
780
+ * @public
727
781
  * <p>This exception is thrown when Amazon Cognito encounters an invalid password.</p>
728
782
  */
729
783
  export declare class InvalidPasswordException extends __BaseException {
@@ -735,6 +789,7 @@ export declare class InvalidPasswordException extends __BaseException {
735
789
  constructor(opts: __ExceptionOptionType<InvalidPasswordException, __BaseException>);
736
790
  }
737
791
  /**
792
+ * @public
738
793
  * <p>This exception is returned when the role provided for SMS configuration doesn't have
739
794
  * permission to publish using Amazon SNS.</p>
740
795
  */
@@ -747,6 +802,7 @@ export declare class InvalidSmsRoleAccessPolicyException extends __BaseException
747
802
  constructor(opts: __ExceptionOptionType<InvalidSmsRoleAccessPolicyException, __BaseException>);
748
803
  }
749
804
  /**
805
+ * @public
750
806
  * <p>This exception is thrown when the trust relationship is not valid for the role
751
807
  * provided for SMS configuration. This can happen if you don't trust
752
808
  * <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
@@ -761,6 +817,7 @@ export declare class InvalidSmsRoleTrustRelationshipException extends __BaseExce
761
817
  constructor(opts: __ExceptionOptionType<InvalidSmsRoleTrustRelationshipException, __BaseException>);
762
818
  }
763
819
  /**
820
+ * @public
764
821
  * <p>This exception is thrown when a precondition is not met.</p>
765
822
  */
766
823
  export declare class PreconditionNotMetException extends __BaseException {
@@ -772,6 +829,7 @@ export declare class PreconditionNotMetException extends __BaseException {
772
829
  constructor(opts: __ExceptionOptionType<PreconditionNotMetException, __BaseException>);
773
830
  }
774
831
  /**
832
+ * @public
775
833
  * <p>The request failed because the user is in an unsupported state.</p>
776
834
  */
777
835
  export declare class UnsupportedUserStateException extends __BaseException {
@@ -783,6 +841,7 @@ export declare class UnsupportedUserStateException extends __BaseException {
783
841
  constructor(opts: __ExceptionOptionType<UnsupportedUserStateException, __BaseException>);
784
842
  }
785
843
  /**
844
+ * @public
786
845
  * <p>This exception is thrown when Amazon Cognito encounters a user name that already
787
846
  * exists in the user pool.</p>
788
847
  */
@@ -795,6 +854,7 @@ export declare class UsernameExistsException extends __BaseException {
795
854
  constructor(opts: __ExceptionOptionType<UsernameExistsException, __BaseException>);
796
855
  }
797
856
  /**
857
+ * @public
798
858
  * <p>The message template structure.</p>
799
859
  */
800
860
  export interface MessageTemplateType {
@@ -812,6 +872,7 @@ export interface MessageTemplateType {
812
872
  EmailSubject?: string;
813
873
  }
814
874
  /**
875
+ * @public
815
876
  * <p>The configuration for creating a new user profile.</p>
816
877
  */
817
878
  export interface AdminCreateUserConfigType {
@@ -840,6 +901,7 @@ export interface AdminCreateUserConfigType {
840
901
  InviteMessageTemplate?: MessageTemplateType;
841
902
  }
842
903
  /**
904
+ * @public
843
905
  * <p>Represents the request to delete a user as an administrator.</p>
844
906
  */
845
907
  export interface AdminDeleteUserRequest {
@@ -853,6 +915,7 @@ export interface AdminDeleteUserRequest {
853
915
  Username: string | undefined;
854
916
  }
855
917
  /**
918
+ * @public
856
919
  * <p>Represents the request to delete user attributes as an administrator.</p>
857
920
  */
858
921
  export interface AdminDeleteUserAttributesRequest {
@@ -872,12 +935,14 @@ export interface AdminDeleteUserAttributesRequest {
872
935
  UserAttributeNames: string[] | undefined;
873
936
  }
874
937
  /**
938
+ * @public
875
939
  * <p>Represents the response received from the server for a request to delete user
876
940
  * attributes.</p>
877
941
  */
878
942
  export interface AdminDeleteUserAttributesResponse {
879
943
  }
880
944
  /**
945
+ * @public
881
946
  * <p>A container for information about an IdP for a user pool.</p>
882
947
  */
883
948
  export interface ProviderUserIdentifierType {
@@ -895,6 +960,9 @@ export interface ProviderUserIdentifierType {
895
960
  */
896
961
  ProviderAttributeValue?: string;
897
962
  }
963
+ /**
964
+ * @public
965
+ */
898
966
  export interface AdminDisableProviderForUserRequest {
899
967
  /**
900
968
  * <p>The user pool ID for the user pool.</p>
@@ -905,9 +973,13 @@ export interface AdminDisableProviderForUserRequest {
905
973
  */
906
974
  User: ProviderUserIdentifierType | undefined;
907
975
  }
976
+ /**
977
+ * @public
978
+ */
908
979
  export interface AdminDisableProviderForUserResponse {
909
980
  }
910
981
  /**
982
+ * @public
911
983
  * <p>This exception is thrown when a user tries to confirm the account with an email
912
984
  * address or phone number that has already been supplied as an alias for a different
913
985
  * user profile. This exception indicates that an account with this email address or phone
@@ -923,6 +995,7 @@ export declare class AliasExistsException extends __BaseException {
923
995
  constructor(opts: __ExceptionOptionType<AliasExistsException, __BaseException>);
924
996
  }
925
997
  /**
998
+ * @public
926
999
  * <p>Represents the request to disable the user as an administrator.</p>
927
1000
  */
928
1001
  export interface AdminDisableUserRequest {
@@ -936,12 +1009,14 @@ export interface AdminDisableUserRequest {
936
1009
  Username: string | undefined;
937
1010
  }
938
1011
  /**
1012
+ * @public
939
1013
  * <p>Represents the response received from the server to disable the user as an
940
1014
  * administrator.</p>
941
1015
  */
942
1016
  export interface AdminDisableUserResponse {
943
1017
  }
944
1018
  /**
1019
+ * @public
945
1020
  * <p>Represents the request that enables the user as an administrator.</p>
946
1021
  */
947
1022
  export interface AdminEnableUserRequest {
@@ -955,12 +1030,14 @@ export interface AdminEnableUserRequest {
955
1030
  Username: string | undefined;
956
1031
  }
957
1032
  /**
1033
+ * @public
958
1034
  * <p>Represents the response from the server for the request to enable a user as an
959
1035
  * administrator.</p>
960
1036
  */
961
1037
  export interface AdminEnableUserResponse {
962
1038
  }
963
1039
  /**
1040
+ * @public
964
1041
  * <p>Sends the forgot device request, as an administrator.</p>
965
1042
  */
966
1043
  export interface AdminForgetDeviceRequest {
@@ -978,6 +1055,7 @@ export interface AdminForgetDeviceRequest {
978
1055
  DeviceKey: string | undefined;
979
1056
  }
980
1057
  /**
1058
+ * @public
981
1059
  * <p>This exception is thrown when the user pool configuration is not valid.</p>
982
1060
  */
983
1061
  export declare class InvalidUserPoolConfigurationException extends __BaseException {
@@ -989,6 +1067,7 @@ export declare class InvalidUserPoolConfigurationException extends __BaseExcepti
989
1067
  constructor(opts: __ExceptionOptionType<InvalidUserPoolConfigurationException, __BaseException>);
990
1068
  }
991
1069
  /**
1070
+ * @public
992
1071
  * <p>Represents the request to get the device, as an administrator.</p>
993
1072
  */
994
1073
  export interface AdminGetDeviceRequest {
@@ -1006,6 +1085,7 @@ export interface AdminGetDeviceRequest {
1006
1085
  Username: string | undefined;
1007
1086
  }
1008
1087
  /**
1088
+ * @public
1009
1089
  * <p>The device type.</p>
1010
1090
  */
1011
1091
  export interface DeviceType {
@@ -1031,6 +1111,7 @@ export interface DeviceType {
1031
1111
  DeviceLastAuthenticatedDate?: Date;
1032
1112
  }
1033
1113
  /**
1114
+ * @public
1034
1115
  * <p>Gets the device response, as an administrator.</p>
1035
1116
  */
1036
1117
  export interface AdminGetDeviceResponse {
@@ -1040,6 +1121,7 @@ export interface AdminGetDeviceResponse {
1040
1121
  Device: DeviceType | undefined;
1041
1122
  }
1042
1123
  /**
1124
+ * @public
1043
1125
  * <p>Represents the request to get the specified user as an administrator.</p>
1044
1126
  */
1045
1127
  export interface AdminGetUserRequest {
@@ -1054,6 +1136,7 @@ export interface AdminGetUserRequest {
1054
1136
  Username: string | undefined;
1055
1137
  }
1056
1138
  /**
1139
+ * @public
1057
1140
  * <p>Represents the response from the server from the request to get the specified user as
1058
1141
  * an administrator.</p>
1059
1142
  */
@@ -1125,6 +1208,7 @@ export interface AdminGetUserResponse {
1125
1208
  UserMFASettingList?: string[];
1126
1209
  }
1127
1210
  /**
1211
+ * @public
1128
1212
  * <p>An Amazon Pinpoint analytics endpoint.</p>
1129
1213
  * <p>An endpoint uniquely identifies a mobile device, email address, or phone number that
1130
1214
  * can receive messages from Amazon Pinpoint analytics. For more information about Amazon Web Services Regions that
@@ -1136,6 +1220,9 @@ export interface AnalyticsMetadataType {
1136
1220
  */
1137
1221
  AnalyticsEndpointId?: string;
1138
1222
  }
1223
+ /**
1224
+ * @public
1225
+ */
1139
1226
  export declare enum AuthFlowType {
1140
1227
  ADMIN_NO_SRP_AUTH = "ADMIN_NO_SRP_AUTH",
1141
1228
  ADMIN_USER_PASSWORD_AUTH = "ADMIN_USER_PASSWORD_AUTH",
@@ -1146,6 +1233,7 @@ export declare enum AuthFlowType {
1146
1233
  USER_SRP_AUTH = "USER_SRP_AUTH"
1147
1234
  }
1148
1235
  /**
1236
+ * @public
1149
1237
  * <p>The HTTP header.</p>
1150
1238
  */
1151
1239
  export interface HttpHeader {
@@ -1159,6 +1247,7 @@ export interface HttpHeader {
1159
1247
  headerValue?: string;
1160
1248
  }
1161
1249
  /**
1250
+ * @public
1162
1251
  * <p>Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito
1163
1252
  * advanced security.</p>
1164
1253
  */
@@ -1186,6 +1275,7 @@ export interface ContextDataType {
1186
1275
  EncodedData?: string;
1187
1276
  }
1188
1277
  /**
1278
+ * @public
1189
1279
  * <p>Initiates the authorization request, as an administrator.</p>
1190
1280
  */
1191
1281
  export interface AdminInitiateAuthRequest {
@@ -1365,6 +1455,7 @@ export interface AdminInitiateAuthRequest {
1365
1455
  ContextData?: ContextDataType;
1366
1456
  }
1367
1457
  /**
1458
+ * @public
1368
1459
  * <p>The new device metadata type.</p>
1369
1460
  */
1370
1461
  export interface NewDeviceMetadataType {
@@ -1378,6 +1469,7 @@ export interface NewDeviceMetadataType {
1378
1469
  DeviceGroupKey?: string;
1379
1470
  }
1380
1471
  /**
1472
+ * @public
1381
1473
  * <p>The authentication result.</p>
1382
1474
  */
1383
1475
  export interface AuthenticationResultType {
@@ -1407,6 +1499,9 @@ export interface AuthenticationResultType {
1407
1499
  */
1408
1500
  NewDeviceMetadata?: NewDeviceMetadataType;
1409
1501
  }
1502
+ /**
1503
+ * @public
1504
+ */
1410
1505
  export declare enum ChallengeNameType {
1411
1506
  ADMIN_NO_SRP_AUTH = "ADMIN_NO_SRP_AUTH",
1412
1507
  CUSTOM_CHALLENGE = "CUSTOM_CHALLENGE",
@@ -1420,6 +1515,7 @@ export declare enum ChallengeNameType {
1420
1515
  SOFTWARE_TOKEN_MFA = "SOFTWARE_TOKEN_MFA"
1421
1516
  }
1422
1517
  /**
1518
+ * @public
1423
1519
  * <p>Initiates the authentication response, as an administrator.</p>
1424
1520
  */
1425
1521
  export interface AdminInitiateAuthResponse {
@@ -1540,6 +1636,7 @@ export interface AdminInitiateAuthResponse {
1540
1636
  AuthenticationResult?: AuthenticationResultType;
1541
1637
  }
1542
1638
  /**
1639
+ * @public
1543
1640
  * <p>This exception is thrown when Amazon Cognito can't find a multi-factor authentication
1544
1641
  * (MFA) method.</p>
1545
1642
  */
@@ -1552,6 +1649,7 @@ export declare class MFAMethodNotFoundException extends __BaseException {
1552
1649
  constructor(opts: __ExceptionOptionType<MFAMethodNotFoundException, __BaseException>);
1553
1650
  }
1554
1651
  /**
1652
+ * @public
1555
1653
  * <p>This exception is thrown when a password reset is required.</p>
1556
1654
  */
1557
1655
  export declare class PasswordResetRequiredException extends __BaseException {
@@ -1563,6 +1661,7 @@ export declare class PasswordResetRequiredException extends __BaseException {
1563
1661
  constructor(opts: __ExceptionOptionType<PasswordResetRequiredException, __BaseException>);
1564
1662
  }
1565
1663
  /**
1664
+ * @public
1566
1665
  * <p>This exception is thrown when a user isn't confirmed successfully.</p>
1567
1666
  */
1568
1667
  export declare class UserNotConfirmedException extends __BaseException {
@@ -1573,6 +1672,9 @@ export declare class UserNotConfirmedException extends __BaseException {
1573
1672
  */
1574
1673
  constructor(opts: __ExceptionOptionType<UserNotConfirmedException, __BaseException>);
1575
1674
  }
1675
+ /**
1676
+ * @public
1677
+ */
1576
1678
  export interface AdminLinkProviderForUserRequest {
1577
1679
  /**
1578
1680
  * <p>The user pool ID for the user pool.</p>
@@ -1622,9 +1724,13 @@ export interface AdminLinkProviderForUserRequest {
1622
1724
  */
1623
1725
  SourceUser: ProviderUserIdentifierType | undefined;
1624
1726
  }
1727
+ /**
1728
+ * @public
1729
+ */
1625
1730
  export interface AdminLinkProviderForUserResponse {
1626
1731
  }
1627
1732
  /**
1733
+ * @public
1628
1734
  * <p>Represents the request to list devices, as an administrator.</p>
1629
1735
  */
1630
1736
  export interface AdminListDevicesRequest {
@@ -1646,6 +1752,7 @@ export interface AdminListDevicesRequest {
1646
1752
  PaginationToken?: string;
1647
1753
  }
1648
1754
  /**
1755
+ * @public
1649
1756
  * <p>Lists the device's response, as an administrator.</p>
1650
1757
  */
1651
1758
  export interface AdminListDevicesResponse {
@@ -1658,6 +1765,9 @@ export interface AdminListDevicesResponse {
1658
1765
  */
1659
1766
  PaginationToken?: string;
1660
1767
  }
1768
+ /**
1769
+ * @public
1770
+ */
1661
1771
  export interface AdminListGroupsForUserRequest {
1662
1772
  /**
1663
1773
  * <p>The username for the user.</p>
@@ -1678,6 +1788,7 @@ export interface AdminListGroupsForUserRequest {
1678
1788
  NextToken?: string;
1679
1789
  }
1680
1790
  /**
1791
+ * @public
1681
1792
  * <p>The group type.</p>
1682
1793
  */
1683
1794
  export interface GroupType {
@@ -1723,6 +1834,9 @@ export interface GroupType {
1723
1834
  */
1724
1835
  CreationDate?: Date;
1725
1836
  }
1837
+ /**
1838
+ * @public
1839
+ */
1726
1840
  export interface AdminListGroupsForUserResponse {
1727
1841
  /**
1728
1842
  * <p>The groups that the user belongs to.</p>
@@ -1734,6 +1848,9 @@ export interface AdminListGroupsForUserResponse {
1734
1848
  */
1735
1849
  NextToken?: string;
1736
1850
  }
1851
+ /**
1852
+ * @public
1853
+ */
1737
1854
  export interface AdminListUserAuthEventsRequest {
1738
1855
  /**
1739
1856
  * <p>The user pool ID.</p>
@@ -1754,15 +1871,22 @@ export interface AdminListUserAuthEventsRequest {
1754
1871
  */
1755
1872
  NextToken?: string;
1756
1873
  }
1874
+ /**
1875
+ * @public
1876
+ */
1757
1877
  export declare enum ChallengeName {
1758
1878
  Mfa = "Mfa",
1759
1879
  Password = "Password"
1760
1880
  }
1881
+ /**
1882
+ * @public
1883
+ */
1761
1884
  export declare enum ChallengeResponse {
1762
1885
  Failure = "Failure",
1763
1886
  Success = "Success"
1764
1887
  }
1765
1888
  /**
1889
+ * @public
1766
1890
  * <p>The challenge response type.</p>
1767
1891
  */
1768
1892
  export interface ChallengeResponseType {
@@ -1776,6 +1900,7 @@ export interface ChallengeResponseType {
1776
1900
  ChallengeResponse?: ChallengeResponse | string;
1777
1901
  }
1778
1902
  /**
1903
+ * @public
1779
1904
  * <p>Specifies the user context data captured at the time of an event request.</p>
1780
1905
  */
1781
1906
  export interface EventContextDataType {
@@ -1800,11 +1925,15 @@ export interface EventContextDataType {
1800
1925
  */
1801
1926
  Country?: string;
1802
1927
  }
1928
+ /**
1929
+ * @public
1930
+ */
1803
1931
  export declare enum FeedbackValueType {
1804
1932
  INVALID = "Invalid",
1805
1933
  VALID = "Valid"
1806
1934
  }
1807
1935
  /**
1936
+ * @public
1808
1937
  * <p>Specifies the event feedback type.</p>
1809
1938
  */
1810
1939
  export interface EventFeedbackType {
@@ -1821,22 +1950,32 @@ export interface EventFeedbackType {
1821
1950
  */
1822
1951
  FeedbackDate?: Date;
1823
1952
  }
1953
+ /**
1954
+ * @public
1955
+ */
1824
1956
  export declare enum EventResponseType {
1825
1957
  Fail = "Fail",
1826
1958
  InProgress = "InProgress",
1827
1959
  Pass = "Pass"
1828
1960
  }
1961
+ /**
1962
+ * @public
1963
+ */
1829
1964
  export declare enum RiskDecisionType {
1830
1965
  AccountTakeover = "AccountTakeover",
1831
1966
  Block = "Block",
1832
1967
  NoRisk = "NoRisk"
1833
1968
  }
1969
+ /**
1970
+ * @public
1971
+ */
1834
1972
  export declare enum RiskLevelType {
1835
1973
  High = "High",
1836
1974
  Low = "Low",
1837
1975
  Medium = "Medium"
1838
1976
  }
1839
1977
  /**
1978
+ * @public
1840
1979
  * <p>The event risk type.</p>
1841
1980
  */
1842
1981
  export interface EventRiskType {
@@ -1854,6 +1993,9 @@ export interface EventRiskType {
1854
1993
  */
1855
1994
  CompromisedCredentialsDetected?: boolean;
1856
1995
  }
1996
+ /**
1997
+ * @public
1998
+ */
1857
1999
  export declare enum EventType {
1858
2000
  ForgotPassword = "ForgotPassword",
1859
2001
  PasswordChange = "PasswordChange",
@@ -1862,6 +2004,7 @@ export declare enum EventType {
1862
2004
  SignUp = "SignUp"
1863
2005
  }
1864
2006
  /**
2007
+ * @public
1865
2008
  * <p>The authentication event type.</p>
1866
2009
  */
1867
2010
  export interface AuthEventType {
@@ -1900,6 +2043,9 @@ export interface AuthEventType {
1900
2043
  */
1901
2044
  EventFeedback?: EventFeedbackType;
1902
2045
  }
2046
+ /**
2047
+ * @public
2048
+ */
1903
2049
  export interface AdminListUserAuthEventsResponse {
1904
2050
  /**
1905
2051
  * <p>The response object. It includes the <code>EventID</code>, <code>EventType</code>,
@@ -1913,6 +2059,7 @@ export interface AdminListUserAuthEventsResponse {
1913
2059
  NextToken?: string;
1914
2060
  }
1915
2061
  /**
2062
+ * @public
1916
2063
  * <p>This exception is thrown when user pool add-ons aren't enabled.</p>
1917
2064
  */
1918
2065
  export declare class UserPoolAddOnNotEnabledException extends __BaseException {
@@ -1923,6 +2070,9 @@ export declare class UserPoolAddOnNotEnabledException extends __BaseException {
1923
2070
  */
1924
2071
  constructor(opts: __ExceptionOptionType<UserPoolAddOnNotEnabledException, __BaseException>);
1925
2072
  }
2073
+ /**
2074
+ * @public
2075
+ */
1926
2076
  export interface AdminRemoveUserFromGroupRequest {
1927
2077
  /**
1928
2078
  * <p>The user pool ID for the user pool.</p>
@@ -1938,6 +2088,7 @@ export interface AdminRemoveUserFromGroupRequest {
1938
2088
  GroupName: string | undefined;
1939
2089
  }
1940
2090
  /**
2091
+ * @public
1941
2092
  * <p>Represents the request to reset a user's password as an administrator.</p>
1942
2093
  */
1943
2094
  export interface AdminResetUserPasswordRequest {
@@ -1987,12 +2138,14 @@ export interface AdminResetUserPasswordRequest {
1987
2138
  ClientMetadata?: Record<string, string>;
1988
2139
  }
1989
2140
  /**
2141
+ * @public
1990
2142
  * <p>Represents the response from the server to reset a user password as an
1991
2143
  * administrator.</p>
1992
2144
  */
1993
2145
  export interface AdminResetUserPasswordResponse {
1994
2146
  }
1995
2147
  /**
2148
+ * @public
1996
2149
  * <p>This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP
1997
2150
  * status code: 400.</p>
1998
2151
  */
@@ -2005,6 +2158,7 @@ export declare class InvalidEmailRoleAccessPolicyException extends __BaseExcepti
2005
2158
  constructor(opts: __ExceptionOptionType<InvalidEmailRoleAccessPolicyException, __BaseException>);
2006
2159
  }
2007
2160
  /**
2161
+ * @public
2008
2162
  * <p>The request to respond to the authentication challenge, as an administrator.</p>
2009
2163
  */
2010
2164
  export interface AdminRespondToAuthChallengeRequest {
@@ -2164,6 +2318,7 @@ export interface AdminRespondToAuthChallengeRequest {
2164
2318
  ClientMetadata?: Record<string, string>;
2165
2319
  }
2166
2320
  /**
2321
+ * @public
2167
2322
  * <p>Responds to the authentication challenge, as an administrator.</p>
2168
2323
  */
2169
2324
  export interface AdminRespondToAuthChallengeResponse {
@@ -2188,6 +2343,7 @@ export interface AdminRespondToAuthChallengeResponse {
2188
2343
  AuthenticationResult?: AuthenticationResultType;
2189
2344
  }
2190
2345
  /**
2346
+ * @public
2191
2347
  * <p>This exception is thrown if the provided code doesn't match what the server was
2192
2348
  * expecting.</p>
2193
2349
  */
@@ -2200,6 +2356,7 @@ export declare class CodeMismatchException extends __BaseException {
2200
2356
  constructor(opts: __ExceptionOptionType<CodeMismatchException, __BaseException>);
2201
2357
  }
2202
2358
  /**
2359
+ * @public
2203
2360
  * <p>This exception is thrown if a code has expired.</p>
2204
2361
  */
2205
2362
  export declare class ExpiredCodeException extends __BaseException {
@@ -2211,6 +2368,7 @@ export declare class ExpiredCodeException extends __BaseException {
2211
2368
  constructor(opts: __ExceptionOptionType<ExpiredCodeException, __BaseException>);
2212
2369
  }
2213
2370
  /**
2371
+ * @public
2214
2372
  * <p>This exception is thrown when the software token time-based one-time password (TOTP)
2215
2373
  * multi-factor authentication (MFA) isn't activated for the user pool.</p>
2216
2374
  */
@@ -2223,6 +2381,7 @@ export declare class SoftwareTokenMFANotFoundException extends __BaseException {
2223
2381
  constructor(opts: __ExceptionOptionType<SoftwareTokenMFANotFoundException, __BaseException>);
2224
2382
  }
2225
2383
  /**
2384
+ * @public
2226
2385
  * <p>The type used for enabling SMS multi-factor authentication (MFA) at the user level.
2227
2386
  * Phone numbers don't need to be verified to be used for SMS MFA. If an MFA type is
2228
2387
  * activated for a user, the user will be prompted for MFA during all sign-in attempts,
@@ -2243,6 +2402,7 @@ export interface SMSMfaSettingsType {
2243
2402
  PreferredMfa?: boolean;
2244
2403
  }
2245
2404
  /**
2405
+ * @public
2246
2406
  * <p>The type used for enabling software token MFA at the user level. If an MFA type is
2247
2407
  * activated for a user, the user will be prompted for MFA during all sign-in attempts,
2248
2408
  * unless device tracking is turned on and the device has been trusted. If you want MFA to
@@ -2261,6 +2421,9 @@ export interface SoftwareTokenMfaSettingsType {
2261
2421
  */
2262
2422
  PreferredMfa?: boolean;
2263
2423
  }
2424
+ /**
2425
+ * @public
2426
+ */
2264
2427
  export interface AdminSetUserMFAPreferenceRequest {
2265
2428
  /**
2266
2429
  * <p>The SMS text message MFA settings.</p>
@@ -2279,8 +2442,14 @@ export interface AdminSetUserMFAPreferenceRequest {
2279
2442
  */
2280
2443
  UserPoolId: string | undefined;
2281
2444
  }
2445
+ /**
2446
+ * @public
2447
+ */
2282
2448
  export interface AdminSetUserMFAPreferenceResponse {
2283
2449
  }
2450
+ /**
2451
+ * @public
2452
+ */
2284
2453
  export interface AdminSetUserPasswordRequest {
2285
2454
  /**
2286
2455
  * <p>The user pool ID for the user pool where you want to set the user's password.</p>
@@ -2301,9 +2470,13 @@ export interface AdminSetUserPasswordRequest {
2301
2470
  */
2302
2471
  Permanent?: boolean;
2303
2472
  }
2473
+ /**
2474
+ * @public
2475
+ */
2304
2476
  export interface AdminSetUserPasswordResponse {
2305
2477
  }
2306
2478
  /**
2479
+ * @public
2307
2480
  * <p>You can use this parameter to set an MFA configuration that uses the SMS delivery
2308
2481
  * medium.</p>
2309
2482
  */
@@ -2323,11 +2496,15 @@ export interface AdminSetUserSettingsRequest {
2323
2496
  MFAOptions: MFAOptionType[] | undefined;
2324
2497
  }
2325
2498
  /**
2499
+ * @public
2326
2500
  * <p>Represents the response from the server to set user settings as an
2327
2501
  * administrator.</p>
2328
2502
  */
2329
2503
  export interface AdminSetUserSettingsResponse {
2330
2504
  }
2505
+ /**
2506
+ * @public
2507
+ */
2331
2508
  export interface AdminUpdateAuthEventFeedbackRequest {
2332
2509
  /**
2333
2510
  * <p>The user pool ID.</p>
@@ -2346,13 +2523,20 @@ export interface AdminUpdateAuthEventFeedbackRequest {
2346
2523
  */
2347
2524
  FeedbackValue: FeedbackValueType | string | undefined;
2348
2525
  }
2526
+ /**
2527
+ * @public
2528
+ */
2349
2529
  export interface AdminUpdateAuthEventFeedbackResponse {
2350
2530
  }
2531
+ /**
2532
+ * @public
2533
+ */
2351
2534
  export declare enum DeviceRememberedStatusType {
2352
2535
  NOT_REMEMBERED = "not_remembered",
2353
2536
  REMEMBERED = "remembered"
2354
2537
  }
2355
2538
  /**
2539
+ * @public
2356
2540
  * <p>The request to update the device status, as an administrator.</p>
2357
2541
  */
2358
2542
  export interface AdminUpdateDeviceStatusRequest {
@@ -2374,11 +2558,13 @@ export interface AdminUpdateDeviceStatusRequest {
2374
2558
  DeviceRememberedStatus?: DeviceRememberedStatusType | string;
2375
2559
  }
2376
2560
  /**
2561
+ * @public
2377
2562
  * <p>The status response to the request to update the device, as an administrator.</p>
2378
2563
  */
2379
2564
  export interface AdminUpdateDeviceStatusResponse {
2380
2565
  }
2381
2566
  /**
2567
+ * @public
2382
2568
  * <p>Represents the request to update the user's attributes as an administrator.</p>
2383
2569
  */
2384
2570
  export interface AdminUpdateUserAttributesRequest {
@@ -2446,12 +2632,14 @@ export interface AdminUpdateUserAttributesRequest {
2446
2632
  ClientMetadata?: Record<string, string>;
2447
2633
  }
2448
2634
  /**
2635
+ * @public
2449
2636
  * <p>Represents the response from the server for the request to update user attributes as
2450
2637
  * an administrator.</p>
2451
2638
  */
2452
2639
  export interface AdminUpdateUserAttributesResponse {
2453
2640
  }
2454
2641
  /**
2642
+ * @public
2455
2643
  * <p>The request to sign out of all devices, as an administrator.</p>
2456
2644
  */
2457
2645
  export interface AdminUserGlobalSignOutRequest {
@@ -2465,21 +2653,29 @@ export interface AdminUserGlobalSignOutRequest {
2465
2653
  Username: string | undefined;
2466
2654
  }
2467
2655
  /**
2656
+ * @public
2468
2657
  * <p>The global sign-out response, as an administrator.</p>
2469
2658
  */
2470
2659
  export interface AdminUserGlobalSignOutResponse {
2471
2660
  }
2661
+ /**
2662
+ * @public
2663
+ */
2472
2664
  export declare enum AdvancedSecurityModeType {
2473
2665
  AUDIT = "AUDIT",
2474
2666
  ENFORCED = "ENFORCED",
2475
2667
  OFF = "OFF"
2476
2668
  }
2669
+ /**
2670
+ * @public
2671
+ */
2477
2672
  export declare enum AliasAttributeType {
2478
2673
  EMAIL = "email",
2479
2674
  PHONE_NUMBER = "phone_number",
2480
2675
  PREFERRED_USERNAME = "preferred_username"
2481
2676
  }
2482
2677
  /**
2678
+ * @public
2483
2679
  * <p>The Amazon Pinpoint analytics configuration necessary to collect metrics for a user
2484
2680
  * pool.</p>
2485
2681
  * <note>
@@ -2514,6 +2710,9 @@ export interface AnalyticsConfigurationType {
2514
2710
  */
2515
2711
  UserDataShared?: boolean;
2516
2712
  }
2713
+ /**
2714
+ * @public
2715
+ */
2517
2716
  export interface AssociateSoftwareTokenRequest {
2518
2717
  /**
2519
2718
  * <p>A valid access token that Amazon Cognito issued to the user whose software token you want to
@@ -2526,6 +2725,9 @@ export interface AssociateSoftwareTokenRequest {
2526
2725
  */
2527
2726
  Session?: string;
2528
2727
  }
2728
+ /**
2729
+ * @public
2730
+ */
2529
2731
  export interface AssociateSoftwareTokenResponse {
2530
2732
  /**
2531
2733
  * <p>A unique generated shared secret code that is used in the
@@ -2539,6 +2741,7 @@ export interface AssociateSoftwareTokenResponse {
2539
2741
  Session?: string;
2540
2742
  }
2541
2743
  /**
2744
+ * @public
2542
2745
  * <p>This exception is thrown if two or more modifications are happening
2543
2746
  * concurrently.</p>
2544
2747
  */
@@ -2551,6 +2754,7 @@ export declare class ConcurrentModificationException extends __BaseException {
2551
2754
  constructor(opts: __ExceptionOptionType<ConcurrentModificationException, __BaseException>);
2552
2755
  }
2553
2756
  /**
2757
+ * @public
2554
2758
  * <p>This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.</p>
2555
2759
  */
2556
2760
  export declare class ForbiddenException extends __BaseException {
@@ -2561,11 +2765,15 @@ export declare class ForbiddenException extends __BaseException {
2561
2765
  */
2562
2766
  constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
2563
2767
  }
2768
+ /**
2769
+ * @public
2770
+ */
2564
2771
  export declare enum VerifiedAttributeType {
2565
2772
  EMAIL = "email",
2566
2773
  PHONE_NUMBER = "phone_number"
2567
2774
  }
2568
2775
  /**
2776
+ * @public
2569
2777
  * <p>Represents the request to change a user password.</p>
2570
2778
  */
2571
2779
  export interface ChangePasswordRequest {
@@ -2584,11 +2792,13 @@ export interface ChangePasswordRequest {
2584
2792
  AccessToken: string | undefined;
2585
2793
  }
2586
2794
  /**
2795
+ * @public
2587
2796
  * <p>The response from the server to the change password request.</p>
2588
2797
  */
2589
2798
  export interface ChangePasswordResponse {
2590
2799
  }
2591
2800
  /**
2801
+ * @public
2592
2802
  * <p>The device verifier against which it is authenticated.</p>
2593
2803
  */
2594
2804
  export interface DeviceSecretVerifierConfigType {
@@ -2603,6 +2813,7 @@ export interface DeviceSecretVerifierConfigType {
2603
2813
  Salt?: string;
2604
2814
  }
2605
2815
  /**
2816
+ * @public
2606
2817
  * <p>Confirms the device request.</p>
2607
2818
  */
2608
2819
  export interface ConfirmDeviceRequest {
@@ -2625,6 +2836,7 @@ export interface ConfirmDeviceRequest {
2625
2836
  DeviceName?: string;
2626
2837
  }
2627
2838
  /**
2839
+ * @public
2628
2840
  * <p>Confirms the device response.</p>
2629
2841
  */
2630
2842
  export interface ConfirmDeviceResponse {
@@ -2634,6 +2846,7 @@ export interface ConfirmDeviceResponse {
2634
2846
  UserConfirmationNecessary?: boolean;
2635
2847
  }
2636
2848
  /**
2849
+ * @public
2637
2850
  * <p>Contextual data, such as the user's device fingerprint, IP address, or location, used
2638
2851
  * for evaluating the risk of an unexpected event by Amazon Cognito advanced
2639
2852
  * security.</p>
@@ -2650,6 +2863,7 @@ export interface UserContextDataType {
2650
2863
  EncodedData?: string;
2651
2864
  }
2652
2865
  /**
2866
+ * @public
2653
2867
  * <p>The request representing the confirmation for a password reset.</p>
2654
2868
  */
2655
2869
  export interface ConfirmForgotPasswordRequest {
@@ -2725,12 +2939,14 @@ export interface ConfirmForgotPasswordRequest {
2725
2939
  ClientMetadata?: Record<string, string>;
2726
2940
  }
2727
2941
  /**
2942
+ * @public
2728
2943
  * <p>The response from the server that results from a user's request to retrieve a
2729
2944
  * forgotten password.</p>
2730
2945
  */
2731
2946
  export interface ConfirmForgotPasswordResponse {
2732
2947
  }
2733
2948
  /**
2949
+ * @public
2734
2950
  * <p>Represents the request to confirm registration of a user.</p>
2735
2951
  */
2736
2952
  export interface ConfirmSignUpRequest {
@@ -2809,10 +3025,14 @@ export interface ConfirmSignUpRequest {
2809
3025
  ClientMetadata?: Record<string, string>;
2810
3026
  }
2811
3027
  /**
3028
+ * @public
2812
3029
  * <p>Represents the response from the server for the registration confirmation.</p>
2813
3030
  */
2814
3031
  export interface ConfirmSignUpResponse {
2815
3032
  }
3033
+ /**
3034
+ * @public
3035
+ */
2816
3036
  export interface CreateGroupRequest {
2817
3037
  /**
2818
3038
  * <p>The name of the group. Must be unique.</p>
@@ -2849,6 +3069,9 @@ export interface CreateGroupRequest {
2849
3069
  */
2850
3070
  Precedence?: number;
2851
3071
  }
3072
+ /**
3073
+ * @public
3074
+ */
2852
3075
  export interface CreateGroupResponse {
2853
3076
  /**
2854
3077
  * <p>The group object for the group.</p>
@@ -2856,6 +3079,7 @@ export interface CreateGroupResponse {
2856
3079
  Group?: GroupType;
2857
3080
  }
2858
3081
  /**
3082
+ * @public
2859
3083
  * <p>This exception is thrown when Amazon Cognito encounters a group that already exists in the user
2860
3084
  * pool.</p>
2861
3085
  */
@@ -2867,6 +3091,9 @@ export declare class GroupExistsException extends __BaseException {
2867
3091
  */
2868
3092
  constructor(opts: __ExceptionOptionType<GroupExistsException, __BaseException>);
2869
3093
  }
3094
+ /**
3095
+ * @public
3096
+ */
2870
3097
  export declare enum IdentityProviderTypeType {
2871
3098
  Facebook = "Facebook",
2872
3099
  Google = "Google",
@@ -2875,6 +3102,9 @@ export declare enum IdentityProviderTypeType {
2875
3102
  SAML = "SAML",
2876
3103
  SignInWithApple = "SignInWithApple"
2877
3104
  }
3105
+ /**
3106
+ * @public
3107
+ */
2878
3108
  export interface CreateIdentityProviderRequest {
2879
3109
  /**
2880
3110
  * <p>The user pool ID.</p>
@@ -3015,6 +3245,7 @@ export interface CreateIdentityProviderRequest {
3015
3245
  IdpIdentifiers?: string[];
3016
3246
  }
3017
3247
  /**
3248
+ * @public
3018
3249
  * <p>A container for information about an IdP.</p>
3019
3250
  */
3020
3251
  export interface IdentityProviderType {
@@ -3168,6 +3399,9 @@ export interface IdentityProviderType {
3168
3399
  */
3169
3400
  CreationDate?: Date;
3170
3401
  }
3402
+ /**
3403
+ * @public
3404
+ */
3171
3405
  export interface CreateIdentityProviderResponse {
3172
3406
  /**
3173
3407
  * <p>The newly created IdP object.</p>
@@ -3175,6 +3409,7 @@ export interface CreateIdentityProviderResponse {
3175
3409
  IdentityProvider: IdentityProviderType | undefined;
3176
3410
  }
3177
3411
  /**
3412
+ * @public
3178
3413
  * <p>This exception is thrown when the provider is already supported by the user
3179
3414
  * pool.</p>
3180
3415
  */
@@ -3187,6 +3422,7 @@ export declare class DuplicateProviderException extends __BaseException {
3187
3422
  constructor(opts: __ExceptionOptionType<DuplicateProviderException, __BaseException>);
3188
3423
  }
3189
3424
  /**
3425
+ * @public
3190
3426
  * <p>A resource server scope.</p>
3191
3427
  */
3192
3428
  export interface ResourceServerScopeType {
@@ -3199,6 +3435,9 @@ export interface ResourceServerScopeType {
3199
3435
  */
3200
3436
  ScopeDescription: string | undefined;
3201
3437
  }
3438
+ /**
3439
+ * @public
3440
+ */
3202
3441
  export interface CreateResourceServerRequest {
3203
3442
  /**
3204
3443
  * <p>The user pool ID for the user pool.</p>
@@ -3221,6 +3460,7 @@ export interface CreateResourceServerRequest {
3221
3460
  Scopes?: ResourceServerScopeType[];
3222
3461
  }
3223
3462
  /**
3463
+ * @public
3224
3464
  * <p>A container for information about a resource server for a user pool.</p>
3225
3465
  */
3226
3466
  export interface ResourceServerType {
@@ -3241,6 +3481,9 @@ export interface ResourceServerType {
3241
3481
  */
3242
3482
  Scopes?: ResourceServerScopeType[];
3243
3483
  }
3484
+ /**
3485
+ * @public
3486
+ */
3244
3487
  export interface CreateResourceServerResponse {
3245
3488
  /**
3246
3489
  * <p>The newly created resource server.</p>
@@ -3248,6 +3491,7 @@ export interface CreateResourceServerResponse {
3248
3491
  ResourceServer: ResourceServerType | undefined;
3249
3492
  }
3250
3493
  /**
3494
+ * @public
3251
3495
  * <p>Represents the request to create the user import job.</p>
3252
3496
  */
3253
3497
  export interface CreateUserImportJobRequest {
@@ -3264,6 +3508,9 @@ export interface CreateUserImportJobRequest {
3264
3508
  */
3265
3509
  CloudWatchLogsRoleArn: string | undefined;
3266
3510
  }
3511
+ /**
3512
+ * @public
3513
+ */
3267
3514
  export declare enum UserImportJobStatusType {
3268
3515
  Created = "Created",
3269
3516
  Expired = "Expired",
@@ -3275,6 +3522,7 @@ export declare enum UserImportJobStatusType {
3275
3522
  Succeeded = "Succeeded"
3276
3523
  }
3277
3524
  /**
3525
+ * @public
3278
3526
  * <p>The user import job type.</p>
3279
3527
  */
3280
3528
  export interface UserImportJobType {
@@ -3374,6 +3622,7 @@ export interface UserImportJobType {
3374
3622
  CompletionMessage?: string;
3375
3623
  }
3376
3624
  /**
3625
+ * @public
3377
3626
  * <p>Represents the response from the server to the request to create the user import
3378
3627
  * job.</p>
3379
3628
  */
@@ -3383,11 +3632,15 @@ export interface CreateUserImportJobResponse {
3383
3632
  */
3384
3633
  UserImportJob?: UserImportJobType;
3385
3634
  }
3635
+ /**
3636
+ * @public
3637
+ */
3386
3638
  export declare enum DeletionProtectionType {
3387
3639
  ACTIVE = "ACTIVE",
3388
3640
  INACTIVE = "INACTIVE"
3389
3641
  }
3390
3642
  /**
3643
+ * @public
3391
3644
  * <p>The device-remembering configuration for a user pool. A <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">
3392
3645
  * DescribeUserPool</a> request returns a null value for this object when the user
3393
3646
  * pool isn't configured to remember devices. When device remembering is active, you can
@@ -3431,11 +3684,15 @@ export interface DeviceConfigurationType {
3431
3684
  */
3432
3685
  DeviceOnlyRememberedOnUserPrompt?: boolean;
3433
3686
  }
3687
+ /**
3688
+ * @public
3689
+ */
3434
3690
  export declare enum EmailSendingAccountType {
3435
3691
  COGNITO_DEFAULT = "COGNITO_DEFAULT",
3436
3692
  DEVELOPER = "DEVELOPER"
3437
3693
  }
3438
3694
  /**
3695
+ * @public
3439
3696
  * <p>The email configuration of your user pool. The email configuration type sets your
3440
3697
  * preferred sending method, Amazon Web Services Region, and sender for messages from your user
3441
3698
  * pool.</p>
@@ -3542,10 +3799,14 @@ export interface EmailConfigurationType {
3542
3799
  */
3543
3800
  ConfigurationSet?: string;
3544
3801
  }
3802
+ /**
3803
+ * @public
3804
+ */
3545
3805
  export declare enum CustomEmailSenderLambdaVersionType {
3546
3806
  V1_0 = "V1_0"
3547
3807
  }
3548
3808
  /**
3809
+ * @public
3549
3810
  * <p>A custom email sender Lambda configuration type.</p>
3550
3811
  */
3551
3812
  export interface CustomEmailLambdaVersionConfigType {
@@ -3560,10 +3821,14 @@ export interface CustomEmailLambdaVersionConfigType {
3560
3821
  */
3561
3822
  LambdaArn: string | undefined;
3562
3823
  }
3824
+ /**
3825
+ * @public
3826
+ */
3563
3827
  export declare enum CustomSMSSenderLambdaVersionType {
3564
3828
  V1_0 = "V1_0"
3565
3829
  }
3566
3830
  /**
3831
+ * @public
3567
3832
  * <p>A custom SMS sender Lambda configuration type.</p>
3568
3833
  */
3569
3834
  export interface CustomSMSLambdaVersionConfigType {
@@ -3579,6 +3844,7 @@ export interface CustomSMSLambdaVersionConfigType {
3579
3844
  LambdaArn: string | undefined;
3580
3845
  }
3581
3846
  /**
3847
+ * @public
3582
3848
  * <p>Specifies the configuration for Lambda triggers.</p>
3583
3849
  */
3584
3850
  export interface LambdaConfigType {
@@ -3637,12 +3903,16 @@ export interface LambdaConfigType {
3637
3903
  */
3638
3904
  KMSKeyID?: string;
3639
3905
  }
3906
+ /**
3907
+ * @public
3908
+ */
3640
3909
  export declare enum UserPoolMfaType {
3641
3910
  OFF = "OFF",
3642
3911
  ON = "ON",
3643
3912
  OPTIONAL = "OPTIONAL"
3644
3913
  }
3645
3914
  /**
3915
+ * @public
3646
3916
  * <p>The password policy type.</p>
3647
3917
  */
3648
3918
  export interface PasswordPolicyType {
@@ -3683,6 +3953,7 @@ export interface PasswordPolicyType {
3683
3953
  TemporaryPasswordValidityDays?: number;
3684
3954
  }
3685
3955
  /**
3956
+ * @public
3686
3957
  * <p>The policy associated with a user pool.</p>
3687
3958
  */
3688
3959
  export interface UserPoolPolicyType {
@@ -3692,6 +3963,7 @@ export interface UserPoolPolicyType {
3692
3963
  PasswordPolicy?: PasswordPolicyType;
3693
3964
  }
3694
3965
  /**
3966
+ * @public
3695
3967
  * <p>The SMS configuration type is the settings that your Amazon Cognito user pool must use to send
3696
3968
  * an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS
3697
3969
  * messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an
@@ -3731,6 +4003,7 @@ export interface SmsConfigurationType {
3731
4003
  SnsRegion?: string;
3732
4004
  }
3733
4005
  /**
4006
+ * @public
3734
4007
  * <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>,
3735
4008
  * a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For
3736
4009
  * more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates">
@@ -3753,11 +4026,15 @@ export interface UserAttributeUpdateSettingsType {
3753
4026
  */
3754
4027
  AttributesRequireVerificationBeforeUpdate?: (VerifiedAttributeType | string)[];
3755
4028
  }
4029
+ /**
4030
+ * @public
4031
+ */
3756
4032
  export declare enum UsernameAttributeType {
3757
4033
  EMAIL = "email",
3758
4034
  PHONE_NUMBER = "phone_number"
3759
4035
  }
3760
4036
  /**
4037
+ * @public
3761
4038
  * <p>The username configuration type. </p>
3762
4039
  */
3763
4040
  export interface UsernameConfigurationType {
@@ -3785,6 +4062,7 @@ export interface UsernameConfigurationType {
3785
4062
  CaseSensitive: boolean | undefined;
3786
4063
  }
3787
4064
  /**
4065
+ * @public
3788
4066
  * <p>The user pool add-ons type.</p>
3789
4067
  */
3790
4068
  export interface UserPoolAddOnsType {
@@ -3793,11 +4071,15 @@ export interface UserPoolAddOnsType {
3793
4071
  */
3794
4072
  AdvancedSecurityMode: AdvancedSecurityModeType | string | undefined;
3795
4073
  }
4074
+ /**
4075
+ * @public
4076
+ */
3796
4077
  export declare enum DefaultEmailOptionType {
3797
4078
  CONFIRM_WITH_CODE = "CONFIRM_WITH_CODE",
3798
4079
  CONFIRM_WITH_LINK = "CONFIRM_WITH_LINK"
3799
4080
  }
3800
4081
  /**
4082
+ * @public
3801
4083
  * <p>The template for verification messages.</p>
3802
4084
  */
3803
4085
  export interface VerificationMessageTemplateType {
@@ -3836,6 +4118,7 @@ export interface VerificationMessageTemplateType {
3836
4118
  DefaultEmailOption?: DefaultEmailOptionType | string;
3837
4119
  }
3838
4120
  /**
4121
+ * @public
3839
4122
  * <p>Represents the request to create a user pool.</p>
3840
4123
  */
3841
4124
  export interface CreateUserPoolRequest {
@@ -3974,11 +4257,15 @@ export interface CreateUserPoolRequest {
3974
4257
  */
3975
4258
  AccountRecoverySetting?: AccountRecoverySettingType;
3976
4259
  }
4260
+ /**
4261
+ * @public
4262
+ */
3977
4263
  export declare enum StatusType {
3978
4264
  Disabled = "Disabled",
3979
4265
  Enabled = "Enabled"
3980
4266
  }
3981
4267
  /**
4268
+ * @public
3982
4269
  * <p>A container for information about the user pool.</p>
3983
4270
  */
3984
4271
  export interface UserPoolType {
@@ -4184,6 +4471,7 @@ export interface UserPoolType {
4184
4471
  AccountRecoverySetting?: AccountRecoverySettingType;
4185
4472
  }
4186
4473
  /**
4474
+ * @public
4187
4475
  * <p>Represents the response from the server for the request to create a user pool.</p>
4188
4476
  */
4189
4477
  export interface CreateUserPoolResponse {
@@ -4193,6 +4481,7 @@ export interface CreateUserPoolResponse {
4193
4481
  UserPool?: UserPoolType;
4194
4482
  }
4195
4483
  /**
4484
+ * @public
4196
4485
  * <p>This exception is thrown when a user pool tag can't be set or updated.</p>
4197
4486
  */
4198
4487
  export declare class UserPoolTaggingException extends __BaseException {
@@ -4203,11 +4492,17 @@ export declare class UserPoolTaggingException extends __BaseException {
4203
4492
  */
4204
4493
  constructor(opts: __ExceptionOptionType<UserPoolTaggingException, __BaseException>);
4205
4494
  }
4495
+ /**
4496
+ * @public
4497
+ */
4206
4498
  export declare enum OAuthFlowType {
4207
4499
  client_credentials = "client_credentials",
4208
4500
  code = "code",
4209
4501
  implicit = "implicit"
4210
4502
  }
4503
+ /**
4504
+ * @public
4505
+ */
4211
4506
  export declare enum ExplicitAuthFlowsType {
4212
4507
  ADMIN_NO_SRP_AUTH = "ADMIN_NO_SRP_AUTH",
4213
4508
  ALLOW_ADMIN_USER_PASSWORD_AUTH = "ALLOW_ADMIN_USER_PASSWORD_AUTH",
@@ -4218,10 +4513,16 @@ export declare enum ExplicitAuthFlowsType {
4218
4513
  CUSTOM_AUTH_FLOW_ONLY = "CUSTOM_AUTH_FLOW_ONLY",
4219
4514
  USER_PASSWORD_AUTH = "USER_PASSWORD_AUTH"
4220
4515
  }
4516
+ /**
4517
+ * @public
4518
+ */
4221
4519
  export declare enum PreventUserExistenceErrorTypes {
4222
4520
  ENABLED = "ENABLED",
4223
4521
  LEGACY = "LEGACY"
4224
4522
  }
4523
+ /**
4524
+ * @public
4525
+ */
4225
4526
  export declare enum TimeUnitsType {
4226
4527
  DAYS = "days",
4227
4528
  HOURS = "hours",
@@ -4229,6 +4530,7 @@ export declare enum TimeUnitsType {
4229
4530
  SECONDS = "seconds"
4230
4531
  }
4231
4532
  /**
4533
+ * @public
4232
4534
  * <p>The data type TokenValidityUnits specifies the time units you use when you set the
4233
4535
  * duration of ID, access, and refresh tokens.</p>
4234
4536
  */
@@ -4254,6 +4556,7 @@ export interface TokenValidityUnitsType {
4254
4556
  RefreshToken?: TimeUnitsType | string;
4255
4557
  }
4256
4558
  /**
4559
+ * @public
4257
4560
  * <p>Represents the request to create a user pool client.</p>
4258
4561
  */
4259
4562
  export interface CreateUserPoolClientRequest {
@@ -4522,6 +4825,7 @@ export interface CreateUserPoolClientRequest {
4522
4825
  AuthSessionValidity?: number;
4523
4826
  }
4524
4827
  /**
4828
+ * @public
4525
4829
  * <p>Contains information about a user pool client.</p>
4526
4830
  */
4527
4831
  export interface UserPoolClientType {
@@ -4800,6 +5104,7 @@ export interface UserPoolClientType {
4800
5104
  AuthSessionValidity?: number;
4801
5105
  }
4802
5106
  /**
5107
+ * @public
4803
5108
  * <p>Represents the response from the server to create a user pool client.</p>
4804
5109
  */
4805
5110
  export interface CreateUserPoolClientResponse {
@@ -4809,6 +5114,7 @@ export interface CreateUserPoolClientResponse {
4809
5114
  UserPoolClient?: UserPoolClientType;
4810
5115
  }
4811
5116
  /**
5117
+ * @public
4812
5118
  * <p>This exception is thrown when the specified OAuth flow is not valid.</p>
4813
5119
  */
4814
5120
  export declare class InvalidOAuthFlowException extends __BaseException {
@@ -4820,6 +5126,7 @@ export declare class InvalidOAuthFlowException extends __BaseException {
4820
5126
  constructor(opts: __ExceptionOptionType<InvalidOAuthFlowException, __BaseException>);
4821
5127
  }
4822
5128
  /**
5129
+ * @public
4823
5130
  * <p>This exception is thrown when the specified scope doesn't exist.</p>
4824
5131
  */
4825
5132
  export declare class ScopeDoesNotExistException extends __BaseException {
@@ -4831,6 +5138,7 @@ export declare class ScopeDoesNotExistException extends __BaseException {
4831
5138
  constructor(opts: __ExceptionOptionType<ScopeDoesNotExistException, __BaseException>);
4832
5139
  }
4833
5140
  /**
5141
+ * @public
4834
5142
  * <p>The configuration for a custom domain that hosts the sign-up and sign-in webpages for
4835
5143
  * your application.</p>
4836
5144
  */
@@ -4841,6 +5149,9 @@ export interface CustomDomainConfigType {
4841
5149
  */
4842
5150
  CertificateArn: string | undefined;
4843
5151
  }
5152
+ /**
5153
+ * @public
5154
+ */
4844
5155
  export interface CreateUserPoolDomainRequest {
4845
5156
  /**
4846
5157
  * <p>The domain string. For custom domains, this is the fully-qualified domain name, such
@@ -4862,6 +5173,9 @@ export interface CreateUserPoolDomainRequest {
4862
5173
  */
4863
5174
  CustomDomainConfig?: CustomDomainConfigType;
4864
5175
  }
5176
+ /**
5177
+ * @public
5178
+ */
4865
5179
  export interface CreateUserPoolDomainResponse {
4866
5180
  /**
4867
5181
  * <p>The Amazon CloudFront endpoint that you use as the target of the alias that you set up with
@@ -4869,6 +5183,9 @@ export interface CreateUserPoolDomainResponse {
4869
5183
  */
4870
5184
  CloudFrontDomain?: string;
4871
5185
  }
5186
+ /**
5187
+ * @public
5188
+ */
4872
5189
  export interface DeleteGroupRequest {
4873
5190
  /**
4874
5191
  * <p>The name of the group.</p>
@@ -4879,6 +5196,9 @@ export interface DeleteGroupRequest {
4879
5196
  */
4880
5197
  UserPoolId: string | undefined;
4881
5198
  }
5199
+ /**
5200
+ * @public
5201
+ */
4882
5202
  export interface DeleteIdentityProviderRequest {
4883
5203
  /**
4884
5204
  * <p>The user pool ID.</p>
@@ -4890,6 +5210,7 @@ export interface DeleteIdentityProviderRequest {
4890
5210
  ProviderName: string | undefined;
4891
5211
  }
4892
5212
  /**
5213
+ * @public
4893
5214
  * <p>This exception is thrown when the specified identifier isn't supported.</p>
4894
5215
  */
4895
5216
  export declare class UnsupportedIdentityProviderException extends __BaseException {
@@ -4900,6 +5221,9 @@ export declare class UnsupportedIdentityProviderException extends __BaseExceptio
4900
5221
  */
4901
5222
  constructor(opts: __ExceptionOptionType<UnsupportedIdentityProviderException, __BaseException>);
4902
5223
  }
5224
+ /**
5225
+ * @public
5226
+ */
4903
5227
  export interface DeleteResourceServerRequest {
4904
5228
  /**
4905
5229
  * <p>The user pool ID for the user pool that hosts the resource server.</p>
@@ -4911,6 +5235,7 @@ export interface DeleteResourceServerRequest {
4911
5235
  Identifier: string | undefined;
4912
5236
  }
4913
5237
  /**
5238
+ * @public
4914
5239
  * <p>Represents the request to delete a user.</p>
4915
5240
  */
4916
5241
  export interface DeleteUserRequest {
@@ -4921,6 +5246,7 @@ export interface DeleteUserRequest {
4921
5246
  AccessToken: string | undefined;
4922
5247
  }
4923
5248
  /**
5249
+ * @public
4924
5250
  * <p>Represents the request to delete user attributes.</p>
4925
5251
  */
4926
5252
  export interface DeleteUserAttributesRequest {
@@ -4937,11 +5263,13 @@ export interface DeleteUserAttributesRequest {
4937
5263
  AccessToken: string | undefined;
4938
5264
  }
4939
5265
  /**
5266
+ * @public
4940
5267
  * <p>Represents the response from the server to delete user attributes.</p>
4941
5268
  */
4942
5269
  export interface DeleteUserAttributesResponse {
4943
5270
  }
4944
5271
  /**
5272
+ * @public
4945
5273
  * <p>Represents the request to delete a user pool.</p>
4946
5274
  */
4947
5275
  export interface DeleteUserPoolRequest {
@@ -4951,6 +5279,7 @@ export interface DeleteUserPoolRequest {
4951
5279
  UserPoolId: string | undefined;
4952
5280
  }
4953
5281
  /**
5282
+ * @public
4954
5283
  * <p>Represents the request to delete a user pool client.</p>
4955
5284
  */
4956
5285
  export interface DeleteUserPoolClientRequest {
@@ -4963,6 +5292,9 @@ export interface DeleteUserPoolClientRequest {
4963
5292
  */
4964
5293
  ClientId: string | undefined;
4965
5294
  }
5295
+ /**
5296
+ * @public
5297
+ */
4966
5298
  export interface DeleteUserPoolDomainRequest {
4967
5299
  /**
4968
5300
  * <p>The domain string. For custom domains, this is the fully-qualified domain name, such
@@ -4975,8 +5307,14 @@ export interface DeleteUserPoolDomainRequest {
4975
5307
  */
4976
5308
  UserPoolId: string | undefined;
4977
5309
  }
5310
+ /**
5311
+ * @public
5312
+ */
4978
5313
  export interface DeleteUserPoolDomainResponse {
4979
5314
  }
5315
+ /**
5316
+ * @public
5317
+ */
4980
5318
  export interface DescribeIdentityProviderRequest {
4981
5319
  /**
4982
5320
  * <p>The user pool ID.</p>
@@ -4987,12 +5325,18 @@ export interface DescribeIdentityProviderRequest {
4987
5325
  */
4988
5326
  ProviderName: string | undefined;
4989
5327
  }
5328
+ /**
5329
+ * @public
5330
+ */
4990
5331
  export interface DescribeIdentityProviderResponse {
4991
5332
  /**
4992
5333
  * <p>The identity provider details.</p>
4993
5334
  */
4994
5335
  IdentityProvider: IdentityProviderType | undefined;
4995
5336
  }
5337
+ /**
5338
+ * @public
5339
+ */
4996
5340
  export interface DescribeResourceServerRequest {
4997
5341
  /**
4998
5342
  * <p>The user pool ID for the user pool that hosts the resource server.</p>
@@ -5003,12 +5347,18 @@ export interface DescribeResourceServerRequest {
5003
5347
  */
5004
5348
  Identifier: string | undefined;
5005
5349
  }
5350
+ /**
5351
+ * @public
5352
+ */
5006
5353
  export interface DescribeResourceServerResponse {
5007
5354
  /**
5008
5355
  * <p>The resource server.</p>
5009
5356
  */
5010
5357
  ResourceServer: ResourceServerType | undefined;
5011
5358
  }
5359
+ /**
5360
+ * @public
5361
+ */
5012
5362
  export interface DescribeRiskConfigurationRequest {
5013
5363
  /**
5014
5364
  * <p>The user pool ID.</p>
@@ -5019,11 +5369,15 @@ export interface DescribeRiskConfigurationRequest {
5019
5369
  */
5020
5370
  ClientId?: string;
5021
5371
  }
5372
+ /**
5373
+ * @public
5374
+ */
5022
5375
  export declare enum CompromisedCredentialsEventActionType {
5023
5376
  BLOCK = "BLOCK",
5024
5377
  NO_ACTION = "NO_ACTION"
5025
5378
  }
5026
5379
  /**
5380
+ * @public
5027
5381
  * <p>The compromised credentials actions type.</p>
5028
5382
  */
5029
5383
  export interface CompromisedCredentialsActionsType {
@@ -5032,12 +5386,16 @@ export interface CompromisedCredentialsActionsType {
5032
5386
  */
5033
5387
  EventAction: CompromisedCredentialsEventActionType | string | undefined;
5034
5388
  }
5389
+ /**
5390
+ * @public
5391
+ */
5035
5392
  export declare enum EventFilterType {
5036
5393
  PASSWORD_CHANGE = "PASSWORD_CHANGE",
5037
5394
  SIGN_IN = "SIGN_IN",
5038
5395
  SIGN_UP = "SIGN_UP"
5039
5396
  }
5040
5397
  /**
5398
+ * @public
5041
5399
  * <p>The compromised credentials risk configuration type.</p>
5042
5400
  */
5043
5401
  export interface CompromisedCredentialsRiskConfigurationType {
@@ -5052,6 +5410,7 @@ export interface CompromisedCredentialsRiskConfigurationType {
5052
5410
  Actions: CompromisedCredentialsActionsType | undefined;
5053
5411
  }
5054
5412
  /**
5413
+ * @public
5055
5414
  * <p>The type of the configuration to override the risk decision.</p>
5056
5415
  */
5057
5416
  export interface RiskExceptionConfigurationType {
@@ -5068,6 +5427,7 @@ export interface RiskExceptionConfigurationType {
5068
5427
  SkippedIPRangeList?: string[];
5069
5428
  }
5070
5429
  /**
5430
+ * @public
5071
5431
  * <p>The risk configuration type.</p>
5072
5432
  */
5073
5433
  export interface RiskConfigurationType {
@@ -5099,6 +5459,9 @@ export interface RiskConfigurationType {
5099
5459
  */
5100
5460
  LastModifiedDate?: Date;
5101
5461
  }
5462
+ /**
5463
+ * @public
5464
+ */
5102
5465
  export interface DescribeRiskConfigurationResponse {
5103
5466
  /**
5104
5467
  * <p>The risk configuration.</p>
@@ -5106,6 +5469,7 @@ export interface DescribeRiskConfigurationResponse {
5106
5469
  RiskConfiguration: RiskConfigurationType | undefined;
5107
5470
  }
5108
5471
  /**
5472
+ * @public
5109
5473
  * <p>Represents the request to describe the user import job.</p>
5110
5474
  */
5111
5475
  export interface DescribeUserImportJobRequest {
@@ -5119,6 +5483,7 @@ export interface DescribeUserImportJobRequest {
5119
5483
  JobId: string | undefined;
5120
5484
  }
5121
5485
  /**
5486
+ * @public
5122
5487
  * <p>Represents the response from the server to the request to describe the user import
5123
5488
  * job.</p>
5124
5489
  */
@@ -5129,6 +5494,7 @@ export interface DescribeUserImportJobResponse {
5129
5494
  UserImportJob?: UserImportJobType;
5130
5495
  }
5131
5496
  /**
5497
+ * @public
5132
5498
  * <p>Represents the request to describe the user pool.</p>
5133
5499
  */
5134
5500
  export interface DescribeUserPoolRequest {
@@ -5138,6 +5504,7 @@ export interface DescribeUserPoolRequest {
5138
5504
  UserPoolId: string | undefined;
5139
5505
  }
5140
5506
  /**
5507
+ * @public
5141
5508
  * <p>Represents the response to describe the user pool.</p>
5142
5509
  */
5143
5510
  export interface DescribeUserPoolResponse {
@@ -5147,6 +5514,7 @@ export interface DescribeUserPoolResponse {
5147
5514
  UserPool?: UserPoolType;
5148
5515
  }
5149
5516
  /**
5517
+ * @public
5150
5518
  * <p>Represents the request to describe a user pool client.</p>
5151
5519
  */
5152
5520
  export interface DescribeUserPoolClientRequest {
@@ -5160,6 +5528,7 @@ export interface DescribeUserPoolClientRequest {
5160
5528
  ClientId: string | undefined;
5161
5529
  }
5162
5530
  /**
5531
+ * @public
5163
5532
  * <p>Represents the response from the server from a request to describe the user pool
5164
5533
  * client.</p>
5165
5534
  */
@@ -5169,6 +5538,9 @@ export interface DescribeUserPoolClientResponse {
5169
5538
  */
5170
5539
  UserPoolClient?: UserPoolClientType;
5171
5540
  }
5541
+ /**
5542
+ * @public
5543
+ */
5172
5544
  export interface DescribeUserPoolDomainRequest {
5173
5545
  /**
5174
5546
  * <p>The domain string. For custom domains, this is the fully-qualified domain name, such
@@ -5177,6 +5549,9 @@ export interface DescribeUserPoolDomainRequest {
5177
5549
  */
5178
5550
  Domain: string | undefined;
5179
5551
  }
5552
+ /**
5553
+ * @public
5554
+ */
5180
5555
  export declare enum DomainStatusType {
5181
5556
  ACTIVE = "ACTIVE",
5182
5557
  CREATING = "CREATING",
@@ -5185,6 +5560,7 @@ export declare enum DomainStatusType {
5185
5560
  UPDATING = "UPDATING"
5186
5561
  }
5187
5562
  /**
5563
+ * @public
5188
5564
  * <p>A container for information about a domain.</p>
5189
5565
  */
5190
5566
  export interface DomainDescriptionType {
@@ -5224,6 +5600,9 @@ export interface DomainDescriptionType {
5224
5600
  */
5225
5601
  CustomDomainConfig?: CustomDomainConfigType;
5226
5602
  }
5603
+ /**
5604
+ * @public
5605
+ */
5227
5606
  export interface DescribeUserPoolDomainResponse {
5228
5607
  /**
5229
5608
  * <p>A domain description object containing information about the domain.</p>
@@ -5231,6 +5610,7 @@ export interface DescribeUserPoolDomainResponse {
5231
5610
  DomainDescription?: DomainDescriptionType;
5232
5611
  }
5233
5612
  /**
5613
+ * @public
5234
5614
  * <p>Represents the request to forget the device.</p>
5235
5615
  */
5236
5616
  export interface ForgetDeviceRequest {
@@ -5245,6 +5625,7 @@ export interface ForgetDeviceRequest {
5245
5625
  DeviceKey: string | undefined;
5246
5626
  }
5247
5627
  /**
5628
+ * @public
5248
5629
  * <p>Represents the request to reset a user's password.</p>
5249
5630
  */
5250
5631
  export interface ForgotPasswordRequest {
@@ -5313,6 +5694,7 @@ export interface ForgotPasswordRequest {
5313
5694
  ClientMetadata?: Record<string, string>;
5314
5695
  }
5315
5696
  /**
5697
+ * @public
5316
5698
  * <p>The delivery details for an email or SMS message that Amazon Cognito sent for authentication or
5317
5699
  * verification.</p>
5318
5700
  */
@@ -5331,6 +5713,7 @@ export interface CodeDeliveryDetailsType {
5331
5713
  AttributeName?: string;
5332
5714
  }
5333
5715
  /**
5716
+ * @public
5334
5717
  * <p>The response from Amazon Cognito to a request to reset a password.</p>
5335
5718
  */
5336
5719
  export interface ForgotPasswordResponse {
@@ -5341,6 +5724,7 @@ export interface ForgotPasswordResponse {
5341
5724
  CodeDeliveryDetails?: CodeDeliveryDetailsType;
5342
5725
  }
5343
5726
  /**
5727
+ * @public
5344
5728
  * <p>Represents the request to get the header information of the CSV file for the user
5345
5729
  * import job.</p>
5346
5730
  */
@@ -5351,6 +5735,7 @@ export interface GetCSVHeaderRequest {
5351
5735
  UserPoolId: string | undefined;
5352
5736
  }
5353
5737
  /**
5738
+ * @public
5354
5739
  * <p>Represents the response from the server to the request to get the header information
5355
5740
  * of the CSV file for the user import job.</p>
5356
5741
  */
@@ -5365,6 +5750,7 @@ export interface GetCSVHeaderResponse {
5365
5750
  CSVHeader?: string[];
5366
5751
  }
5367
5752
  /**
5753
+ * @public
5368
5754
  * <p>Represents the request to get the device.</p>
5369
5755
  */
5370
5756
  export interface GetDeviceRequest {
@@ -5379,6 +5765,7 @@ export interface GetDeviceRequest {
5379
5765
  AccessToken?: string;
5380
5766
  }
5381
5767
  /**
5768
+ * @public
5382
5769
  * <p>Gets the device response.</p>
5383
5770
  */
5384
5771
  export interface GetDeviceResponse {
@@ -5387,6 +5774,9 @@ export interface GetDeviceResponse {
5387
5774
  */
5388
5775
  Device: DeviceType | undefined;
5389
5776
  }
5777
+ /**
5778
+ * @public
5779
+ */
5390
5780
  export interface GetGroupRequest {
5391
5781
  /**
5392
5782
  * <p>The name of the group.</p>
@@ -5397,12 +5787,18 @@ export interface GetGroupRequest {
5397
5787
  */
5398
5788
  UserPoolId: string | undefined;
5399
5789
  }
5790
+ /**
5791
+ * @public
5792
+ */
5400
5793
  export interface GetGroupResponse {
5401
5794
  /**
5402
5795
  * <p>The group object for the group.</p>
5403
5796
  */
5404
5797
  Group?: GroupType;
5405
5798
  }
5799
+ /**
5800
+ * @public
5801
+ */
5406
5802
  export interface GetIdentityProviderByIdentifierRequest {
5407
5803
  /**
5408
5804
  * <p>The user pool ID.</p>
@@ -5413,6 +5809,9 @@ export interface GetIdentityProviderByIdentifierRequest {
5413
5809
  */
5414
5810
  IdpIdentifier: string | undefined;
5415
5811
  }
5812
+ /**
5813
+ * @public
5814
+ */
5416
5815
  export interface GetIdentityProviderByIdentifierResponse {
5417
5816
  /**
5418
5817
  * <p>The identity provider details.</p>
@@ -5420,6 +5819,7 @@ export interface GetIdentityProviderByIdentifierResponse {
5420
5819
  IdentityProvider: IdentityProviderType | undefined;
5421
5820
  }
5422
5821
  /**
5822
+ * @public
5423
5823
  * <p>Request to get a signing certificate from Amazon Cognito.</p>
5424
5824
  */
5425
5825
  export interface GetSigningCertificateRequest {
@@ -5429,6 +5829,7 @@ export interface GetSigningCertificateRequest {
5429
5829
  UserPoolId: string | undefined;
5430
5830
  }
5431
5831
  /**
5832
+ * @public
5432
5833
  * <p>Response from Amazon Cognito for a signing certificate request.</p>
5433
5834
  */
5434
5835
  export interface GetSigningCertificateResponse {
@@ -5437,6 +5838,9 @@ export interface GetSigningCertificateResponse {
5437
5838
  */
5438
5839
  Certificate?: string;
5439
5840
  }
5841
+ /**
5842
+ * @public
5843
+ */
5440
5844
  export interface GetUICustomizationRequest {
5441
5845
  /**
5442
5846
  * <p>The user pool ID for the user pool.</p>
@@ -5448,6 +5852,7 @@ export interface GetUICustomizationRequest {
5448
5852
  ClientId?: string;
5449
5853
  }
5450
5854
  /**
5855
+ * @public
5451
5856
  * <p>A container for the UI customization information for a user pool's built-in app
5452
5857
  * UI.</p>
5453
5858
  */
@@ -5481,6 +5886,9 @@ export interface UICustomizationType {
5481
5886
  */
5482
5887
  CreationDate?: Date;
5483
5888
  }
5889
+ /**
5890
+ * @public
5891
+ */
5484
5892
  export interface GetUICustomizationResponse {
5485
5893
  /**
5486
5894
  * <p>The UI customization information.</p>
@@ -5488,6 +5896,7 @@ export interface GetUICustomizationResponse {
5488
5896
  UICustomization: UICustomizationType | undefined;
5489
5897
  }
5490
5898
  /**
5899
+ * @public
5491
5900
  * <p>Represents the request to get information about the user.</p>
5492
5901
  */
5493
5902
  export interface GetUserRequest {
@@ -5497,6 +5906,7 @@ export interface GetUserRequest {
5497
5906
  AccessToken: string | undefined;
5498
5907
  }
5499
5908
  /**
5909
+ * @public
5500
5910
  * <p>Represents the response from the server from the request to get information about the
5501
5911
  * user.</p>
5502
5912
  */
@@ -5531,6 +5941,7 @@ export interface GetUserResponse {
5531
5941
  UserMFASettingList?: string[];
5532
5942
  }
5533
5943
  /**
5944
+ * @public
5534
5945
  * <p>Represents the request to get user attribute verification.</p>
5535
5946
  */
5536
5947
  export interface GetUserAttributeVerificationCodeRequest {
@@ -5582,6 +5993,7 @@ export interface GetUserAttributeVerificationCodeRequest {
5582
5993
  ClientMetadata?: Record<string, string>;
5583
5994
  }
5584
5995
  /**
5996
+ * @public
5585
5997
  * <p>The verification code response returned by the server response to get the user
5586
5998
  * attribute verification code.</p>
5587
5999
  */
@@ -5592,6 +6004,9 @@ export interface GetUserAttributeVerificationCodeResponse {
5592
6004
  */
5593
6005
  CodeDeliveryDetails?: CodeDeliveryDetailsType;
5594
6006
  }
6007
+ /**
6008
+ * @public
6009
+ */
5595
6010
  export interface GetUserPoolMfaConfigRequest {
5596
6011
  /**
5597
6012
  * <p>The user pool ID.</p>
@@ -5599,12 +6014,13 @@ export interface GetUserPoolMfaConfigRequest {
5599
6014
  UserPoolId: string | undefined;
5600
6015
  }
5601
6016
  /**
6017
+ * @public
5602
6018
  * <p>The SMS text message multi-factor authentication (MFA) configuration type.</p>
5603
6019
  */
5604
6020
  export interface SmsMfaConfigType {
5605
6021
  /**
5606
6022
  * <p>The SMS authentication message that will be sent to users with the code they must sign
5607
- * in. The message must contain the {####}’ placeholder, which is replaced with the code.
6023
+ * in. The message must contain the ‘\{####\}’ placeholder, which is replaced with the code.
5608
6024
  * If the message isn't included, and default message will be used.</p>
5609
6025
  */
5610
6026
  SmsAuthenticationMessage?: string;
@@ -5617,6 +6033,7 @@ export interface SmsMfaConfigType {
5617
6033
  SmsConfiguration?: SmsConfigurationType;
5618
6034
  }
5619
6035
  /**
6036
+ * @public
5620
6037
  * <p>The type used for enabling software token MFA at the user pool level.</p>
5621
6038
  */
5622
6039
  export interface SoftwareTokenMfaConfigType {
@@ -5625,6 +6042,9 @@ export interface SoftwareTokenMfaConfigType {
5625
6042
  */
5626
6043
  Enabled?: boolean;
5627
6044
  }
6045
+ /**
6046
+ * @public
6047
+ */
5628
6048
  export interface GetUserPoolMfaConfigResponse {
5629
6049
  /**
5630
6050
  * <p>The SMS text message multi-factor authentication (MFA) configuration.</p>
@@ -5655,6 +6075,7 @@ export interface GetUserPoolMfaConfigResponse {
5655
6075
  MfaConfiguration?: UserPoolMfaType | string;
5656
6076
  }
5657
6077
  /**
6078
+ * @public
5658
6079
  * <p>Represents the request to sign out all devices.</p>
5659
6080
  */
5660
6081
  export interface GlobalSignOutRequest {
@@ -5664,11 +6085,13 @@ export interface GlobalSignOutRequest {
5664
6085
  AccessToken: string | undefined;
5665
6086
  }
5666
6087
  /**
6088
+ * @public
5667
6089
  * <p>The response to the request to sign out all devices.</p>
5668
6090
  */
5669
6091
  export interface GlobalSignOutResponse {
5670
6092
  }
5671
6093
  /**
6094
+ * @public
5672
6095
  * <p>Initiates the authentication request.</p>
5673
6096
  */
5674
6097
  export interface InitiateAuthRequest {
@@ -5835,6 +6258,7 @@ export interface InitiateAuthRequest {
5835
6258
  UserContextData?: UserContextDataType;
5836
6259
  }
5837
6260
  /**
6261
+ * @public
5838
6262
  * <p>Initiates the authentication response.</p>
5839
6263
  */
5840
6264
  export interface InitiateAuthResponse {
@@ -5935,6 +6359,7 @@ export interface InitiateAuthResponse {
5935
6359
  AuthenticationResult?: AuthenticationResultType;
5936
6360
  }
5937
6361
  /**
6362
+ * @public
5938
6363
  * <p>Represents the request to list the devices.</p>
5939
6364
  */
5940
6365
  export interface ListDevicesRequest {
@@ -5953,6 +6378,7 @@ export interface ListDevicesRequest {
5953
6378
  PaginationToken?: string;
5954
6379
  }
5955
6380
  /**
6381
+ * @public
5956
6382
  * <p>Represents the response to list devices.</p>
5957
6383
  */
5958
6384
  export interface ListDevicesResponse {
@@ -5965,6 +6391,9 @@ export interface ListDevicesResponse {
5965
6391
  */
5966
6392
  PaginationToken?: string;
5967
6393
  }
6394
+ /**
6395
+ * @public
6396
+ */
5968
6397
  export interface ListGroupsRequest {
5969
6398
  /**
5970
6399
  * <p>The user pool ID for the user pool.</p>
@@ -5980,6 +6409,9 @@ export interface ListGroupsRequest {
5980
6409
  */
5981
6410
  NextToken?: string;
5982
6411
  }
6412
+ /**
6413
+ * @public
6414
+ */
5983
6415
  export interface ListGroupsResponse {
5984
6416
  /**
5985
6417
  * <p>The group objects for the groups.</p>
@@ -5991,6 +6423,9 @@ export interface ListGroupsResponse {
5991
6423
  */
5992
6424
  NextToken?: string;
5993
6425
  }
6426
+ /**
6427
+ * @public
6428
+ */
5994
6429
  export interface ListIdentityProvidersRequest {
5995
6430
  /**
5996
6431
  * <p>The user pool ID.</p>
@@ -6006,6 +6441,7 @@ export interface ListIdentityProvidersRequest {
6006
6441
  NextToken?: string;
6007
6442
  }
6008
6443
  /**
6444
+ * @public
6009
6445
  * <p>A container for IdP details.</p>
6010
6446
  */
6011
6447
  export interface ProviderDescription {
@@ -6026,6 +6462,9 @@ export interface ProviderDescription {
6026
6462
  */
6027
6463
  CreationDate?: Date;
6028
6464
  }
6465
+ /**
6466
+ * @public
6467
+ */
6029
6468
  export interface ListIdentityProvidersResponse {
6030
6469
  /**
6031
6470
  * <p>A list of IdP objects.</p>
@@ -6036,6 +6475,9 @@ export interface ListIdentityProvidersResponse {
6036
6475
  */
6037
6476
  NextToken?: string;
6038
6477
  }
6478
+ /**
6479
+ * @public
6480
+ */
6039
6481
  export interface ListResourceServersRequest {
6040
6482
  /**
6041
6483
  * <p>The user pool ID for the user pool.</p>
@@ -6050,6 +6492,9 @@ export interface ListResourceServersRequest {
6050
6492
  */
6051
6493
  NextToken?: string;
6052
6494
  }
6495
+ /**
6496
+ * @public
6497
+ */
6053
6498
  export interface ListResourceServersResponse {
6054
6499
  /**
6055
6500
  * <p>The resource servers.</p>
@@ -6060,12 +6505,18 @@ export interface ListResourceServersResponse {
6060
6505
  */
6061
6506
  NextToken?: string;
6062
6507
  }
6508
+ /**
6509
+ * @public
6510
+ */
6063
6511
  export interface ListTagsForResourceRequest {
6064
6512
  /**
6065
6513
  * <p>The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.</p>
6066
6514
  */
6067
6515
  ResourceArn: string | undefined;
6068
6516
  }
6517
+ /**
6518
+ * @public
6519
+ */
6069
6520
  export interface ListTagsForResourceResponse {
6070
6521
  /**
6071
6522
  * <p>The tags that are assigned to the user pool.</p>
@@ -6073,6 +6524,7 @@ export interface ListTagsForResourceResponse {
6073
6524
  Tags?: Record<string, string>;
6074
6525
  }
6075
6526
  /**
6527
+ * @public
6076
6528
  * <p>Represents the request to list the user import jobs.</p>
6077
6529
  */
6078
6530
  export interface ListUserImportJobsRequest {
@@ -6092,6 +6544,7 @@ export interface ListUserImportJobsRequest {
6092
6544
  PaginationToken?: string;
6093
6545
  }
6094
6546
  /**
6547
+ * @public
6095
6548
  * <p>Represents the response from the server to the request to list the user import
6096
6549
  * jobs.</p>
6097
6550
  */
@@ -6107,6 +6560,7 @@ export interface ListUserImportJobsResponse {
6107
6560
  PaginationToken?: string;
6108
6561
  }
6109
6562
  /**
6563
+ * @public
6110
6564
  * <p>Represents the request to list the user pool clients.</p>
6111
6565
  */
6112
6566
  export interface ListUserPoolClientsRequest {
@@ -6126,6 +6580,7 @@ export interface ListUserPoolClientsRequest {
6126
6580
  NextToken?: string;
6127
6581
  }
6128
6582
  /**
6583
+ * @public
6129
6584
  * <p>The description of the user pool client.</p>
6130
6585
  */
6131
6586
  export interface UserPoolClientDescription {
@@ -6144,6 +6599,7 @@ export interface UserPoolClientDescription {
6144
6599
  ClientName?: string;
6145
6600
  }
6146
6601
  /**
6602
+ * @public
6147
6603
  * <p>Represents the response from the server that lists user pool clients.</p>
6148
6604
  */
6149
6605
  export interface ListUserPoolClientsResponse {
@@ -6158,6 +6614,7 @@ export interface ListUserPoolClientsResponse {
6158
6614
  NextToken?: string;
6159
6615
  }
6160
6616
  /**
6617
+ * @public
6161
6618
  * <p>Represents the request to list user pools.</p>
6162
6619
  */
6163
6620
  export interface ListUserPoolsRequest {
@@ -6173,6 +6630,7 @@ export interface ListUserPoolsRequest {
6173
6630
  MaxResults: number | undefined;
6174
6631
  }
6175
6632
  /**
6633
+ * @public
6176
6634
  * <p>A user pool description.</p>
6177
6635
  */
6178
6636
  export interface UserPoolDescriptionType {
@@ -6202,6 +6660,7 @@ export interface UserPoolDescriptionType {
6202
6660
  CreationDate?: Date;
6203
6661
  }
6204
6662
  /**
6663
+ * @public
6205
6664
  * <p>Represents the response to list user pools.</p>
6206
6665
  */
6207
6666
  export interface ListUserPoolsResponse {
@@ -6216,6 +6675,7 @@ export interface ListUserPoolsResponse {
6216
6675
  NextToken?: string;
6217
6676
  }
6218
6677
  /**
6678
+ * @public
6219
6679
  * <p>Represents the request to list users.</p>
6220
6680
  */
6221
6681
  export interface ListUsersRequest {
@@ -6333,6 +6793,7 @@ export interface ListUsersRequest {
6333
6793
  Filter?: string;
6334
6794
  }
6335
6795
  /**
6796
+ * @public
6336
6797
  * <p>The response from the request to list users.</p>
6337
6798
  */
6338
6799
  export interface ListUsersResponse {
@@ -6346,6 +6807,9 @@ export interface ListUsersResponse {
6346
6807
  */
6347
6808
  PaginationToken?: string;
6348
6809
  }
6810
+ /**
6811
+ * @public
6812
+ */
6349
6813
  export interface ListUsersInGroupRequest {
6350
6814
  /**
6351
6815
  * <p>The user pool ID for the user pool.</p>
@@ -6365,6 +6829,9 @@ export interface ListUsersInGroupRequest {
6365
6829
  */
6366
6830
  NextToken?: string;
6367
6831
  }
6832
+ /**
6833
+ * @public
6834
+ */
6368
6835
  export interface ListUsersInGroupResponse {
6369
6836
  /**
6370
6837
  * <p>The users returned in the request to list users.</p>
@@ -6377,6 +6844,7 @@ export interface ListUsersInGroupResponse {
6377
6844
  NextToken?: string;
6378
6845
  }
6379
6846
  /**
6847
+ * @public
6380
6848
  * <p>Represents the request to resend the confirmation code.</p>
6381
6849
  */
6382
6850
  export interface ResendConfirmationCodeRequest {
@@ -6443,6 +6911,7 @@ export interface ResendConfirmationCodeRequest {
6443
6911
  ClientMetadata?: Record<string, string>;
6444
6912
  }
6445
6913
  /**
6914
+ * @public
6446
6915
  * <p>The response from the server when Amazon Cognito makes the request to resend a confirmation
6447
6916
  * code.</p>
6448
6917
  */
@@ -6454,6 +6923,7 @@ export interface ResendConfirmationCodeResponse {
6454
6923
  CodeDeliveryDetails?: CodeDeliveryDetailsType;
6455
6924
  }
6456
6925
  /**
6926
+ * @public
6457
6927
  * <p>The request to respond to an authentication challenge.</p>
6458
6928
  */
6459
6929
  export interface RespondToAuthChallengeRequest {
@@ -6596,6 +7066,7 @@ export interface RespondToAuthChallengeRequest {
6596
7066
  ClientMetadata?: Record<string, string>;
6597
7067
  }
6598
7068
  /**
7069
+ * @public
6599
7070
  * <p>The response to respond to the authentication challenge.</p>
6600
7071
  */
6601
7072
  export interface RespondToAuthChallengeResponse {
@@ -6620,6 +7091,9 @@ export interface RespondToAuthChallengeResponse {
6620
7091
  */
6621
7092
  AuthenticationResult?: AuthenticationResultType;
6622
7093
  }
7094
+ /**
7095
+ * @public
7096
+ */
6623
7097
  export interface RevokeTokenRequest {
6624
7098
  /**
6625
7099
  * <p>The refresh token that you want to revoke.</p>
@@ -6635,9 +7109,13 @@ export interface RevokeTokenRequest {
6635
7109
  */
6636
7110
  ClientSecret?: string;
6637
7111
  }
7112
+ /**
7113
+ * @public
7114
+ */
6638
7115
  export interface RevokeTokenResponse {
6639
7116
  }
6640
7117
  /**
7118
+ * @public
6641
7119
  * <p>Exception that is thrown when the request isn't authorized. This can happen due to an
6642
7120
  * invalid access token in the request.</p>
6643
7121
  */
@@ -6650,6 +7128,7 @@ export declare class UnauthorizedException extends __BaseException {
6650
7128
  constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
6651
7129
  }
6652
7130
  /**
7131
+ * @public
6653
7132
  * <p>Exception that is thrown when you attempt to perform an operation that isn't enabled
6654
7133
  * for the user pool client.</p>
6655
7134
  */
@@ -6662,6 +7141,7 @@ export declare class UnsupportedOperationException extends __BaseException {
6662
7141
  constructor(opts: __ExceptionOptionType<UnsupportedOperationException, __BaseException>);
6663
7142
  }
6664
7143
  /**
7144
+ * @public
6665
7145
  * <p>Exception that is thrown when an unsupported token is passed to an operation.</p>
6666
7146
  */
6667
7147
  export declare class UnsupportedTokenTypeException extends __BaseException {
@@ -6672,6 +7152,9 @@ export declare class UnsupportedTokenTypeException extends __BaseException {
6672
7152
  */
6673
7153
  constructor(opts: __ExceptionOptionType<UnsupportedTokenTypeException, __BaseException>);
6674
7154
  }
7155
+ /**
7156
+ * @public
7157
+ */
6675
7158
  export interface SetRiskConfigurationRequest {
6676
7159
  /**
6677
7160
  * <p>The user pool ID. </p>
@@ -6699,12 +7182,18 @@ export interface SetRiskConfigurationRequest {
6699
7182
  */
6700
7183
  RiskExceptionConfiguration?: RiskExceptionConfigurationType;
6701
7184
  }
7185
+ /**
7186
+ * @public
7187
+ */
6702
7188
  export interface SetRiskConfigurationResponse {
6703
7189
  /**
6704
7190
  * <p>The risk configuration.</p>
6705
7191
  */
6706
7192
  RiskConfiguration: RiskConfigurationType | undefined;
6707
7193
  }
7194
+ /**
7195
+ * @public
7196
+ */
6708
7197
  export interface SetUICustomizationRequest {
6709
7198
  /**
6710
7199
  * <p>The user pool ID for the user pool.</p>
@@ -6723,12 +7212,18 @@ export interface SetUICustomizationRequest {
6723
7212
  */
6724
7213
  ImageFile?: Uint8Array;
6725
7214
  }
7215
+ /**
7216
+ * @public
7217
+ */
6726
7218
  export interface SetUICustomizationResponse {
6727
7219
  /**
6728
7220
  * <p>The UI customization information.</p>
6729
7221
  */
6730
7222
  UICustomization: UICustomizationType | undefined;
6731
7223
  }
7224
+ /**
7225
+ * @public
7226
+ */
6732
7227
  export interface SetUserMFAPreferenceRequest {
6733
7228
  /**
6734
7229
  * <p>The SMS text message multi-factor authentication (MFA) settings.</p>
@@ -6744,8 +7239,14 @@ export interface SetUserMFAPreferenceRequest {
6744
7239
  */
6745
7240
  AccessToken: string | undefined;
6746
7241
  }
7242
+ /**
7243
+ * @public
7244
+ */
6747
7245
  export interface SetUserMFAPreferenceResponse {
6748
7246
  }
7247
+ /**
7248
+ * @public
7249
+ */
6749
7250
  export interface SetUserPoolMfaConfigRequest {
6750
7251
  /**
6751
7252
  * <p>The user pool ID.</p>
@@ -6781,6 +7282,9 @@ export interface SetUserPoolMfaConfigRequest {
6781
7282
  */
6782
7283
  MfaConfiguration?: UserPoolMfaType | string;
6783
7284
  }
7285
+ /**
7286
+ * @public
7287
+ */
6784
7288
  export interface SetUserPoolMfaConfigResponse {
6785
7289
  /**
6786
7290
  * <p>The SMS text message MFA configuration.</p>
@@ -6811,6 +7315,7 @@ export interface SetUserPoolMfaConfigResponse {
6811
7315
  MfaConfiguration?: UserPoolMfaType | string;
6812
7316
  }
6813
7317
  /**
7318
+ * @public
6814
7319
  * <p>Represents the request to set user settings.</p>
6815
7320
  */
6816
7321
  export interface SetUserSettingsRequest {
@@ -6826,6 +7331,7 @@ export interface SetUserSettingsRequest {
6826
7331
  MFAOptions: MFAOptionType[] | undefined;
6827
7332
  }
6828
7333
  /**
7334
+ * @public
6829
7335
  * <p>The response from the server for a set user settings request.</p>
6830
7336
  */
6831
7337
  export interface SetUserSettingsResponse {