@aws-sdk/client-cognito-identity-provider 3.379.1 → 3.382.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 (3) hide show
  1. package/dist-types/models/models_0.d.ts +689 -0
  2. package/dist-types/models/models_1.d.ts +106 -0
  3. package/package.json +5 -5
package/dist-types/models/models_0.d.ts CHANGED
@@ -19,11 +19,13 @@ export type RecoveryOptionNameType = (typeof RecoveryOptionNameType)[keyof typeo
19
19
  */
20
20
  export interface RecoveryOptionType {
21
21
  /**
22
+ * @public
22
23
  * <p>A positive integer specifying priority of a method with 1 being the highest
23
24
  * priority.</p>
24
25
  */
25
26
  Priority: number | undefined;
26
27
  /**
28
+ * @public
27
29
  * <p>The recovery method for a user.</p>
28
30
  */
29
31
  Name: RecoveryOptionNameType | string | undefined;
@@ -34,6 +36,7 @@ export interface RecoveryOptionType {
34
36
  */
35
37
  export interface AccountRecoverySettingType {
36
38
  /**
39
+ * @public
37
40
  * <p>The list of <code>RecoveryOptionTypes</code>.</p>
38
41
  */
39
42
  RecoveryMechanisms?: RecoveryOptionType[];
@@ -58,10 +61,12 @@ export type AccountTakeoverEventActionType = (typeof AccountTakeoverEventActionT
58
61
  */
59
62
  export interface AccountTakeoverActionType {
60
63
  /**
64
+ * @public
61
65
  * <p>Flag specifying whether to send a notification.</p>
62
66
  */
63
67
  Notify: boolean | undefined;
64
68
  /**
69
+ * @public
65
70
  * <p>The action to take in response to the account takeover action. Valid values are as
66
71
  * follows:</p>
67
72
  * <ul>
@@ -93,14 +98,17 @@ export interface AccountTakeoverActionType {
93
98
  */
94
99
  export interface AccountTakeoverActionsType {
95
100
  /**
101
+ * @public
96
102
  * <p>Action to take for a low risk.</p>
97
103
  */
98
104
  LowAction?: AccountTakeoverActionType;
99
105
  /**
106
+ * @public
100
107
  * <p>Action to take for a medium risk.</p>
101
108
  */
102
109
  MediumAction?: AccountTakeoverActionType;
103
110
  /**
111
+ * @public
104
112
  * <p>Action to take for a high risk.</p>
105
113
  */
106
114
  HighAction?: AccountTakeoverActionType;
@@ -111,14 +119,17 @@ export interface AccountTakeoverActionsType {
111
119
  */
112
120
  export interface NotifyEmailType {
113
121
  /**
122
+ * @public
114
123
  * <p>The email subject.</p>
115
124
  */
116
125
  Subject: string | undefined;
117
126
  /**
127
+ * @public
118
128
  * <p>The email HTML body.</p>
119
129
  */
120
130
  HtmlBody?: string;
121
131
  /**
132
+ * @public
122
133
  * <p>The email text body.</p>
123
134
  */
124
135
  TextBody?: string;
@@ -129,29 +140,35 @@ export interface NotifyEmailType {
129
140
  */
130
141
  export interface NotifyConfigurationType {
131
142
  /**
143
+ * @public
132
144
  * <p>The email address that is sending the email. The address must be either individually
133
145
  * verified with Amazon Simple Email Service, or from a domain that has been verified with Amazon SES.</p>
134
146
  */
135
147
  From?: string;
136
148
  /**
149
+ * @public
137
150
  * <p>The destination to which the receiver of an email should reply to.</p>
138
151
  */
139
152
  ReplyTo?: string;
140
153
  /**
154
+ * @public
141
155
  * <p>The Amazon Resource Name (ARN) of the identity that is associated with the sending
142
156
  * authorization policy. This identity permits Amazon Cognito to send for the email address
143
157
  * specified in the <code>From</code> parameter.</p>
144
158
  */
145
159
  SourceArn: string | undefined;
146
160
  /**
161
+ * @public
147
162
  * <p>Email template used when a detected risk event is blocked.</p>
148
163
  */
149
164
  BlockEmail?: NotifyEmailType;
150
165
  /**
166
+ * @public
151
167
  * <p>The email template used when a detected risk event is allowed.</p>
152
168
  */
153
169
  NoActionEmail?: NotifyEmailType;
154
170
  /**
171
+ * @public
155
172
  * <p>The multi-factor authentication (MFA) email template used when MFA is challenged as
156
173
  * part of a detected risk.</p>
157
174
  */
@@ -164,10 +181,12 @@ export interface NotifyConfigurationType {
164
181
  */
165
182
  export interface AccountTakeoverRiskConfigurationType {
166
183
  /**
184
+ * @public
167
185
  * <p>The notify configuration used to construct email notifications.</p>
168
186
  */
169
187
  NotifyConfiguration?: NotifyConfigurationType;
170
188
  /**
189
+ * @public
171
190
  * <p>Account takeover risk configuration actions.</p>
172
191
  */
173
192
  Actions: AccountTakeoverActionsType | undefined;
@@ -192,10 +211,12 @@ export type AttributeDataType = (typeof AttributeDataType)[keyof typeof Attribut
192
211
  */
193
212
  export interface NumberAttributeConstraintsType {
194
213
  /**
214
+ * @public
195
215
  * <p>The minimum value of an attribute that is of the number data type.</p>
196
216
  */
197
217
  MinValue?: string;
198
218
  /**
219
+ * @public
199
220
  * <p>The maximum value of an attribute that is of the number data type.</p>
200
221
  */
201
222
  MaxValue?: string;
@@ -206,10 +227,12 @@ export interface NumberAttributeConstraintsType {
206
227
  */
207
228
  export interface StringAttributeConstraintsType {
208
229
  /**
230
+ * @public
209
231
  * <p>The minimum length.</p>
210
232
  */
211
233
  MinLength?: string;
212
234
  /**
235
+ * @public
213
236
  * <p>The maximum length.</p>
214
237
  */
215
238
  MaxLength?: string;
@@ -220,14 +243,17 @@ export interface StringAttributeConstraintsType {
220
243
  */
221
244
  export interface SchemaAttributeType {
222
245
  /**
246
+ * @public
223
247
  * <p>A schema attribute of the name type.</p>
224
248
  */
225
249
  Name?: string;
226
250
  /**
251
+ * @public
227
252
  * <p>The attribute data type.</p>
228
253
  */
229
254
  AttributeDataType?: AttributeDataType | string;
230
255
  /**
256
+ * @public
231
257
  * <note>
232
258
  * <p>You should use <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserPoolClientType.html#CognitoUserPools-Type-UserPoolClientType-WriteAttributes">WriteAttributes</a> in the user pool client to control how attributes can
233
259
  * be mutated for new use cases instead of using
@@ -240,6 +266,7 @@ export interface SchemaAttributeType {
240
266
  */
241
267
  DeveloperOnlyAttribute?: boolean;
242
268
  /**
269
+ * @public
243
270
  * <p>Specifies whether the value of the attribute can be changed.</p>
244
271
  * <p>For any user pool attribute that is mapped to an IdP attribute, you must set this
245
272
  * parameter to <code>true</code>. Amazon Cognito updates mapped attributes when users sign in to
@@ -249,15 +276,18 @@ export interface SchemaAttributeType {
249
276
  */
250
277
  Mutable?: boolean;
251
278
  /**
279
+ * @public
252
280
  * <p>Specifies whether a user pool attribute is required. If the attribute is required and
253
281
  * the user doesn't provide a value, registration or sign-in will fail.</p>
254
282
  */
255
283
  Required?: boolean;
256
284
  /**
285
+ * @public
257
286
  * <p>Specifies the constraints for an attribute of the number type.</p>
258
287
  */
259
288
  NumberAttributeConstraints?: NumberAttributeConstraintsType;
260
289
  /**
290
+ * @public
261
291
  * <p>Specifies the constraints for an attribute of the string type.</p>
262
292
  */
263
293
  StringAttributeConstraints?: StringAttributeConstraintsType;
@@ -268,10 +298,12 @@ export interface SchemaAttributeType {
268
298
  */
269
299
  export interface AddCustomAttributesRequest {
270
300
  /**
301
+ * @public
271
302
  * <p>The user pool ID for the user pool where you want to add custom attributes.</p>
272
303
  */
273
304
  UserPoolId: string | undefined;
274
305
  /**
306
+ * @public
275
307
  * <p>An array of custom attributes, such as Mutable and Name.</p>
276
308
  */
277
309
  CustomAttributes: SchemaAttributeType[] | undefined;
@@ -364,14 +396,17 @@ export declare class UserImportInProgressException extends __BaseException {
364
396
  */
365
397
  export interface AdminAddUserToGroupRequest {
366
398
  /**
399
+ * @public
367
400
  * <p>The user pool ID for the user pool.</p>
368
401
  */
369
402
  UserPoolId: string | undefined;
370
403
  /**
404
+ * @public
371
405
  * <p>The username for the user.</p>
372
406
  */
373
407
  Username: string | undefined;
374
408
  /**
409
+ * @public
375
410
  * <p>The group name.</p>
376
411
  */
377
412
  GroupName: string | undefined;
@@ -394,14 +429,17 @@ export declare class UserNotFoundException extends __BaseException {
394
429
  */
395
430
  export interface AdminConfirmSignUpRequest {
396
431
  /**
432
+ * @public
397
433
  * <p>The user pool ID for which you want to confirm user registration.</p>
398
434
  */
399
435
  UserPoolId: string | undefined;
400
436
  /**
437
+ * @public
401
438
  * <p>The user name for which you want to confirm user registration.</p>
402
439
  */
403
440
  Username: string | undefined;
404
441
  /**
442
+ * @public
405
443
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
406
444
  * that this action triggers.</p>
407
445
  * <p>If your user pool configuration includes triggers, the AdminConfirmSignUp API action
@@ -537,10 +575,12 @@ export type MessageActionType = (typeof MessageActionType)[keyof typeof MessageA
537
575
  */
538
576
  export interface AttributeType {
539
577
  /**
578
+ * @public
540
579
  * <p>The name of the attribute.</p>
541
580
  */
542
581
  Name: string | undefined;
543
582
  /**
583
+ * @public
544
584
  * <p>The value of the attribute.</p>
545
585
  */
546
586
  Value?: string;
@@ -551,16 +591,19 @@ export interface AttributeType {
551
591
  */
552
592
  export interface AdminCreateUserRequest {
553
593
  /**
594
+ * @public
554
595
  * <p>The user pool ID for the user pool where the user will be created.</p>
555
596
  */
556
597
  UserPoolId: string | undefined;
557
598
  /**
599
+ * @public
558
600
  * <p>The username for the user. Must be unique within the user pool. Must be a UTF-8 string
559
601
  * between 1 and 128 characters. After the user is created, the username can't be
560
602
  * changed.</p>
561
603
  */
562
604
  Username: string | undefined;
563
605
  /**
606
+ * @public
564
607
  * <p>An array of name-value pairs that contain user attributes and attribute values to be
565
608
  * set for the user to be created. You can create a user without specifying any attributes
566
609
  * other than <code>Username</code>. However, any attributes that you specify as required
@@ -598,6 +641,7 @@ export interface AdminCreateUserRequest {
598
641
  */
599
642
  UserAttributes?: AttributeType[];
600
643
  /**
644
+ * @public
601
645
  * <p>The user's validation data. This is an array of name-value pairs that contain user
602
646
  * attributes and attribute values that you can use for custom validation, such as
603
647
  * restricting the types of user accounts that can be registered. For example, you might
@@ -609,6 +653,7 @@ export interface AdminCreateUserRequest {
609
653
  */
610
654
  ValidationData?: AttributeType[];
611
655
  /**
656
+ * @public
612
657
  * <p>The user's temporary password. This password must conform to the password policy that
613
658
  * you specified when you created the user pool.</p>
614
659
  * <p>The temporary password is valid only once. To complete the Admin Create User flow, the
@@ -623,6 +668,7 @@ export interface AdminCreateUserRequest {
623
668
  */
624
669
  TemporaryPassword?: string;
625
670
  /**
671
+ * @public
626
672
  * <p>This parameter is used only if the <code>phone_number_verified</code> or
627
673
  * <code>email_verified</code> attribute is set to <code>True</code>. Otherwise, it is
628
674
  * ignored.</p>
@@ -636,6 +682,7 @@ export interface AdminCreateUserRequest {
636
682
  */
637
683
  ForceAliasCreation?: boolean;
638
684
  /**
685
+ * @public
639
686
  * <p>Set to <code>RESEND</code> to resend the invitation message to a user that already
640
687
  * exists and reset the expiration limit on the user's account. Set to
641
688
  * <code>SUPPRESS</code> to suppress sending the message. You can specify only one
@@ -643,12 +690,14 @@ export interface AdminCreateUserRequest {
643
690
  */
644
691
  MessageAction?: MessageActionType | string;
645
692
  /**
693
+ * @public
646
694
  * <p>Specify <code>"EMAIL"</code> if email will be used to send the welcome message.
647
695
  * Specify <code>"SMS"</code> if the phone number will be used. The default value is
648
696
  * <code>"SMS"</code>. You can specify more than one value.</p>
649
697
  */
650
698
  DesiredDeliveryMediums?: (DeliveryMediumType | string)[];
651
699
  /**
700
+ * @public
652
701
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
653
702
  * that this action triggers.</p>
654
703
  * <p>You create custom workflows by assigning Lambda functions to user pool triggers.
@@ -692,11 +741,13 @@ export interface AdminCreateUserRequest {
692
741
  */
693
742
  export interface MFAOptionType {
694
743
  /**
744
+ * @public
695
745
  * <p>The delivery medium to send the MFA code. You can use this parameter to set only the
696
746
  * <code>SMS</code> delivery medium value.</p>
697
747
  */
698
748
  DeliveryMedium?: DeliveryMediumType | string;
699
749
  /**
750
+ * @public
700
751
  * <p>The attribute name of the MFA option type. The only valid value is
701
752
  * <code>phone_number</code>.</p>
702
753
  */
@@ -725,26 +776,32 @@ export type UserStatusType = (typeof UserStatusType)[keyof typeof UserStatusType
725
776
  */
726
777
  export interface UserType {
727
778
  /**
779
+ * @public
728
780
  * <p>The user name of the user you want to describe.</p>
729
781
  */
730
782
  Username?: string;
731
783
  /**
784
+ * @public
732
785
  * <p>A container with information about the user type attributes.</p>
733
786
  */
734
787
  Attributes?: AttributeType[];
735
788
  /**
789
+ * @public
736
790
  * <p>The creation date of the user.</p>
737
791
  */
738
792
  UserCreateDate?: Date;
739
793
  /**
794
+ * @public
740
795
  * <p>The last modified date of the user.</p>
741
796
  */
742
797
  UserLastModifiedDate?: Date;
743
798
  /**
799
+ * @public
744
800
  * <p>Specifies whether the user is enabled.</p>
745
801
  */
746
802
  Enabled?: boolean;
747
803
  /**
804
+ * @public
748
805
  * <p>The user status. This can be one of the following:</p>
749
806
  * <ul>
750
807
  * <li>
@@ -775,6 +832,7 @@ export interface UserType {
775
832
  */
776
833
  UserStatus?: UserStatusType | string;
777
834
  /**
835
+ * @public
778
836
  * <p>The MFA options for the user.</p>
779
837
  */
780
838
  MFAOptions?: MFAOptionType[];
@@ -785,6 +843,7 @@ export interface UserType {
785
843
  */
786
844
  export interface AdminCreateUserResponse {
787
845
  /**
846
+ * @public
788
847
  * <p>The newly created user.</p>
789
848
  */
790
849
  User?: UserType;
@@ -885,14 +944,17 @@ export declare class UsernameExistsException extends __BaseException {
885
944
  */
886
945
  export interface MessageTemplateType {
887
946
  /**
947
+ * @public
888
948
  * <p>The message template for SMS messages.</p>
889
949
  */
890
950
  SMSMessage?: string;
891
951
  /**
952
+ * @public
892
953
  * <p>The message template for email messages. EmailMessage is allowed only if <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount">EmailSendingAccount</a> is DEVELOPER. </p>
893
954
  */
894
955
  EmailMessage?: string;
895
956
  /**
957
+ * @public
896
958
  * <p>The subject line for email messages. EmailSubject is allowed only if <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount">EmailSendingAccount</a> is DEVELOPER. </p>
897
959
  */
898
960
  EmailSubject?: string;
@@ -903,11 +965,13 @@ export interface MessageTemplateType {
903
965
  */
904
966
  export interface AdminCreateUserConfigType {
905
967
  /**
968
+ * @public
906
969
  * <p>Set to <code>True</code> if only the administrator is allowed to create user profiles.
907
970
  * Set to <code>False</code> if users can sign themselves up via an app.</p>
908
971
  */
909
972
  AllowAdminCreateUserOnly?: boolean;
910
973
  /**
974
+ * @public
911
975
  * <p>The user account expiration limit, in days, after which a new account that hasn't
912
976
  * signed in is no longer usable. To reset the account after that time limit, you must call
913
977
  * <code>AdminCreateUser</code> again, specifying <code>"RESEND"</code> for the
@@ -921,6 +985,7 @@ export interface AdminCreateUserConfigType {
921
985
  */
922
986
  UnusedAccountValidityDays?: number;
923
987
  /**
988
+ * @public
924
989
  * <p>The message template to be used for the welcome message to new users.</p>
925
990
  * <p>See also <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization">Customizing User Invitation Messages</a>.</p>
926
991
  */
@@ -932,10 +997,12 @@ export interface AdminCreateUserConfigType {
932
997
  */
933
998
  export interface AdminDeleteUserRequest {
934
999
  /**
1000
+ * @public
935
1001
  * <p>The user pool ID for the user pool where you want to delete the user.</p>
936
1002
  */
937
1003
  UserPoolId: string | undefined;
938
1004
  /**
1005
+ * @public
939
1006
  * <p>The user name of the user you want to delete.</p>
940
1007
  */
941
1008
  Username: string | undefined;
@@ -946,14 +1013,17 @@ export interface AdminDeleteUserRequest {
946
1013
  */
947
1014
  export interface AdminDeleteUserAttributesRequest {
948
1015
  /**
1016
+ * @public
949
1017
  * <p>The user pool ID for the user pool where you want to delete user attributes.</p>
950
1018
  */
951
1019
  UserPoolId: string | undefined;
952
1020
  /**
1021
+ * @public
953
1022
  * <p>The user name of the user from which you would like to delete attributes.</p>
954
1023
  */
955
1024
  Username: string | undefined;
956
1025
  /**
1026
+ * @public
957
1027
  * <p>An array of strings representing the user attribute names you want to delete.</p>
958
1028
  * <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the
959
1029
  * attribute name.</p>
@@ -973,14 +1043,17 @@ export interface AdminDeleteUserAttributesResponse {
973
1043
  */
974
1044
  export interface ProviderUserIdentifierType {
975
1045
  /**
1046
+ * @public
976
1047
  * <p>The name of the provider, such as Facebook, Google, or Login with Amazon.</p>
977
1048
  */
978
1049
  ProviderName?: string;
979
1050
  /**
1051
+ * @public
980
1052
  * <p>The name of the provider attribute to link to, such as <code>NameID</code>.</p>
981
1053
  */
982
1054
  ProviderAttributeName?: string;
983
1055
  /**
1056
+ * @public
984
1057
  * <p>The value of the provider attribute to link to, such as
985
1058
  * <code>xxxxx_account</code>.</p>
986
1059
  */
@@ -991,10 +1064,12 @@ export interface ProviderUserIdentifierType {
991
1064
  */
992
1065
  export interface AdminDisableProviderForUserRequest {
993
1066
  /**
1067
+ * @public
994
1068
  * <p>The user pool ID for the user pool.</p>
995
1069
  */
996
1070
  UserPoolId: string | undefined;
997
1071
  /**
1072
+ * @public
998
1073
  * <p>The user to be disabled.</p>
999
1074
  */
1000
1075
  User: ProviderUserIdentifierType | undefined;
@@ -1026,10 +1101,12 @@ export declare class AliasExistsException extends __BaseException {
1026
1101
  */
1027
1102
  export interface AdminDisableUserRequest {
1028
1103
  /**
1104
+ * @public
1029
1105
  * <p>The user pool ID for the user pool where you want to disable the user.</p>
1030
1106
  */
1031
1107
  UserPoolId: string | undefined;
1032
1108
  /**
1109
+ * @public
1033
1110
  * <p>The user name of the user you want to disable.</p>
1034
1111
  */
1035
1112
  Username: string | undefined;
@@ -1047,10 +1124,12 @@ export interface AdminDisableUserResponse {
1047
1124
  */
1048
1125
  export interface AdminEnableUserRequest {
1049
1126
  /**
1127
+ * @public
1050
1128
  * <p>The user pool ID for the user pool where you want to enable the user.</p>
1051
1129
  */
1052
1130
  UserPoolId: string | undefined;
1053
1131
  /**
1132
+ * @public
1054
1133
  * <p>The user name of the user you want to enable.</p>
1055
1134
  */
1056
1135
  Username: string | undefined;
@@ -1068,14 +1147,17 @@ export interface AdminEnableUserResponse {
1068
1147
  */
1069
1148
  export interface AdminForgetDeviceRequest {
1070
1149
  /**
1150
+ * @public
1071
1151
  * <p>The user pool ID.</p>
1072
1152
  */
1073
1153
  UserPoolId: string | undefined;
1074
1154
  /**
1155
+ * @public
1075
1156
  * <p>The user name.</p>
1076
1157
  */
1077
1158
  Username: string | undefined;
1078
1159
  /**
1160
+ * @public
1079
1161
  * <p>The device key.</p>
1080
1162
  */
1081
1163
  DeviceKey: string | undefined;
@@ -1098,14 +1180,17 @@ export declare class InvalidUserPoolConfigurationException extends __BaseExcepti
1098
1180
  */
1099
1181
  export interface AdminGetDeviceRequest {
1100
1182
  /**
1183
+ * @public
1101
1184
  * <p>The device key.</p>
1102
1185
  */
1103
1186
  DeviceKey: string | undefined;
1104
1187
  /**
1188
+ * @public
1105
1189
  * <p>The user pool ID.</p>
1106
1190
  */
1107
1191
  UserPoolId: string | undefined;
1108
1192
  /**
1193
+ * @public
1109
1194
  * <p>The user name.</p>
1110
1195
  */
1111
1196
  Username: string | undefined;
@@ -1116,22 +1201,27 @@ export interface AdminGetDeviceRequest {
1116
1201
  */
1117
1202
  export interface DeviceType {
1118
1203
  /**
1204
+ * @public
1119
1205
  * <p>The device key.</p>
1120
1206
  */
1121
1207
  DeviceKey?: string;
1122
1208
  /**
1209
+ * @public
1123
1210
  * <p>The device attributes.</p>
1124
1211
  */
1125
1212
  DeviceAttributes?: AttributeType[];
1126
1213
  /**
1214
+ * @public
1127
1215
  * <p>The creation date of the device.</p>
1128
1216
  */
1129
1217
  DeviceCreateDate?: Date;
1130
1218
  /**
1219
+ * @public
1131
1220
  * <p>The last modified date of the device.</p>
1132
1221
  */
1133
1222
  DeviceLastModifiedDate?: Date;
1134
1223
  /**
1224
+ * @public
1135
1225
  * <p>The date when the device was last authenticated.</p>
1136
1226
  */
1137
1227
  DeviceLastAuthenticatedDate?: Date;
@@ -1142,6 +1232,7 @@ export interface DeviceType {
1142
1232
  */
1143
1233
  export interface AdminGetDeviceResponse {
1144
1234
  /**
1235
+ * @public
1145
1236
  * <p>The device.</p>
1146
1237
  */
1147
1238
  Device: DeviceType | undefined;
@@ -1152,11 +1243,13 @@ export interface AdminGetDeviceResponse {
1152
1243
  */
1153
1244
  export interface AdminGetUserRequest {
1154
1245
  /**
1246
+ * @public
1155
1247
  * <p>The user pool ID for the user pool where you want to get information about the
1156
1248
  * user.</p>
1157
1249
  */
1158
1250
  UserPoolId: string | undefined;
1159
1251
  /**
1252
+ * @public
1160
1253
  * <p>The user name of the user you want to retrieve.</p>
1161
1254
  */
1162
1255
  Username: string | undefined;
@@ -1168,26 +1261,32 @@ export interface AdminGetUserRequest {
1168
1261
  */
1169
1262
  export interface AdminGetUserResponse {
1170
1263
  /**
1264
+ * @public
1171
1265
  * <p>The user name of the user about whom you're receiving information.</p>
1172
1266
  */
1173
1267
  Username: string | undefined;
1174
1268
  /**
1269
+ * @public
1175
1270
  * <p>An array of name-value pairs representing user attributes.</p>
1176
1271
  */
1177
1272
  UserAttributes?: AttributeType[];
1178
1273
  /**
1274
+ * @public
1179
1275
  * <p>The date the user was created.</p>
1180
1276
  */
1181
1277
  UserCreateDate?: Date;
1182
1278
  /**
1279
+ * @public
1183
1280
  * <p>The date the user was last modified.</p>
1184
1281
  */
1185
1282
  UserLastModifiedDate?: Date;
1186
1283
  /**
1284
+ * @public
1187
1285
  * <p>Indicates that the status is <code>enabled</code>.</p>
1188
1286
  */
1189
1287
  Enabled?: boolean;
1190
1288
  /**
1289
+ * @public
1191
1290
  * <p>The user status. Can be one of the following:</p>
1192
1291
  * <ul>
1193
1292
  * <li>
@@ -1215,6 +1314,7 @@ export interface AdminGetUserResponse {
1215
1314
  */
1216
1315
  UserStatus?: UserStatusType | string;
1217
1316
  /**
1317
+ * @public
1218
1318
  * <p>
1219
1319
  * <i>This response parameter is no longer supported.</i> It provides
1220
1320
  * information only about SMS MFA configurations. It doesn't provide information about
@@ -1224,10 +1324,12 @@ export interface AdminGetUserResponse {
1224
1324
  */
1225
1325
  MFAOptions?: MFAOptionType[];
1226
1326
  /**
1327
+ * @public
1227
1328
  * <p>The user's preferred MFA setting.</p>
1228
1329
  */
1229
1330
  PreferredMfaSetting?: string;
1230
1331
  /**
1332
+ * @public
1231
1333
  * <p>The MFA options that are activated for the user. The possible values in this list are
1232
1334
  * <code>SMS_MFA</code> and <code>SOFTWARE_TOKEN_MFA</code>.</p>
1233
1335
  */
@@ -1242,6 +1344,7 @@ export interface AdminGetUserResponse {
1242
1344
  */
1243
1345
  export interface AnalyticsMetadataType {
1244
1346
  /**
1347
+ * @public
1245
1348
  * <p>The endpoint ID.</p>
1246
1349
  */
1247
1350
  AnalyticsEndpointId?: string;
@@ -1269,10 +1372,12 @@ export type AuthFlowType = (typeof AuthFlowType)[keyof typeof AuthFlowType];
1269
1372
  */
1270
1373
  export interface HttpHeader {
1271
1374
  /**
1375
+ * @public
1272
1376
  * <p>The header name.</p>
1273
1377
  */
1274
1378
  headerName?: string;
1275
1379
  /**
1380
+ * @public
1276
1381
  * <p>The header value.</p>
1277
1382
  */
1278
1383
  headerValue?: string;
@@ -1284,22 +1389,27 @@ export interface HttpHeader {
1284
1389
  */
1285
1390
  export interface ContextDataType {
1286
1391
  /**
1392
+ * @public
1287
1393
  * <p>The source IP address of your user's device.</p>
1288
1394
  */
1289
1395
  IpAddress: string | undefined;
1290
1396
  /**
1397
+ * @public
1291
1398
  * <p>Your server endpoint where this API is invoked.</p>
1292
1399
  */
1293
1400
  ServerName: string | undefined;
1294
1401
  /**
1402
+ * @public
1295
1403
  * <p>Your server path where this API is invoked.</p>
1296
1404
  */
1297
1405
  ServerPath: string | undefined;
1298
1406
  /**
1407
+ * @public
1299
1408
  * <p>HttpHeaders received on your server in same order.</p>
1300
1409
  */
1301
1410
  HttpHeaders: HttpHeader[] | undefined;
1302
1411
  /**
1412
+ * @public
1303
1413
  * <p>Encoded device-fingerprint details that your app collected with the Amazon Cognito
1304
1414
  * context data collection library. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint">Adding user device and session data to API requests</a>.</p>
1305
1415
  */
@@ -1311,14 +1421,17 @@ export interface ContextDataType {
1311
1421
  */
1312
1422
  export interface AdminInitiateAuthRequest {
1313
1423
  /**
1424
+ * @public
1314
1425
  * <p>The ID of the Amazon Cognito user pool.</p>
1315
1426
  */
1316
1427
  UserPoolId: string | undefined;
1317
1428
  /**
1429
+ * @public
1318
1430
  * <p>The app client ID.</p>
1319
1431
  */
1320
1432
  ClientId: string | undefined;
1321
1433
  /**
1434
+ * @public
1322
1435
  * <p>The authentication flow for this call to run. The API action will depend on this
1323
1436
  * value. For example:</p>
1324
1437
  * <ul>
@@ -1373,6 +1486,7 @@ export interface AdminInitiateAuthRequest {
1373
1486
  */
1374
1487
  AuthFlow: AuthFlowType | string | undefined;
1375
1488
  /**
1489
+ * @public
1376
1490
  * <p>The authentication parameters. These are inputs corresponding to the
1377
1491
  * <code>AuthFlow</code> that you're invoking. The required values depend on the value
1378
1492
  * of <code>AuthFlow</code>:</p>
@@ -1403,6 +1517,7 @@ export interface AdminInitiateAuthRequest {
1403
1517
  */
1404
1518
  AuthParameters?: Record<string, string>;
1405
1519
  /**
1520
+ * @public
1406
1521
  * <p>A map of custom key-value pairs that you can provide as input for certain custom
1407
1522
  * workflows that this action triggers.</p>
1408
1523
  * <p>You create custom workflows by assigning Lambda functions to user pool triggers.
@@ -1472,11 +1587,13 @@ export interface AdminInitiateAuthRequest {
1472
1587
  */
1473
1588
  ClientMetadata?: Record<string, string>;
1474
1589
  /**
1590
+ * @public
1475
1591
  * <p>The analytics metadata for collecting Amazon Pinpoint metrics for
1476
1592
  * <code>AdminInitiateAuth</code> calls.</p>
1477
1593
  */
1478
1594
  AnalyticsMetadata?: AnalyticsMetadataType;
1479
1595
  /**
1596
+ * @public
1480
1597
  * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
1481
1598
  * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
1482
1599
  * when it makes API requests.</p>
@@ -1489,10 +1606,12 @@ export interface AdminInitiateAuthRequest {
1489
1606
  */
1490
1607
  export interface NewDeviceMetadataType {
1491
1608
  /**
1609
+ * @public
1492
1610
  * <p>The device key.</p>
1493
1611
  */
1494
1612
  DeviceKey?: string;
1495
1613
  /**
1614
+ * @public
1496
1615
  * <p>The device group key.</p>
1497
1616
  */
1498
1617
  DeviceGroupKey?: string;
@@ -1503,27 +1622,33 @@ export interface NewDeviceMetadataType {
1503
1622
  */
1504
1623
  export interface AuthenticationResultType {
1505
1624
  /**
1625
+ * @public
1506
1626
  * <p>A valid access token that Amazon Cognito issued to the user who you want to
1507
1627
  * authenticate.</p>
1508
1628
  */
1509
1629
  AccessToken?: string;
1510
1630
  /**
1631
+ * @public
1511
1632
  * <p>The expiration period of the authentication result in seconds.</p>
1512
1633
  */
1513
1634
  ExpiresIn?: number;
1514
1635
  /**
1636
+ * @public
1515
1637
  * <p>The token type.</p>
1516
1638
  */
1517
1639
  TokenType?: string;
1518
1640
  /**
1641
+ * @public
1519
1642
  * <p>The refresh token.</p>
1520
1643
  */
1521
1644
  RefreshToken?: string;
1522
1645
  /**
1646
+ * @public
1523
1647
  * <p>The ID token.</p>
1524
1648
  */
1525
1649
  IdToken?: string;
1526
1650
  /**
1651
+ * @public
1527
1652
  * <p>The new device metadata from an authentication result.</p>
1528
1653
  */
1529
1654
  NewDeviceMetadata?: NewDeviceMetadataType;
@@ -1554,6 +1679,7 @@ export type ChallengeNameType = (typeof ChallengeNameType)[keyof typeof Challeng
1554
1679
  */
1555
1680
  export interface AdminInitiateAuthResponse {
1556
1681
  /**
1682
+ * @public
1557
1683
  * <p>The name of the challenge that you're responding to with this call. This is returned
1558
1684
  * in the <code>AdminInitiateAuth</code> response if you must pass another
1559
1685
  * challenge.</p>
@@ -1638,6 +1764,7 @@ export interface AdminInitiateAuthResponse {
1638
1764
  */
1639
1765
  ChallengeName?: ChallengeNameType | string;
1640
1766
  /**
1767
+ * @public
1641
1768
  * <p>The session that should be passed both ways in challenge-response calls to the
1642
1769
  * service. If <code>AdminInitiateAuth</code> or <code>AdminRespondToAuthChallenge</code>
1643
1770
  * API call determines that the caller must pass another challenge, they return a session
@@ -1646,6 +1773,7 @@ export interface AdminInitiateAuthResponse {
1646
1773
  */
1647
1774
  Session?: string;
1648
1775
  /**
1776
+ * @public
1649
1777
  * <p>The challenge parameters. These are returned to you in the
1650
1778
  * <code>AdminInitiateAuth</code> response if you must pass another challenge. The
1651
1779
  * responses in this parameter should be used to compute inputs to the next call
@@ -1660,6 +1788,7 @@ export interface AdminInitiateAuthResponse {
1660
1788
  */
1661
1789
  ChallengeParameters?: Record<string, string>;
1662
1790
  /**
1791
+ * @public
1663
1792
  * <p>The result of the authentication response. This is only returned if the caller doesn't
1664
1793
  * need to pass another challenge. If the caller does need to pass another challenge before
1665
1794
  * it gets tokens, <code>ChallengeName</code>, <code>ChallengeParameters</code>, and
@@ -1709,10 +1838,12 @@ export declare class UserNotConfirmedException extends __BaseException {
1709
1838
  */
1710
1839
  export interface AdminLinkProviderForUserRequest {
1711
1840
  /**
1841
+ * @public
1712
1842
  * <p>The user pool ID for the user pool.</p>
1713
1843
  */
1714
1844
  UserPoolId: string | undefined;
1715
1845
  /**
1846
+ * @public
1716
1847
  * <p>The existing user in the user pool that you want to assign to the external IdP user
1717
1848
  * account. This user can be a native (Username + Password) Amazon Cognito user pools user or a
1718
1849
  * federated user (for example, a SAML or Facebook user). If the user doesn't exist, Amazon Cognito
@@ -1733,6 +1864,7 @@ export interface AdminLinkProviderForUserRequest {
1733
1864
  */
1734
1865
  DestinationUser: ProviderUserIdentifierType | undefined;
1735
1866
  /**
1867
+ * @public
1736
1868
  * <p>An external IdP account for a user who doesn't exist yet in the user pool. This user
1737
1869
  * must be a federated user (for example, a SAML or Facebook user), not another native
1738
1870
  * user.</p>
@@ -1767,18 +1899,22 @@ export interface AdminLinkProviderForUserResponse {
1767
1899
  */
1768
1900
  export interface AdminListDevicesRequest {
1769
1901
  /**
1902
+ * @public
1770
1903
  * <p>The user pool ID.</p>
1771
1904
  */
1772
1905
  UserPoolId: string | undefined;
1773
1906
  /**
1907
+ * @public
1774
1908
  * <p>The user name.</p>
1775
1909
  */
1776
1910
  Username: string | undefined;
1777
1911
  /**
1912
+ * @public
1778
1913
  * <p>The limit of the devices request.</p>
1779
1914
  */
1780
1915
  Limit?: number;
1781
1916
  /**
1917
+ * @public
1782
1918
  * <p>The pagination token.</p>
1783
1919
  */
1784
1920
  PaginationToken?: string;
@@ -1789,10 +1925,12 @@ export interface AdminListDevicesRequest {
1789
1925
  */
1790
1926
  export interface AdminListDevicesResponse {
1791
1927
  /**
1928
+ * @public
1792
1929
  * <p>The devices in the list of devices response.</p>
1793
1930
  */
1794
1931
  Devices?: DeviceType[];
1795
1932
  /**
1933
+ * @public
1796
1934
  * <p>The pagination token.</p>
1797
1935
  */
1798
1936
  PaginationToken?: string;
@@ -1802,18 +1940,22 @@ export interface AdminListDevicesResponse {
1802
1940
  */
1803
1941
  export interface AdminListGroupsForUserRequest {
1804
1942
  /**
1943
+ * @public
1805
1944
  * <p>The username for the user.</p>
1806
1945
  */
1807
1946
  Username: string | undefined;
1808
1947
  /**
1948
+ * @public
1809
1949
  * <p>The user pool ID for the user pool.</p>
1810
1950
  */
1811
1951
  UserPoolId: string | undefined;
1812
1952
  /**
1953
+ * @public
1813
1954
  * <p>The limit of the request to list groups.</p>
1814
1955
  */
1815
1956
  Limit?: number;
1816
1957
  /**
1958
+ * @public
1817
1959
  * <p>An identifier that was returned from the previous call to this operation, which can be
1818
1960
  * used to return the next set of items in the list.</p>
1819
1961
  */
@@ -1825,22 +1967,27 @@ export interface AdminListGroupsForUserRequest {
1825
1967
  */
1826
1968
  export interface GroupType {
1827
1969
  /**
1970
+ * @public
1828
1971
  * <p>The name of the group.</p>
1829
1972
  */
1830
1973
  GroupName?: string;
1831
1974
  /**
1975
+ * @public
1832
1976
  * <p>The user pool ID for the user pool.</p>
1833
1977
  */
1834
1978
  UserPoolId?: string;
1835
1979
  /**
1980
+ * @public
1836
1981
  * <p>A string containing the description of the group.</p>
1837
1982
  */
1838
1983
  Description?: string;
1839
1984
  /**
1985
+ * @public
1840
1986
  * <p>The role Amazon Resource Name (ARN) for the group.</p>
1841
1987
  */
1842
1988
  RoleArn?: string;
1843
1989
  /**
1990
+ * @public
1844
1991
  * <p>A non-negative integer value that specifies the precedence of this group relative to
1845
1992
  * the other groups that a user can belong to in the user pool. Zero is the highest
1846
1993
  * precedence value. Groups with lower <code>Precedence</code> values take precedence over
@@ -1858,10 +2005,12 @@ export interface GroupType {
1858
2005
  */
1859
2006
  Precedence?: number;
1860
2007
  /**
2008
+ * @public
1861
2009
  * <p>The date the group was last modified.</p>
1862
2010
  */
1863
2011
  LastModifiedDate?: Date;
1864
2012
  /**
2013
+ * @public
1865
2014
  * <p>The date the group was created.</p>
1866
2015
  */
1867
2016
  CreationDate?: Date;
@@ -1871,10 +2020,12 @@ export interface GroupType {
1871
2020
  */
1872
2021
  export interface AdminListGroupsForUserResponse {
1873
2022
  /**
2023
+ * @public
1874
2024
  * <p>The groups that the user belongs to.</p>
1875
2025
  */
1876
2026
  Groups?: GroupType[];
1877
2027
  /**
2028
+ * @public
1878
2029
  * <p>An identifier that was returned from the previous call to this operation, which can be
1879
2030
  * used to return the next set of items in the list.</p>
1880
2031
  */
@@ -1885,20 +2036,24 @@ export interface AdminListGroupsForUserResponse {
1885
2036
  */
1886
2037
  export interface AdminListUserAuthEventsRequest {
1887
2038
  /**
2039
+ * @public
1888
2040
  * <p>The user pool ID.</p>
1889
2041
  */
1890
2042
  UserPoolId: string | undefined;
1891
2043
  /**
2044
+ * @public
1892
2045
  * <p>The user pool username or an alias.</p>
1893
2046
  */
1894
2047
  Username: string | undefined;
1895
2048
  /**
2049
+ * @public
1896
2050
  * <p>The maximum number of authentication events to return. Returns 60 events if you set
1897
2051
  * <code>MaxResults</code> to 0, or if you don't include a <code>MaxResults</code>
1898
2052
  * parameter.</p>
1899
2053
  */
1900
2054
  MaxResults?: number;
1901
2055
  /**
2056
+ * @public
1902
2057
  * <p>A pagination token.</p>
1903
2058
  */
1904
2059
  NextToken?: string;
@@ -1933,10 +2088,12 @@ export type ChallengeResponse = (typeof ChallengeResponse)[keyof typeof Challeng
1933
2088
  */
1934
2089
  export interface ChallengeResponseType {
1935
2090
  /**
2091
+ * @public
1936
2092
  * <p>The challenge name.</p>
1937
2093
  */
1938
2094
  ChallengeName?: ChallengeName | string;
1939
2095
  /**
2096
+ * @public
1940
2097
  * <p>The challenge response.</p>
1941
2098
  */
1942
2099
  ChallengeResponse?: ChallengeResponse | string;
@@ -1947,22 +2104,27 @@ export interface ChallengeResponseType {
1947
2104
  */
1948
2105
  export interface EventContextDataType {
1949
2106
  /**
2107
+ * @public
1950
2108
  * <p>The source IP address of your user's device.</p>
1951
2109
  */
1952
2110
  IpAddress?: string;
1953
2111
  /**
2112
+ * @public
1954
2113
  * <p>The user's device name.</p>
1955
2114
  */
1956
2115
  DeviceName?: string;
1957
2116
  /**
2117
+ * @public
1958
2118
  * <p>The user's time zone.</p>
1959
2119
  */
1960
2120
  Timezone?: string;
1961
2121
  /**
2122
+ * @public
1962
2123
  * <p>The user's city.</p>
1963
2124
  */
1964
2125
  City?: string;
1965
2126
  /**
2127
+ * @public
1966
2128
  * <p>The user's country.</p>
1967
2129
  */
1968
2130
  Country?: string;
@@ -1985,14 +2147,17 @@ export type FeedbackValueType = (typeof FeedbackValueType)[keyof typeof Feedback
1985
2147
  */
1986
2148
  export interface EventFeedbackType {
1987
2149
  /**
2150
+ * @public
1988
2151
  * <p>The event feedback value.</p>
1989
2152
  */
1990
2153
  FeedbackValue: FeedbackValueType | string | undefined;
1991
2154
  /**
2155
+ * @public
1992
2156
  * <p>The provider.</p>
1993
2157
  */
1994
2158
  Provider: string | undefined;
1995
2159
  /**
2160
+ * @public
1996
2161
  * <p>The event feedback date.</p>
1997
2162
  */
1998
2163
  FeedbackDate?: Date;
@@ -2042,14 +2207,17 @@ export type RiskLevelType = (typeof RiskLevelType)[keyof typeof RiskLevelType];
2042
2207
  */
2043
2208
  export interface EventRiskType {
2044
2209
  /**
2210
+ * @public
2045
2211
  * <p>The risk decision.</p>
2046
2212
  */
2047
2213
  RiskDecision?: RiskDecisionType | string;
2048
2214
  /**
2215
+ * @public
2049
2216
  * <p>The risk level.</p>
2050
2217
  */
2051
2218
  RiskLevel?: RiskLevelType | string;
2052
2219
  /**
2220
+ * @public
2053
2221
  * <p>Indicates whether compromised credentials were detected during an authentication
2054
2222
  * event.</p>
2055
2223
  */
@@ -2076,35 +2244,43 @@ export type EventType = (typeof EventType)[keyof typeof EventType];
2076
2244
  */
2077
2245
  export interface AuthEventType {
2078
2246
  /**
2247
+ * @public
2079
2248
  * <p>The event ID.</p>
2080
2249
  */
2081
2250
  EventId?: string;
2082
2251
  /**
2252
+ * @public
2083
2253
  * <p>The event type.</p>
2084
2254
  */
2085
2255
  EventType?: EventType | string;
2086
2256
  /**
2257
+ * @public
2087
2258
  * <p>The creation date</p>
2088
2259
  */
2089
2260
  CreationDate?: Date;
2090
2261
  /**
2262
+ * @public
2091
2263
  * <p>The event response.</p>
2092
2264
  */
2093
2265
  EventResponse?: EventResponseType | string;
2094
2266
  /**
2267
+ * @public
2095
2268
  * <p>The event risk.</p>
2096
2269
  */
2097
2270
  EventRisk?: EventRiskType;
2098
2271
  /**
2272
+ * @public
2099
2273
  * <p>The challenge responses.</p>
2100
2274
  */
2101
2275
  ChallengeResponses?: ChallengeResponseType[];
2102
2276
  /**
2277
+ * @public
2103
2278
  * <p>The user context data captured at the time of an event request. This value provides
2104
2279
  * additional information about the client from which event the request is received.</p>
2105
2280
  */
2106
2281
  EventContextData?: EventContextDataType;
2107
2282
  /**
2283
+ * @public
2108
2284
  * <p>A flag specifying the user feedback captured at the time of an event request is good
2109
2285
  * or bad. </p>
2110
2286
  */
@@ -2115,12 +2291,14 @@ export interface AuthEventType {
2115
2291
  */
2116
2292
  export interface AdminListUserAuthEventsResponse {
2117
2293
  /**
2294
+ * @public
2118
2295
  * <p>The response object. It includes the <code>EventID</code>, <code>EventType</code>,
2119
2296
  * <code>CreationDate</code>, <code>EventRisk</code>, and
2120
2297
  * <code>EventResponse</code>.</p>
2121
2298
  */
2122
2299
  AuthEvents?: AuthEventType[];
2123
2300
  /**
2301
+ * @public
2124
2302
  * <p>A pagination token.</p>
2125
2303
  */
2126
2304
  NextToken?: string;
@@ -2142,14 +2320,17 @@ export declare class UserPoolAddOnNotEnabledException extends __BaseException {
2142
2320
  */
2143
2321
  export interface AdminRemoveUserFromGroupRequest {
2144
2322
  /**
2323
+ * @public
2145
2324
  * <p>The user pool ID for the user pool.</p>
2146
2325
  */
2147
2326
  UserPoolId: string | undefined;
2148
2327
  /**
2328
+ * @public
2149
2329
  * <p>The username for the user.</p>
2150
2330
  */
2151
2331
  Username: string | undefined;
2152
2332
  /**
2333
+ * @public
2153
2334
  * <p>The group name.</p>
2154
2335
  */
2155
2336
  GroupName: string | undefined;
@@ -2160,14 +2341,17 @@ export interface AdminRemoveUserFromGroupRequest {
2160
2341
  */
2161
2342
  export interface AdminResetUserPasswordRequest {
2162
2343
  /**
2344
+ * @public
2163
2345
  * <p>The user pool ID for the user pool where you want to reset the user's password.</p>
2164
2346
  */
2165
2347
  UserPoolId: string | undefined;
2166
2348
  /**
2349
+ * @public
2167
2350
  * <p>The user name of the user whose password you want to reset.</p>
2168
2351
  */
2169
2352
  Username: string | undefined;
2170
2353
  /**
2354
+ * @public
2171
2355
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
2172
2356
  * that this action triggers.</p>
2173
2357
  * <p>You create custom workflows by assigning Lambda functions to user pool
@@ -2228,18 +2412,22 @@ export declare class InvalidEmailRoleAccessPolicyException extends __BaseExcepti
2228
2412
  */
2229
2413
  export interface AdminRespondToAuthChallengeRequest {
2230
2414
  /**
2415
+ * @public
2231
2416
  * <p>The ID of the Amazon Cognito user pool.</p>
2232
2417
  */
2233
2418
  UserPoolId: string | undefined;
2234
2419
  /**
2420
+ * @public
2235
2421
  * <p>The app client ID.</p>
2236
2422
  */
2237
2423
  ClientId: string | undefined;
2238
2424
  /**
2425
+ * @public
2239
2426
  * <p>The challenge name. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html">AdminInitiateAuth</a>.</p>
2240
2427
  */
2241
2428
  ChallengeName: ChallengeNameType | string | undefined;
2242
2429
  /**
2430
+ * @public
2243
2431
  * <p>The challenge responses. These are inputs corresponding to the value of
2244
2432
  * <code>ChallengeName</code>, for example:</p>
2245
2433
  * <ul>
@@ -2298,6 +2486,7 @@ export interface AdminRespondToAuthChallengeRequest {
2298
2486
  */
2299
2487
  ChallengeResponses?: Record<string, string>;
2300
2488
  /**
2489
+ * @public
2301
2490
  * <p>The session that should be passed both ways in challenge-response calls to the
2302
2491
  * service. If an <code>InitiateAuth</code> or <code>RespondToAuthChallenge</code> API call
2303
2492
  * determines that the caller must pass another challenge, it returns a session with other
@@ -2306,17 +2495,20 @@ export interface AdminRespondToAuthChallengeRequest {
2306
2495
  */
2307
2496
  Session?: string;
2308
2497
  /**
2498
+ * @public
2309
2499
  * <p>The analytics metadata for collecting Amazon Pinpoint metrics for
2310
2500
  * <code>AdminRespondToAuthChallenge</code> calls.</p>
2311
2501
  */
2312
2502
  AnalyticsMetadata?: AnalyticsMetadataType;
2313
2503
  /**
2504
+ * @public
2314
2505
  * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
2315
2506
  * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
2316
2507
  * when it makes API requests.</p>
2317
2508
  */
2318
2509
  ContextData?: ContextDataType;
2319
2510
  /**
2511
+ * @public
2320
2512
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
2321
2513
  * that this action triggers.</p>
2322
2514
  * <p>You create custom workflows by assigning Lambda functions to user pool triggers.
@@ -2384,10 +2576,12 @@ export interface AdminRespondToAuthChallengeRequest {
2384
2576
  */
2385
2577
  export interface AdminRespondToAuthChallengeResponse {
2386
2578
  /**
2579
+ * @public
2387
2580
  * <p>The name of the challenge. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html">AdminInitiateAuth</a>.</p>
2388
2581
  */
2389
2582
  ChallengeName?: ChallengeNameType | string;
2390
2583
  /**
2584
+ * @public
2391
2585
  * <p>The session that should be passed both ways in challenge-response calls to the
2392
2586
  * service. If the caller must pass another challenge, they return a session with other
2393
2587
  * challenge parameters. This session should be passed as it is to the next
@@ -2395,10 +2589,12 @@ export interface AdminRespondToAuthChallengeResponse {
2395
2589
  */
2396
2590
  Session?: string;
2397
2591
  /**
2592
+ * @public
2398
2593
  * <p>The challenge parameters. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html">AdminInitiateAuth</a>.</p>
2399
2594
  */
2400
2595
  ChallengeParameters?: Record<string, string>;
2401
2596
  /**
2597
+ * @public
2402
2598
  * <p>The result returned by the server in response to the authentication request.</p>
2403
2599
  */
2404
2600
  AuthenticationResult?: AuthenticationResultType;
@@ -2452,12 +2648,14 @@ export declare class SoftwareTokenMFANotFoundException extends __BaseException {
2452
2648
  */
2453
2649
  export interface SMSMfaSettingsType {
2454
2650
  /**
2651
+ * @public
2455
2652
  * <p>Specifies whether SMS text message MFA is activated. If an MFA type is activated for a
2456
2653
  * user, the user will be prompted for MFA during all sign-in attempts, unless device
2457
2654
  * tracking is turned on and the device has been trusted.</p>
2458
2655
  */
2459
2656
  Enabled?: boolean;
2460
2657
  /**
2658
+ * @public
2461
2659
  * <p>Specifies whether SMS is the preferred MFA method.</p>
2462
2660
  */
2463
2661
  PreferredMfa?: boolean;
@@ -2472,12 +2670,14 @@ export interface SMSMfaSettingsType {
2472
2670
  */
2473
2671
  export interface SoftwareTokenMfaSettingsType {
2474
2672
  /**
2673
+ * @public
2475
2674
  * <p>Specifies whether software token MFA is activated. If an MFA type is activated for a
2476
2675
  * user, the user will be prompted for MFA during all sign-in attempts, unless device
2477
2676
  * tracking is turned on and the device has been trusted.</p>
2478
2677
  */
2479
2678
  Enabled?: boolean;
2480
2679
  /**
2680
+ * @public
2481
2681
  * <p>Specifies whether software token MFA is the preferred MFA method.</p>
2482
2682
  */
2483
2683
  PreferredMfa?: boolean;
@@ -2487,18 +2687,22 @@ export interface SoftwareTokenMfaSettingsType {
2487
2687
  */
2488
2688
  export interface AdminSetUserMFAPreferenceRequest {
2489
2689
  /**
2690
+ * @public
2490
2691
  * <p>The SMS text message MFA settings.</p>
2491
2692
  */
2492
2693
  SMSMfaSettings?: SMSMfaSettingsType;
2493
2694
  /**
2695
+ * @public
2494
2696
  * <p>The time-based one-time password software token MFA settings.</p>
2495
2697
  */
2496
2698
  SoftwareTokenMfaSettings?: SoftwareTokenMfaSettingsType;
2497
2699
  /**
2700
+ * @public
2498
2701
  * <p>The user pool username or alias.</p>
2499
2702
  */
2500
2703
  Username: string | undefined;
2501
2704
  /**
2705
+ * @public
2502
2706
  * <p>The user pool ID.</p>
2503
2707
  */
2504
2708
  UserPoolId: string | undefined;
@@ -2513,18 +2717,22 @@ export interface AdminSetUserMFAPreferenceResponse {
2513
2717
  */
2514
2718
  export interface AdminSetUserPasswordRequest {
2515
2719
  /**
2720
+ * @public
2516
2721
  * <p>The user pool ID for the user pool where you want to set the user's password.</p>
2517
2722
  */
2518
2723
  UserPoolId: string | undefined;
2519
2724
  /**
2725
+ * @public
2520
2726
  * <p>The user name of the user whose password you want to set.</p>
2521
2727
  */
2522
2728
  Username: string | undefined;
2523
2729
  /**
2730
+ * @public
2524
2731
  * <p>The password for the user.</p>
2525
2732
  */
2526
2733
  Password: string | undefined;
2527
2734
  /**
2735
+ * @public
2528
2736
  * <p>
2529
2737
  * <code>True</code> if the password is permanent, <code>False</code> if it is
2530
2738
  * temporary.</p>
@@ -2543,14 +2751,17 @@ export interface AdminSetUserPasswordResponse {
2543
2751
  */
2544
2752
  export interface AdminSetUserSettingsRequest {
2545
2753
  /**
2754
+ * @public
2546
2755
  * <p>The ID of the user pool that contains the user whose options you're setting.</p>
2547
2756
  */
2548
2757
  UserPoolId: string | undefined;
2549
2758
  /**
2759
+ * @public
2550
2760
  * <p>The user name of the user whose options you're setting.</p>
2551
2761
  */
2552
2762
  Username: string | undefined;
2553
2763
  /**
2764
+ * @public
2554
2765
  * <p>You can use this parameter only to set an SMS configuration that uses SMS for
2555
2766
  * delivery.</p>
2556
2767
  */
@@ -2568,18 +2779,22 @@ export interface AdminSetUserSettingsResponse {
2568
2779
  */
2569
2780
  export interface AdminUpdateAuthEventFeedbackRequest {
2570
2781
  /**
2782
+ * @public
2571
2783
  * <p>The user pool ID.</p>
2572
2784
  */
2573
2785
  UserPoolId: string | undefined;
2574
2786
  /**
2787
+ * @public
2575
2788
  * <p>The user pool username.</p>
2576
2789
  */
2577
2790
  Username: string | undefined;
2578
2791
  /**
2792
+ * @public
2579
2793
  * <p>The authentication event ID.</p>
2580
2794
  */
2581
2795
  EventId: string | undefined;
2582
2796
  /**
2797
+ * @public
2583
2798
  * <p>The authentication event feedback value.</p>
2584
2799
  */
2585
2800
  FeedbackValue: FeedbackValueType | string | undefined;
@@ -2607,18 +2822,22 @@ export type DeviceRememberedStatusType = (typeof DeviceRememberedStatusType)[key
2607
2822
  */
2608
2823
  export interface AdminUpdateDeviceStatusRequest {
2609
2824
  /**
2825
+ * @public
2610
2826
  * <p>The user pool ID.</p>
2611
2827
  */
2612
2828
  UserPoolId: string | undefined;
2613
2829
  /**
2830
+ * @public
2614
2831
  * <p>The user name.</p>
2615
2832
  */
2616
2833
  Username: string | undefined;
2617
2834
  /**
2835
+ * @public
2618
2836
  * <p>The device key.</p>
2619
2837
  */
2620
2838
  DeviceKey: string | undefined;
2621
2839
  /**
2840
+ * @public
2622
2841
  * <p>The status indicating whether a device has been remembered or not.</p>
2623
2842
  */
2624
2843
  DeviceRememberedStatus?: DeviceRememberedStatusType | string;
@@ -2635,14 +2854,17 @@ export interface AdminUpdateDeviceStatusResponse {
2635
2854
  */
2636
2855
  export interface AdminUpdateUserAttributesRequest {
2637
2856
  /**
2857
+ * @public
2638
2858
  * <p>The user pool ID for the user pool where you want to update user attributes.</p>
2639
2859
  */
2640
2860
  UserPoolId: string | undefined;
2641
2861
  /**
2862
+ * @public
2642
2863
  * <p>The user name of the user for whom you want to update user attributes.</p>
2643
2864
  */
2644
2865
  Username: string | undefined;
2645
2866
  /**
2867
+ * @public
2646
2868
  * <p>An array of name-value pairs representing user attributes.</p>
2647
2869
  * <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the
2648
2870
  * attribute name.</p>
@@ -2660,6 +2882,7 @@ export interface AdminUpdateUserAttributesRequest {
2660
2882
  */
2661
2883
  UserAttributes: AttributeType[] | undefined;
2662
2884
  /**
2885
+ * @public
2663
2886
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
2664
2887
  * that this action triggers.</p>
2665
2888
  * <p>You create custom workflows by assigning Lambda functions to user pool
@@ -2708,10 +2931,12 @@ export interface AdminUpdateUserAttributesResponse {
2708
2931
  */
2709
2932
  export interface AdminUserGlobalSignOutRequest {
2710
2933
  /**
2934
+ * @public
2711
2935
  * <p>The user pool ID.</p>
2712
2936
  */
2713
2937
  UserPoolId: string | undefined;
2714
2938
  /**
2939
+ * @public
2715
2940
  * <p>The user name.</p>
2716
2941
  */
2717
2942
  Username: string | undefined;
@@ -2760,25 +2985,30 @@ export type AliasAttributeType = (typeof AliasAttributeType)[keyof typeof AliasA
2760
2985
  */
2761
2986
  export interface AnalyticsConfigurationType {
2762
2987
  /**
2988
+ * @public
2763
2989
  * <p>The application ID for an Amazon Pinpoint application.</p>
2764
2990
  */
2765
2991
  ApplicationId?: string;
2766
2992
  /**
2993
+ * @public
2767
2994
  * <p>The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project
2768
2995
  * to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint
2769
2996
  * project that the app ARN declares.</p>
2770
2997
  */
2771
2998
  ApplicationArn?: string;
2772
2999
  /**
3000
+ * @public
2773
3001
  * <p>The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint
2774
3002
  * analytics.</p>
2775
3003
  */
2776
3004
  RoleArn?: string;
2777
3005
  /**
3006
+ * @public
2778
3007
  * <p>The external ID.</p>
2779
3008
  */
2780
3009
  ExternalId?: string;
2781
3010
  /**
3011
+ * @public
2782
3012
  * <p>If <code>UserDataShared</code> is <code>true</code>, Amazon Cognito includes user data in the
2783
3013
  * events that it publishes to Amazon Pinpoint analytics.</p>
2784
3014
  */
@@ -2789,11 +3019,13 @@ export interface AnalyticsConfigurationType {
2789
3019
  */
2790
3020
  export interface AssociateSoftwareTokenRequest {
2791
3021
  /**
3022
+ * @public
2792
3023
  * <p>A valid access token that Amazon Cognito issued to the user whose software token you want to
2793
3024
  * generate.</p>
2794
3025
  */
2795
3026
  AccessToken?: string;
2796
3027
  /**
3028
+ * @public
2797
3029
  * <p>The session that should be passed both ways in challenge-response calls to the
2798
3030
  * service. This allows authentication of the user as part of the MFA setup process.</p>
2799
3031
  */
@@ -2804,11 +3036,13 @@ export interface AssociateSoftwareTokenRequest {
2804
3036
  */
2805
3037
  export interface AssociateSoftwareTokenResponse {
2806
3038
  /**
3039
+ * @public
2807
3040
  * <p>A unique generated shared secret code that is used in the
2808
3041
  * TOTP algorithm to generate a one-time code.</p>
2809
3042
  */
2810
3043
  SecretCode?: string;
2811
3044
  /**
3045
+ * @public
2812
3046
  * <p>The session that should be passed both ways in challenge-response calls to the
2813
3047
  * service. This allows authentication of the user as part of the MFA setup process.</p>
2814
3048
  */
@@ -2857,14 +3091,17 @@ export type VerifiedAttributeType = (typeof VerifiedAttributeType)[keyof typeof
2857
3091
  */
2858
3092
  export interface ChangePasswordRequest {
2859
3093
  /**
3094
+ * @public
2860
3095
  * <p>The old password.</p>
2861
3096
  */
2862
3097
  PreviousPassword: string | undefined;
2863
3098
  /**
3099
+ * @public
2864
3100
  * <p>The new password.</p>
2865
3101
  */
2866
3102
  ProposedPassword: string | undefined;
2867
3103
  /**
3104
+ * @public
2868
3105
  * <p>A valid access token that Amazon Cognito issued to the user whose password you want to
2869
3106
  * change.</p>
2870
3107
  */
@@ -2882,10 +3119,12 @@ export interface ChangePasswordResponse {
2882
3119
  */
2883
3120
  export interface DeviceSecretVerifierConfigType {
2884
3121
  /**
3122
+ * @public
2885
3123
  * <p>The password verifier.</p>
2886
3124
  */
2887
3125
  PasswordVerifier?: string;
2888
3126
  /**
3127
+ * @public
2889
3128
  * <p>The <a href="https://en.wikipedia.org/wiki/Salt_(cryptography)">salt</a>
2890
3129
  * </p>
2891
3130
  */
@@ -2897,19 +3136,23 @@ export interface DeviceSecretVerifierConfigType {
2897
3136
  */
2898
3137
  export interface ConfirmDeviceRequest {
2899
3138
  /**
3139
+ * @public
2900
3140
  * <p>A valid access token that Amazon Cognito issued to the user whose device you want to
2901
3141
  * confirm.</p>
2902
3142
  */
2903
3143
  AccessToken: string | undefined;
2904
3144
  /**
3145
+ * @public
2905
3146
  * <p>The device key.</p>
2906
3147
  */
2907
3148
  DeviceKey: string | undefined;
2908
3149
  /**
3150
+ * @public
2909
3151
  * <p>The configuration of the device secret verifier.</p>
2910
3152
  */
2911
3153
  DeviceSecretVerifierConfig?: DeviceSecretVerifierConfigType;
2912
3154
  /**
3155
+ * @public
2913
3156
  * <p>The device name.</p>
2914
3157
  */
2915
3158
  DeviceName?: string;
@@ -2920,6 +3163,7 @@ export interface ConfirmDeviceRequest {
2920
3163
  */
2921
3164
  export interface ConfirmDeviceResponse {
2922
3165
  /**
3166
+ * @public
2923
3167
  * <p>Indicates whether the user confirmation must confirm the device response.</p>
2924
3168
  */
2925
3169
  UserConfirmationNecessary?: boolean;
@@ -2932,10 +3176,12 @@ export interface ConfirmDeviceResponse {
2932
3176
  */
2933
3177
  export interface UserContextDataType {
2934
3178
  /**
3179
+ * @public
2935
3180
  * <p>The source IP address of your user's device.</p>
2936
3181
  */
2937
3182
  IpAddress?: string;
2938
3183
  /**
3184
+ * @public
2939
3185
  * <p>Encoded device-fingerprint details that your app collected with the Amazon Cognito
2940
3186
  * context data collection library. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint">Adding user device and session data to API requests</a>.</p>
2941
3187
  */
@@ -2947,40 +3193,48 @@ export interface UserContextDataType {
2947
3193
  */
2948
3194
  export interface ConfirmForgotPasswordRequest {
2949
3195
  /**
3196
+ * @public
2950
3197
  * <p>The app client ID of the app associated with the user pool.</p>
2951
3198
  */
2952
3199
  ClientId: string | undefined;
2953
3200
  /**
3201
+ * @public
2954
3202
  * <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a
2955
3203
  * user pool client and username plus the client ID in the message.</p>
2956
3204
  */
2957
3205
  SecretHash?: string;
2958
3206
  /**
3207
+ * @public
2959
3208
  * <p>The user name of the user for whom you want to enter a code to retrieve a forgotten
2960
3209
  * password.</p>
2961
3210
  */
2962
3211
  Username: string | undefined;
2963
3212
  /**
3213
+ * @public
2964
3214
  * <p>The confirmation code from your user's request to reset their password. For
2965
3215
  * more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ForgotPassword.html">ForgotPassword</a>.</p>
2966
3216
  */
2967
3217
  ConfirmationCode: string | undefined;
2968
3218
  /**
3219
+ * @public
2969
3220
  * <p>The new password that your user wants to set.</p>
2970
3221
  */
2971
3222
  Password: string | undefined;
2972
3223
  /**
3224
+ * @public
2973
3225
  * <p>The Amazon Pinpoint analytics metadata for collecting metrics for
2974
3226
  * <code>ConfirmForgotPassword</code> calls.</p>
2975
3227
  */
2976
3228
  AnalyticsMetadata?: AnalyticsMetadataType;
2977
3229
  /**
3230
+ * @public
2978
3231
  * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
2979
3232
  * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
2980
3233
  * when it makes API requests.</p>
2981
3234
  */
2982
3235
  UserContextData?: UserContextDataType;
2983
3236
  /**
3237
+ * @public
2984
3238
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
2985
3239
  * that this action triggers.</p>
2986
3240
  * <p>You create custom workflows by assigning Lambda functions to user pool triggers.
@@ -3028,23 +3282,28 @@ export interface ConfirmForgotPasswordResponse {
3028
3282
  */
3029
3283
  export interface ConfirmSignUpRequest {
3030
3284
  /**
3285
+ * @public
3031
3286
  * <p>The ID of the app client associated with the user pool.</p>
3032
3287
  */
3033
3288
  ClientId: string | undefined;
3034
3289
  /**
3290
+ * @public
3035
3291
  * <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a
3036
3292
  * user pool client and username plus the client ID in the message.</p>
3037
3293
  */
3038
3294
  SecretHash?: string;
3039
3295
  /**
3296
+ * @public
3040
3297
  * <p>The user name of the user whose registration you want to confirm.</p>
3041
3298
  */
3042
3299
  Username: string | undefined;
3043
3300
  /**
3301
+ * @public
3044
3302
  * <p>The confirmation code sent by a user's request to confirm registration.</p>
3045
3303
  */
3046
3304
  ConfirmationCode: string | undefined;
3047
3305
  /**
3306
+ * @public
3048
3307
  * <p>Boolean to be specified to force user confirmation irrespective of existing alias. By
3049
3308
  * default set to <code>False</code>. If this parameter is set to <code>True</code> and the
3050
3309
  * phone number/email used for sign up confirmation already exists as an alias with a
@@ -3054,17 +3313,20 @@ export interface ConfirmSignUpRequest {
3054
3313
  */
3055
3314
  ForceAliasCreation?: boolean;
3056
3315
  /**
3316
+ * @public
3057
3317
  * <p>The Amazon Pinpoint analytics metadata for collecting metrics for <code>ConfirmSignUp</code>
3058
3318
  * calls.</p>
3059
3319
  */
3060
3320
  AnalyticsMetadata?: AnalyticsMetadataType;
3061
3321
  /**
3322
+ * @public
3062
3323
  * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
3063
3324
  * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
3064
3325
  * when it makes API requests.</p>
3065
3326
  */
3066
3327
  UserContextData?: UserContextDataType;
3067
3328
  /**
3329
+ * @public
3068
3330
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
3069
3331
  * that this action triggers.</p>
3070
3332
  * <p>You create custom workflows by assigning Lambda functions to user pool
@@ -3110,22 +3372,27 @@ export interface ConfirmSignUpResponse {
3110
3372
  */
3111
3373
  export interface CreateGroupRequest {
3112
3374
  /**
3375
+ * @public
3113
3376
  * <p>The name of the group. Must be unique.</p>
3114
3377
  */
3115
3378
  GroupName: string | undefined;
3116
3379
  /**
3380
+ * @public
3117
3381
  * <p>The user pool ID for the user pool.</p>
3118
3382
  */
3119
3383
  UserPoolId: string | undefined;
3120
3384
  /**
3385
+ * @public
3121
3386
  * <p>A string containing the description of the group.</p>
3122
3387
  */
3123
3388
  Description?: string;
3124
3389
  /**
3390
+ * @public
3125
3391
  * <p>The role Amazon Resource Name (ARN) for the group.</p>
3126
3392
  */
3127
3393
  RoleArn?: string;
3128
3394
  /**
3395
+ * @public
3129
3396
  * <p>A non-negative integer value that specifies the precedence of this group relative to
3130
3397
  * the other groups that a user can belong to in the user pool. Zero is the highest
3131
3398
  * precedence value. Groups with lower <code>Precedence</code> values take precedence over
@@ -3149,6 +3416,7 @@ export interface CreateGroupRequest {
3149
3416
  */
3150
3417
  export interface CreateGroupResponse {
3151
3418
  /**
3419
+ * @public
3152
3420
  * <p>The group object for the group.</p>
3153
3421
  */
3154
3422
  Group?: GroupType;
@@ -3187,18 +3455,22 @@ export type IdentityProviderTypeType = (typeof IdentityProviderTypeType)[keyof t
3187
3455
  */
3188
3456
  export interface CreateIdentityProviderRequest {
3189
3457
  /**
3458
+ * @public
3190
3459
  * <p>The user pool ID.</p>
3191
3460
  */
3192
3461
  UserPoolId: string | undefined;
3193
3462
  /**
3463
+ * @public
3194
3464
  * <p>The IdP name.</p>
3195
3465
  */
3196
3466
  ProviderName: string | undefined;
3197
3467
  /**
3468
+ * @public
3198
3469
  * <p>The IdP type.</p>
3199
3470
  */
3200
3471
  ProviderType: IdentityProviderTypeType | string | undefined;
3201
3472
  /**
3473
+ * @public
3202
3474
  * <p>The IdP details. The following list describes the provider detail keys for each IdP
3203
3475
  * type.</p>
3204
3476
  * <ul>
@@ -3316,10 +3588,12 @@ export interface CreateIdentityProviderRequest {
3316
3588
  */
3317
3589
  ProviderDetails: Record<string, string> | undefined;
3318
3590
  /**
3591
+ * @public
3319
3592
  * <p>A mapping of IdP attributes to standard and custom user pool attributes.</p>
3320
3593
  */
3321
3594
  AttributeMapping?: Record<string, string>;
3322
3595
  /**
3596
+ * @public
3323
3597
  * <p>A list of IdP identifiers.</p>
3324
3598
  */
3325
3599
  IdpIdentifiers?: string[];
@@ -3330,18 +3604,22 @@ export interface CreateIdentityProviderRequest {
3330
3604
  */
3331
3605
  export interface IdentityProviderType {
3332
3606
  /**
3607
+ * @public
3333
3608
  * <p>The user pool ID.</p>
3334
3609
  */
3335
3610
  UserPoolId?: string;
3336
3611
  /**
3612
+ * @public
3337
3613
  * <p>The IdP name.</p>
3338
3614
  */
3339
3615
  ProviderName?: string;
3340
3616
  /**
3617
+ * @public
3341
3618
  * <p>The IdP type.</p>
3342
3619
  */
3343
3620
  ProviderType?: IdentityProviderTypeType | string;
3344
3621
  /**
3622
+ * @public
3345
3623
  * <p>The IdP details. The following list describes the provider detail keys for each IdP
3346
3624
  * type.</p>
3347
3625
  * <ul>
@@ -3463,18 +3741,22 @@ export interface IdentityProviderType {
3463
3741
  */
3464
3742
  ProviderDetails?: Record<string, string>;
3465
3743
  /**
3744
+ * @public
3466
3745
  * <p>A mapping of IdP attributes to standard and custom user pool attributes.</p>
3467
3746
  */
3468
3747
  AttributeMapping?: Record<string, string>;
3469
3748
  /**
3749
+ * @public
3470
3750
  * <p>A list of IdP identifiers.</p>
3471
3751
  */
3472
3752
  IdpIdentifiers?: string[];
3473
3753
  /**
3754
+ * @public
3474
3755
  * <p>The date the IdP was last modified.</p>
3475
3756
  */
3476
3757
  LastModifiedDate?: Date;
3477
3758
  /**
3759
+ * @public
3478
3760
  * <p>The date the IdP was created.</p>
3479
3761
  */
3480
3762
  CreationDate?: Date;
@@ -3484,6 +3766,7 @@ export interface IdentityProviderType {
3484
3766
  */
3485
3767
  export interface CreateIdentityProviderResponse {
3486
3768
  /**
3769
+ * @public
3487
3770
  * <p>The newly created IdP object.</p>
3488
3771
  */
3489
3772
  IdentityProvider: IdentityProviderType | undefined;
@@ -3507,10 +3790,12 @@ export declare class DuplicateProviderException extends __BaseException {
3507
3790
  */
3508
3791
  export interface ResourceServerScopeType {
3509
3792
  /**
3793
+ * @public
3510
3794
  * <p>The name of the scope.</p>
3511
3795
  */
3512
3796
  ScopeName: string | undefined;
3513
3797
  /**
3798
+ * @public
3514
3799
  * <p>A description of the scope.</p>
3515
3800
  */
3516
3801
  ScopeDescription: string | undefined;
@@ -3520,20 +3805,24 @@ export interface ResourceServerScopeType {
3520
3805
  */
3521
3806
  export interface CreateResourceServerRequest {
3522
3807
  /**
3808
+ * @public
3523
3809
  * <p>The user pool ID for the user pool.</p>
3524
3810
  */
3525
3811
  UserPoolId: string | undefined;
3526
3812
  /**
3813
+ * @public
3527
3814
  * <p>A unique resource server identifier for the resource server. This could be an HTTPS
3528
3815
  * endpoint where the resource server is located, such as
3529
3816
  * <code>https://my-weather-api.example.com</code>.</p>
3530
3817
  */
3531
3818
  Identifier: string | undefined;
3532
3819
  /**
3820
+ * @public
3533
3821
  * <p>A friendly name for the resource server.</p>
3534
3822
  */
3535
3823
  Name: string | undefined;
3536
3824
  /**
3825
+ * @public
3537
3826
  * <p>A list of scopes. Each scope is a key-value map with the keys <code>name</code> and
3538
3827
  * <code>description</code>.</p>
3539
3828
  */
@@ -3545,18 +3834,22 @@ export interface CreateResourceServerRequest {
3545
3834
  */
3546
3835
  export interface ResourceServerType {
3547
3836
  /**
3837
+ * @public
3548
3838
  * <p>The user pool ID for the user pool that hosts the resource server.</p>
3549
3839
  */
3550
3840
  UserPoolId?: string;
3551
3841
  /**
3842
+ * @public
3552
3843
  * <p>The identifier for the resource server.</p>
3553
3844
  */
3554
3845
  Identifier?: string;
3555
3846
  /**
3847
+ * @public
3556
3848
  * <p>The name of the resource server.</p>
3557
3849
  */
3558
3850
  Name?: string;
3559
3851
  /**
3852
+ * @public
3560
3853
  * <p>A list of scopes that are defined for the resource server.</p>
3561
3854
  */
3562
3855
  Scopes?: ResourceServerScopeType[];
@@ -3566,6 +3859,7 @@ export interface ResourceServerType {
3566
3859
  */
3567
3860
  export interface CreateResourceServerResponse {
3568
3861
  /**
3862
+ * @public
3569
3863
  * <p>The newly created resource server.</p>
3570
3864
  */
3571
3865
  ResourceServer: ResourceServerType | undefined;
@@ -3576,14 +3870,17 @@ export interface CreateResourceServerResponse {
3576
3870
  */
3577
3871
  export interface CreateUserImportJobRequest {
3578
3872
  /**
3873
+ * @public
3579
3874
  * <p>The job name for the user import job.</p>
3580
3875
  */
3581
3876
  JobName: string | undefined;
3582
3877
  /**
3878
+ * @public
3583
3879
  * <p>The user pool ID for the user pool that the users are being imported into.</p>
3584
3880
  */
3585
3881
  UserPoolId: string | undefined;
3586
3882
  /**
3883
+ * @public
3587
3884
  * <p>The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.</p>
3588
3885
  */
3589
3886
  CloudWatchLogsRoleArn: string | undefined;
@@ -3612,34 +3909,42 @@ export type UserImportJobStatusType = (typeof UserImportJobStatusType)[keyof typ
3612
3909
  */
3613
3910
  export interface UserImportJobType {
3614
3911
  /**
3912
+ * @public
3615
3913
  * <p>The job name for the user import job.</p>
3616
3914
  */
3617
3915
  JobName?: string;
3618
3916
  /**
3917
+ * @public
3619
3918
  * <p>The job ID for the user import job.</p>
3620
3919
  */
3621
3920
  JobId?: string;
3622
3921
  /**
3922
+ * @public
3623
3923
  * <p>The user pool ID for the user pool that the users are being imported into.</p>
3624
3924
  */
3625
3925
  UserPoolId?: string;
3626
3926
  /**
3927
+ * @public
3627
3928
  * <p>The pre-signed URL to be used to upload the <code>.csv</code> file.</p>
3628
3929
  */
3629
3930
  PreSignedUrl?: string;
3630
3931
  /**
3932
+ * @public
3631
3933
  * <p>The date the user import job was created.</p>
3632
3934
  */
3633
3935
  CreationDate?: Date;
3634
3936
  /**
3937
+ * @public
3635
3938
  * <p>The date when the user import job was started.</p>
3636
3939
  */
3637
3940
  StartDate?: Date;
3638
3941
  /**
3942
+ * @public
3639
3943
  * <p>The date when the user import job was completed.</p>
3640
3944
  */
3641
3945
  CompletionDate?: Date;
3642
3946
  /**
3947
+ * @public
3643
3948
  * <p>The status of the user import job. One of the following:</p>
3644
3949
  * <ul>
3645
3950
  * <li>
@@ -3684,24 +3989,29 @@ export interface UserImportJobType {
3684
3989
  */
3685
3990
  Status?: UserImportJobStatusType | string;
3686
3991
  /**
3992
+ * @public
3687
3993
  * <p>The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging role for the user import
3688
3994
  * job. For more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer
3689
3995
  * Guide.</p>
3690
3996
  */
3691
3997
  CloudWatchLogsRoleArn?: string;
3692
3998
  /**
3999
+ * @public
3693
4000
  * <p>The number of users that were successfully imported.</p>
3694
4001
  */
3695
4002
  ImportedUsers?: number;
3696
4003
  /**
4004
+ * @public
3697
4005
  * <p>The number of users that were skipped.</p>
3698
4006
  */
3699
4007
  SkippedUsers?: number;
3700
4008
  /**
4009
+ * @public
3701
4010
  * <p>The number of users that couldn't be imported.</p>
3702
4011
  */
3703
4012
  FailedUsers?: number;
3704
4013
  /**
4014
+ * @public
3705
4015
  * <p>The message returned when the user import job is completed.</p>
3706
4016
  */
3707
4017
  CompletionMessage?: string;
@@ -3713,6 +4023,7 @@ export interface UserImportJobType {
3713
4023
  */
3714
4024
  export interface CreateUserImportJobResponse {
3715
4025
  /**
4026
+ * @public
3716
4027
  * <p>The job object that represents the user import job.</p>
3717
4028
  */
3718
4029
  UserImportJob?: UserImportJobType;
@@ -3751,6 +4062,7 @@ export type DeletionProtectionType = (typeof DeletionProtectionType)[keyof typeo
3751
4062
  */
3752
4063
  export interface DeviceConfigurationType {
3753
4064
  /**
4065
+ * @public
3754
4066
  * <p>When true, a remembered device can sign in with device authentication instead of SMS
3755
4067
  * and time-based one-time password (TOTP) factors for multi-factor authentication
3756
4068
  * (MFA).</p>
@@ -3762,6 +4074,7 @@ export interface DeviceConfigurationType {
3762
4074
  */
3763
4075
  ChallengeRequiredOnNewDevice?: boolean;
3764
4076
  /**
4077
+ * @public
3765
4078
  * <p>When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a
3766
4079
  * <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html">
3767
4080
  * ConfirmDevice</a> API request. In your app, create a prompt for
@@ -3799,6 +4112,7 @@ export type EmailSendingAccountType = (typeof EmailSendingAccountType)[keyof typ
3799
4112
  */
3800
4113
  export interface EmailConfigurationType {
3801
4114
  /**
4115
+ * @public
3802
4116
  * <p>The ARN of a verified email address in Amazon SES. Amazon Cognito uses this email address in one of
3803
4117
  * the following ways, depending on the value that you specify for the
3804
4118
  * <code>EmailSendingAccount</code> parameter:</p>
@@ -3820,10 +4134,12 @@ export interface EmailConfigurationType {
3820
4134
  */
3821
4135
  SourceArn?: string;
3822
4136
  /**
4137
+ * @public
3823
4138
  * <p>The destination to which the receiver of the email should reply.</p>
3824
4139
  */
3825
4140
  ReplyToEmailAddress?: string;
3826
4141
  /**
4142
+ * @public
3827
4143
  * <p>Specifies whether Amazon Cognito uses its built-in functionality to send your users email
3828
4144
  * messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following
3829
4145
  * values:</p>
@@ -3863,6 +4179,7 @@ export interface EmailConfigurationType {
3863
4179
  */
3864
4180
  EmailSendingAccount?: EmailSendingAccountType | string;
3865
4181
  /**
4182
+ * @public
3866
4183
  * <p>Either the sender’s email address or the sender’s name with their email address. For
3867
4184
  * example, <code>testuser@example.com</code> or <code>Test User
3868
4185
  * <testuser@example.com></code>. This address appears before the body of the
@@ -3870,6 +4187,7 @@ export interface EmailConfigurationType {
3870
4187
  */
3871
4188
  From?: string;
3872
4189
  /**
4190
+ * @public
3873
4191
  * <p>The set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. A
3874
4192
  * configuration set is applied to an email by including a reference to the configuration
3875
4193
  * set in the headers of the email. Once applied, all of the rules in that configuration
@@ -3910,11 +4228,13 @@ export type CustomEmailSenderLambdaVersionType = (typeof CustomEmailSenderLambda
3910
4228
  */
3911
4229
  export interface CustomEmailLambdaVersionConfigType {
3912
4230
  /**
4231
+ * @public
3913
4232
  * <p>Signature of the "request" attribute in the "event" information Amazon Cognito passes to your
3914
4233
  * custom email Lambda function. The only supported value is <code>V1_0</code>.</p>
3915
4234
  */
3916
4235
  LambdaVersion: CustomEmailSenderLambdaVersionType | string | undefined;
3917
4236
  /**
4237
+ * @public
3918
4238
  * <p>The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send
3919
4239
  * email notifications to users.</p>
3920
4240
  */
@@ -3937,11 +4257,13 @@ export type CustomSMSSenderLambdaVersionType = (typeof CustomSMSSenderLambdaVers
3937
4257
  */
3938
4258
  export interface CustomSMSLambdaVersionConfigType {
3939
4259
  /**
4260
+ * @public
3940
4261
  * <p>Signature of the "request" attribute in the "event" information that Amazon Cognito passes to
3941
4262
  * your custom SMS Lambda function. The only supported value is <code>V1_0</code>.</p>
3942
4263
  */
3943
4264
  LambdaVersion: CustomSMSSenderLambdaVersionType | string | undefined;
3944
4265
  /**
4266
+ * @public
3945
4267
  * <p>The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send SMS
3946
4268
  * notifications to users.</p>
3947
4269
  */
@@ -3953,54 +4275,67 @@ export interface CustomSMSLambdaVersionConfigType {
3953
4275
  */
3954
4276
  export interface LambdaConfigType {
3955
4277
  /**
4278
+ * @public
3956
4279
  * <p>A pre-registration Lambda trigger.</p>
3957
4280
  */
3958
4281
  PreSignUp?: string;
3959
4282
  /**
4283
+ * @public
3960
4284
  * <p>A custom Message Lambda trigger.</p>
3961
4285
  */
3962
4286
  CustomMessage?: string;
3963
4287
  /**
4288
+ * @public
3964
4289
  * <p>A post-confirmation Lambda trigger.</p>
3965
4290
  */
3966
4291
  PostConfirmation?: string;
3967
4292
  /**
4293
+ * @public
3968
4294
  * <p>A pre-authentication Lambda trigger.</p>
3969
4295
  */
3970
4296
  PreAuthentication?: string;
3971
4297
  /**
4298
+ * @public
3972
4299
  * <p>A post-authentication Lambda trigger.</p>
3973
4300
  */
3974
4301
  PostAuthentication?: string;
3975
4302
  /**
4303
+ * @public
3976
4304
  * <p>Defines the authentication challenge.</p>
3977
4305
  */
3978
4306
  DefineAuthChallenge?: string;
3979
4307
  /**
4308
+ * @public
3980
4309
  * <p>Creates an authentication challenge.</p>
3981
4310
  */
3982
4311
  CreateAuthChallenge?: string;
3983
4312
  /**
4313
+ * @public
3984
4314
  * <p>Verifies the authentication challenge response.</p>
3985
4315
  */
3986
4316
  VerifyAuthChallengeResponse?: string;
3987
4317
  /**
4318
+ * @public
3988
4319
  * <p>A Lambda trigger that is invoked before token generation.</p>
3989
4320
  */
3990
4321
  PreTokenGeneration?: string;
3991
4322
  /**
4323
+ * @public
3992
4324
  * <p>The user migration Lambda config type.</p>
3993
4325
  */
3994
4326
  UserMigration?: string;
3995
4327
  /**
4328
+ * @public
3996
4329
  * <p>A custom SMS sender Lambda trigger.</p>
3997
4330
  */
3998
4331
  CustomSMSSender?: CustomSMSLambdaVersionConfigType;
3999
4332
  /**
4333
+ * @public
4000
4334
  * <p>A custom email sender Lambda trigger.</p>
4001
4335
  */
4002
4336
  CustomEmailSender?: CustomEmailLambdaVersionConfigType;
4003
4337
  /**
4338
+ * @public
4004
4339
  * <p>The Amazon Resource Name (ARN) of an <a href="/kms/latest/developerguide/concepts.html#master_keys">KMS key</a>. Amazon Cognito
4005
4340
  * uses the key to encrypt codes and temporary passwords sent to
4006
4341
  * <code>CustomEmailSender</code> and <code>CustomSMSSender</code>.</p>
@@ -4026,31 +4361,37 @@ export type UserPoolMfaType = (typeof UserPoolMfaType)[keyof typeof UserPoolMfaT
4026
4361
  */
4027
4362
  export interface PasswordPolicyType {
4028
4363
  /**
4364
+ * @public
4029
4365
  * <p>The minimum length of the password in the policy that you have set. This value can't
4030
4366
  * be less than 6.</p>
4031
4367
  */
4032
4368
  MinimumLength?: number;
4033
4369
  /**
4370
+ * @public
4034
4371
  * <p>In the password policy that you have set, refers to whether you have required users to
4035
4372
  * use at least one uppercase letter in their password.</p>
4036
4373
  */
4037
4374
  RequireUppercase?: boolean;
4038
4375
  /**
4376
+ * @public
4039
4377
  * <p>In the password policy that you have set, refers to whether you have required users to
4040
4378
  * use at least one lowercase letter in their password.</p>
4041
4379
  */
4042
4380
  RequireLowercase?: boolean;
4043
4381
  /**
4382
+ * @public
4044
4383
  * <p>In the password policy that you have set, refers to whether you have required users to
4045
4384
  * use at least one number in their password.</p>
4046
4385
  */
4047
4386
  RequireNumbers?: boolean;
4048
4387
  /**
4388
+ * @public
4049
4389
  * <p>In the password policy that you have set, refers to whether you have required users to
4050
4390
  * use at least one symbol in their password.</p>
4051
4391
  */
4052
4392
  RequireSymbols?: boolean;
4053
4393
  /**
4394
+ * @public
4054
4395
  * <p>The number of days a temporary password is valid in the password policy. If the user
4055
4396
  * doesn't sign in during this time, an administrator must reset their password.</p>
4056
4397
  * <note>
@@ -4067,6 +4408,7 @@ export interface PasswordPolicyType {
4067
4408
  */
4068
4409
  export interface UserPoolPolicyType {
4069
4410
  /**
4411
+ * @public
4070
4412
  * <p>The password policy.</p>
4071
4413
  */
4072
4414
  PasswordPolicy?: PasswordPolicyType;
@@ -4080,12 +4422,14 @@ export interface UserPoolPolicyType {
4080
4422
  */
4081
4423
  export interface SmsConfigurationType {
4082
4424
  /**
4425
+ * @public
4083
4426
  * <p>The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role
4084
4427
  * in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS
4085
4428
  * messages are subject to a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html">spending limit</a>. </p>
4086
4429
  */
4087
4430
  SnsCallerArn: string | undefined;
4088
4431
  /**
4432
+ * @public
4089
4433
  * <p>The external ID provides additional security for your IAM role. You can use an
4090
4434
  * <code>ExternalId</code> with the IAM role that you use with Amazon SNS to send SMS
4091
4435
  * messages for your user pool. If you provide an <code>ExternalId</code>, your Amazon Cognito user
@@ -4102,6 +4446,7 @@ export interface SmsConfigurationType {
4102
4446
  */
4103
4447
  ExternalId?: string;
4104
4448
  /**
4449
+ * @public
4105
4450
  * <p>The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your
4106
4451
  * user pool, or a supported <b>Legacy Amazon SNS alternate
4107
4452
  * Region</b>. </p>
@@ -4120,6 +4465,7 @@ export interface SmsConfigurationType {
4120
4465
  */
4121
4466
  export interface UserAttributeUpdateSettingsType {
4122
4467
  /**
4468
+ * @public
4123
4469
  * <p>Requires that your user verifies their email address, phone number, or both before
4124
4470
  * Amazon Cognito updates the value of that attribute. When you update a user attribute that has
4125
4471
  * this option activated, Amazon Cognito sends a verification message to the new phone number or
@@ -4153,6 +4499,7 @@ export type UsernameAttributeType = (typeof UsernameAttributeType)[keyof typeof
4153
4499
  */
4154
4500
  export interface UsernameConfigurationType {
4155
4501
  /**
4502
+ * @public
4156
4503
  * <p>Specifies whether user name case sensitivity will be applied for all users in the user
4157
4504
  * pool through Amazon Cognito APIs.</p>
4158
4505
  * <p>Valid values include:</p>
@@ -4181,6 +4528,7 @@ export interface UsernameConfigurationType {
4181
4528
  */
4182
4529
  export interface UserPoolAddOnsType {
4183
4530
  /**
4531
+ * @public
4184
4532
  * <p>The advanced security mode.</p>
4185
4533
  */
4186
4534
  AdvancedSecurityMode: AdvancedSecurityModeType | string | undefined;
@@ -4203,28 +4551,33 @@ export type DefaultEmailOptionType = (typeof DefaultEmailOptionType)[keyof typeo
4203
4551
  */
4204
4552
  export interface VerificationMessageTemplateType {
4205
4553
  /**
4554
+ * @public
4206
4555
  * <p>The template for SMS messages that Amazon Cognito sends to your users.</p>
4207
4556
  */
4208
4557
  SmsMessage?: string;
4209
4558
  /**
4559
+ * @public
4210
4560
  * <p>The template for email messages that Amazon Cognito sends to your users. You can set an
4211
4561
  * <code>EmailMessage</code> template only if the value of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount"> EmailSendingAccount</a> is <code>DEVELOPER</code>. When your <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount">EmailSendingAccount</a> is <code>DEVELOPER</code>, your user pool sends email
4212
4562
  * messages with your own Amazon SES configuration.</p>
4213
4563
  */
4214
4564
  EmailMessage?: string;
4215
4565
  /**
4566
+ * @public
4216
4567
  * <p>The subject line for the email message template. You can set an
4217
4568
  * <code>EmailSubject</code> template only if the value of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount"> EmailSendingAccount</a> is <code>DEVELOPER</code>. When your <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount">EmailSendingAccount</a> is <code>DEVELOPER</code>, your user pool sends email
4218
4569
  * messages with your own Amazon SES configuration.</p>
4219
4570
  */
4220
4571
  EmailSubject?: string;
4221
4572
  /**
4573
+ * @public
4222
4574
  * <p>The email message template for sending a confirmation link to the user. You can set an
4223
4575
  * <code>EmailMessageByLink</code> template only if the value of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount"> EmailSendingAccount</a> is <code>DEVELOPER</code>. When your <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount">EmailSendingAccount</a> is <code>DEVELOPER</code>, your user pool sends email
4224
4576
  * messages with your own Amazon SES configuration.</p>
4225
4577
  */
4226
4578
  EmailMessageByLink?: string;
4227
4579
  /**
4580
+ * @public
4228
4581
  * <p>The subject line for the email message template for sending a confirmation link to the
4229
4582
  * user. You can set an <code>EmailSubjectByLink</code> template only if the value of
4230
4583
  * <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount"> EmailSendingAccount</a> is <code>DEVELOPER</code>. When your <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount">EmailSendingAccount</a> is <code>DEVELOPER</code>, your user pool sends email
@@ -4232,6 +4585,7 @@ export interface VerificationMessageTemplateType {
4232
4585
  */
4233
4586
  EmailSubjectByLink?: string;
4234
4587
  /**
4588
+ * @public
4235
4589
  * <p>The default email option.</p>
4236
4590
  */
4237
4591
  DefaultEmailOption?: DefaultEmailOptionType | string;
@@ -4242,14 +4596,17 @@ export interface VerificationMessageTemplateType {
4242
4596
  */
4243
4597
  export interface CreateUserPoolRequest {
4244
4598
  /**
4599
+ * @public
4245
4600
  * <p>A string used to name the user pool.</p>
4246
4601
  */
4247
4602
  PoolName: string | undefined;
4248
4603
  /**
4604
+ * @public
4249
4605
  * <p>The policies associated with the new user pool.</p>
4250
4606
  */
4251
4607
  Policies?: UserPoolPolicyType;
4252
4608
  /**
4609
+ * @public
4253
4610
  * <p>When active, <code>DeletionProtection</code> prevents accidental deletion of your user
4254
4611
  * pool. Before you can delete a user pool that you have protected against deletion, you
4255
4612
  * must deactivate this feature.</p>
@@ -4260,6 +4617,7 @@ export interface CreateUserPoolRequest {
4260
4617
  */
4261
4618
  DeletionProtection?: DeletionProtectionType | string;
4262
4619
  /**
4620
+ * @public
4263
4621
  * <p>The Lambda trigger configuration information for the new user pool.</p>
4264
4622
  * <note>
4265
4623
  * <p>In a push model, event sources (such as Amazon S3 and custom applications) need
@@ -4274,45 +4632,55 @@ export interface CreateUserPoolRequest {
4274
4632
  */
4275
4633
  LambdaConfig?: LambdaConfigType;
4276
4634
  /**
4635
+ * @public
4277
4636
  * <p>The attributes to be auto-verified. Possible values: <b>email</b>, <b>phone_number</b>.</p>
4278
4637
  */
4279
4638
  AutoVerifiedAttributes?: (VerifiedAttributeType | string)[];
4280
4639
  /**
4640
+ * @public
4281
4641
  * <p>Attributes supported as an alias for this user pool. Possible values: <b>phone_number</b>, <b>email</b>, or
4282
4642
  * <b>preferred_username</b>.</p>
4283
4643
  */
4284
4644
  AliasAttributes?: (AliasAttributeType | string)[];
4285
4645
  /**
4646
+ * @public
4286
4647
  * <p>Specifies whether a user can use an email address or phone number as a username when
4287
4648
  * they sign up.</p>
4288
4649
  */
4289
4650
  UsernameAttributes?: (UsernameAttributeType | string)[];
4290
4651
  /**
4652
+ * @public
4291
4653
  * <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
4292
4654
  */
4293
4655
  SmsVerificationMessage?: string;
4294
4656
  /**
4657
+ * @public
4295
4658
  * <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
4296
4659
  */
4297
4660
  EmailVerificationMessage?: string;
4298
4661
  /**
4662
+ * @public
4299
4663
  * <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
4300
4664
  */
4301
4665
  EmailVerificationSubject?: string;
4302
4666
  /**
4667
+ * @public
4303
4668
  * <p>The template for the verification message that the user sees when the app requests
4304
4669
  * permission to access the user's information.</p>
4305
4670
  */
4306
4671
  VerificationMessageTemplate?: VerificationMessageTemplateType;
4307
4672
  /**
4673
+ * @public
4308
4674
  * <p>A string representing the SMS authentication message.</p>
4309
4675
  */
4310
4676
  SmsAuthenticationMessage?: string;
4311
4677
  /**
4678
+ * @public
4312
4679
  * <p>Specifies MFA configuration details.</p>
4313
4680
  */
4314
4681
  MfaConfiguration?: UserPoolMfaType | string;
4315
4682
  /**
4683
+ * @public
4316
4684
  * <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>,
4317
4685
  * 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
4318
4686
  * 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">
@@ -4320,6 +4688,7 @@ export interface CreateUserPoolRequest {
4320
4688
  */
4321
4689
  UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType;
4322
4690
  /**
4691
+ * @public
4323
4692
  * <p>The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.</p>
4324
4693
  * <note>
4325
4694
  * <p>When you provide a value for any <code>DeviceConfiguration</code> field, you activate the Amazon Cognito device-remembering feature.</p>
@@ -4327,12 +4696,14 @@ export interface CreateUserPoolRequest {
4327
4696
  */
4328
4697
  DeviceConfiguration?: DeviceConfigurationType;
4329
4698
  /**
4699
+ * @public
4330
4700
  * <p>The email configuration of your user pool. The email configuration type sets your
4331
4701
  * preferred sending method, Amazon Web Services Region, and sender for messages from your user
4332
4702
  * pool.</p>
4333
4703
  */
4334
4704
  EmailConfiguration?: EmailConfigurationType;
4335
4705
  /**
4706
+ * @public
4336
4707
  * <p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an
4337
4708
  * SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages
4338
4709
  * with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management
@@ -4340,26 +4711,31 @@ export interface CreateUserPoolRequest {
4340
4711
  */
4341
4712
  SmsConfiguration?: SmsConfigurationType;
4342
4713
  /**
4714
+ * @public
4343
4715
  * <p>The tag keys and values to assign to the user pool. A tag is a label that you can use
4344
4716
  * to categorize and manage user pools in different ways, such as by purpose, owner,
4345
4717
  * environment, or other criteria.</p>
4346
4718
  */
4347
4719
  UserPoolTags?: Record<string, string>;
4348
4720
  /**
4721
+ * @public
4349
4722
  * <p>The configuration for <code>AdminCreateUser</code> requests.</p>
4350
4723
  */
4351
4724
  AdminCreateUserConfig?: AdminCreateUserConfigType;
4352
4725
  /**
4726
+ * @public
4353
4727
  * <p>An array of schema attributes for the new user pool. These attributes can be standard
4354
4728
  * or custom attributes.</p>
4355
4729
  */
4356
4730
  Schema?: SchemaAttributeType[];
4357
4731
  /**
4732
+ * @public
4358
4733
  * <p>Enables advanced security risk detection. Set the key
4359
4734
  * <code>AdvancedSecurityMode</code> to the value "AUDIT".</p>
4360
4735
  */
4361
4736
  UserPoolAddOns?: UserPoolAddOnsType;
4362
4737
  /**
4738
+ * @public
4363
4739
  * <p>Case sensitivity on the username input for the selected sign-in option. For example,
4364
4740
  * when case sensitivity is set to <code>False</code>, users can sign in using either
4365
4741
  * "username" or "Username". This configuration is immutable once it has been set. For more
@@ -4367,6 +4743,7 @@ export interface CreateUserPoolRequest {
4367
4743
  */
4368
4744
  UsernameConfiguration?: UsernameConfigurationType;
4369
4745
  /**
4746
+ * @public
4370
4747
  * <p>The available verified method a user can use to recover their password when they call
4371
4748
  * <code>ForgotPassword</code>. You can use this setting to define a preferred method
4372
4749
  * when a user has more than one method available. With this setting, SMS doesn't qualify
@@ -4394,18 +4771,22 @@ export type StatusType = (typeof StatusType)[keyof typeof StatusType];
4394
4771
  */
4395
4772
  export interface UserPoolType {
4396
4773
  /**
4774
+ * @public
4397
4775
  * <p>The ID of the user pool.</p>
4398
4776
  */
4399
4777
  Id?: string;
4400
4778
  /**
4779
+ * @public
4401
4780
  * <p>The name of the user pool.</p>
4402
4781
  */
4403
4782
  Name?: string;
4404
4783
  /**
4784
+ * @public
4405
4785
  * <p>The policies associated with the user pool.</p>
4406
4786
  */
4407
4787
  Policies?: UserPoolPolicyType;
4408
4788
  /**
4789
+ * @public
4409
4790
  * <p>When active, <code>DeletionProtection</code> prevents accidental deletion of your user
4410
4791
  * pool. Before you can delete a user pool that you have protected against deletion, you
4411
4792
  * must deactivate this feature.</p>
@@ -4416,59 +4797,73 @@ export interface UserPoolType {
4416
4797
  */
4417
4798
  DeletionProtection?: DeletionProtectionType | string;
4418
4799
  /**
4800
+ * @public
4419
4801
  * <p>The Lambda triggers associated with the user pool.</p>
4420
4802
  */
4421
4803
  LambdaConfig?: LambdaConfigType;
4422
4804
  /**
4805
+ * @public
4423
4806
  * <p>The status of a user pool.</p>
4424
4807
  */
4425
4808
  Status?: StatusType | string;
4426
4809
  /**
4810
+ * @public
4427
4811
  * <p>The date the user pool was last modified.</p>
4428
4812
  */
4429
4813
  LastModifiedDate?: Date;
4430
4814
  /**
4815
+ * @public
4431
4816
  * <p>The date the user pool was created.</p>
4432
4817
  */
4433
4818
  CreationDate?: Date;
4434
4819
  /**
4820
+ * @public
4435
4821
  * <p>A container with the schema attributes of a user pool.</p>
4436
4822
  */
4437
4823
  SchemaAttributes?: SchemaAttributeType[];
4438
4824
  /**
4825
+ * @public
4439
4826
  * <p>The attributes that are auto-verified in a user pool.</p>
4440
4827
  */
4441
4828
  AutoVerifiedAttributes?: (VerifiedAttributeType | string)[];
4442
4829
  /**
4830
+ * @public
4443
4831
  * <p>The attributes that are aliased in a user pool.</p>
4444
4832
  */
4445
4833
  AliasAttributes?: (AliasAttributeType | string)[];
4446
4834
  /**
4835
+ * @public
4447
4836
  * <p>Specifies whether a user can use an email address or phone number as a username when
4448
4837
  * they sign up.</p>
4449
4838
  */
4450
4839
  UsernameAttributes?: (UsernameAttributeType | string)[];
4451
4840
  /**
4841
+ * @public
4452
4842
  * <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
4453
4843
  */
4454
4844
  SmsVerificationMessage?: string;
4455
4845
  /**
4846
+ * @public
4456
4847
  * <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
4457
4848
  */
4458
4849
  EmailVerificationMessage?: string;
4459
4850
  /**
4851
+ * @public
4460
4852
  * <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
4461
4853
  */
4462
4854
  EmailVerificationSubject?: string;
4463
4855
  /**
4856
+ * @public
4464
4857
  * <p>The template for verification messages.</p>
4465
4858
  */
4466
4859
  VerificationMessageTemplate?: VerificationMessageTemplateType;
4467
4860
  /**
4861
+ * @public
4468
4862
  * <p>The contents of the SMS authentication message.</p>
4469
4863
  */
4470
4864
  SmsAuthenticationMessage?: string;
4471
4865
  /**
4866
+ * @public
4472
4867
  * <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>,
4473
4868
  * 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
4474
4869
  * 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">
@@ -4476,6 +4871,7 @@ export interface UserPoolType {
4476
4871
  */
4477
4872
  UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType;
4478
4873
  /**
4874
+ * @public
4479
4875
  * <p>Can be one of the following values:</p>
4480
4876
  * <ul>
4481
4877
  * <li>
@@ -4497,6 +4893,7 @@ export interface UserPoolType {
4497
4893
  */
4498
4894
  MfaConfiguration?: UserPoolMfaType | string;
4499
4895
  /**
4896
+ * @public
4500
4897
  * <p>The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.</p>
4501
4898
  * <note>
4502
4899
  * <p>When you provide a value for any <code>DeviceConfiguration</code> field, you activate the Amazon Cognito device-remembering feature.</p>
@@ -4504,16 +4901,19 @@ export interface UserPoolType {
4504
4901
  */
4505
4902
  DeviceConfiguration?: DeviceConfigurationType;
4506
4903
  /**
4904
+ * @public
4507
4905
  * <p>A number estimating the size of the user pool.</p>
4508
4906
  */
4509
4907
  EstimatedNumberOfUsers?: number;
4510
4908
  /**
4909
+ * @public
4511
4910
  * <p>The email configuration of your user pool. The email configuration type sets your
4512
4911
  * preferred sending method, Amazon Web Services Region, and sender for messages tfrom your user
4513
4912
  * pool.</p>
4514
4913
  */
4515
4914
  EmailConfiguration?: EmailConfigurationType;
4516
4915
  /**
4916
+ * @public
4517
4917
  * <p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an
4518
4918
  * SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages
4519
4919
  * with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management
@@ -4521,12 +4921,14 @@ export interface UserPoolType {
4521
4921
  */
4522
4922
  SmsConfiguration?: SmsConfigurationType;
4523
4923
  /**
4924
+ * @public
4524
4925
  * <p>The tags that are assigned to the user pool. A tag is a label that you can apply to
4525
4926
  * user pools to categorize and manage them in different ways, such as by purpose, owner,
4526
4927
  * environment, or other criteria.</p>
4527
4928
  */
4528
4929
  UserPoolTags?: Record<string, string>;
4529
4930
  /**
4931
+ * @public
4530
4932
  * <p>The reason why the SMS configuration can't send the messages to your users.</p>
4531
4933
  * <p>This message might include comma-separated values to describe why your SMS
4532
4934
  * configuration can't send messages to user pool end users.</p>
@@ -4549,16 +4951,19 @@ export interface UserPoolType {
4549
4951
  */
4550
4952
  SmsConfigurationFailure?: string;
4551
4953
  /**
4954
+ * @public
4552
4955
  * <p>Deprecated. Review error codes from API requests with
4553
4956
  * <code>EventSource:cognito-idp.amazonaws.com</code> in CloudTrail for
4554
4957
  * information about problems with user pool email configuration.</p>
4555
4958
  */
4556
4959
  EmailConfigurationFailure?: string;
4557
4960
  /**
4961
+ * @public
4558
4962
  * <p>The domain prefix, if the user pool has a domain associated with it.</p>
4559
4963
  */
4560
4964
  Domain?: string;
4561
4965
  /**
4966
+ * @public
4562
4967
  * <p>A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use
4563
4968
  * a custom domain to host the sign-up and sign-in pages for your application. An example
4564
4969
  * of a custom domain name might be <code>auth.example.com</code>.</p>
@@ -4566,14 +4971,17 @@ export interface UserPoolType {
4566
4971
  */
4567
4972
  CustomDomain?: string;
4568
4973
  /**
4974
+ * @public
4569
4975
  * <p>The configuration for <code>AdminCreateUser</code> requests.</p>
4570
4976
  */
4571
4977
  AdminCreateUserConfig?: AdminCreateUserConfigType;
4572
4978
  /**
4979
+ * @public
4573
4980
  * <p>The user pool add-ons.</p>
4574
4981
  */
4575
4982
  UserPoolAddOns?: UserPoolAddOnsType;
4576
4983
  /**
4984
+ * @public
4577
4985
  * <p>Case sensitivity of the username input for the selected sign-in option. For example,
4578
4986
  * when case sensitivity is set to <code>False</code>, users can sign in using either
4579
4987
  * "username" or "Username". This configuration is immutable once it has been set. For more
@@ -4581,10 +4989,12 @@ export interface UserPoolType {
4581
4989
  */
4582
4990
  UsernameConfiguration?: UsernameConfigurationType;
4583
4991
  /**
4992
+ * @public
4584
4993
  * <p>The Amazon Resource Name (ARN) for the user pool.</p>
4585
4994
  */
4586
4995
  Arn?: string;
4587
4996
  /**
4997
+ * @public
4588
4998
  * <p>The available verified method a user can use to recover their password when they call
4589
4999
  * <code>ForgotPassword</code>. You can use this setting to define a preferred method
4590
5000
  * when a user has more than one method available. With this setting, SMS doesn't qualify
@@ -4600,6 +5010,7 @@ export interface UserPoolType {
4600
5010
  */
4601
5011
  export interface CreateUserPoolResponse {
4602
5012
  /**
5013
+ * @public
4603
5014
  * <p>A container for the user pool details.</p>
4604
5015
  */
4605
5016
  UserPool?: UserPoolType;
@@ -4680,18 +5091,21 @@ export type TimeUnitsType = (typeof TimeUnitsType)[keyof typeof TimeUnitsType];
4680
5091
  */
4681
5092
  export interface TokenValidityUnitsType {
4682
5093
  /**
5094
+ * @public
4683
5095
  * <p> A time unit of <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or
4684
5096
  * <code>days</code> for the value that you set in the <code>AccessTokenValidity</code>
4685
5097
  * parameter. The default <code>AccessTokenValidity</code> time unit is hours.</p>
4686
5098
  */
4687
5099
  AccessToken?: TimeUnitsType | string;
4688
5100
  /**
5101
+ * @public
4689
5102
  * <p>A time unit of <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or
4690
5103
  * <code>days</code> for the value that you set in the <code>IdTokenValidity</code>
4691
5104
  * parameter. The default <code>IdTokenValidity</code> time unit is hours.</p>
4692
5105
  */
4693
5106
  IdToken?: TimeUnitsType | string;
4694
5107
  /**
5108
+ * @public
4695
5109
  * <p>A time unit of <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or
4696
5110
  * <code>days</code> for the value that you set in the
4697
5111
  * <code>RefreshTokenValidity</code> parameter. The default
@@ -4705,19 +5119,23 @@ export interface TokenValidityUnitsType {
4705
5119
  */
4706
5120
  export interface CreateUserPoolClientRequest {
4707
5121
  /**
5122
+ * @public
4708
5123
  * <p>The user pool ID for the user pool where you want to create a user pool client.</p>
4709
5124
  */
4710
5125
  UserPoolId: string | undefined;
4711
5126
  /**
5127
+ * @public
4712
5128
  * <p>The client name for the user pool client you would like to create.</p>
4713
5129
  */
4714
5130
  ClientName: string | undefined;
4715
5131
  /**
5132
+ * @public
4716
5133
  * <p>Boolean to specify whether you want to generate a secret for the user pool client
4717
5134
  * being created.</p>
4718
5135
  */
4719
5136
  GenerateSecret?: boolean;
4720
5137
  /**
5138
+ * @public
4721
5139
  * <p>The refresh token time limit. After this limit expires, your user can't use
4722
5140
  * their refresh token. To specify the time unit for <code>RefreshTokenValidity</code> as
4723
5141
  * <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>,
@@ -4734,6 +5152,7 @@ export interface CreateUserPoolClientRequest {
4734
5152
  */
4735
5153
  RefreshTokenValidity?: number;
4736
5154
  /**
5155
+ * @public
4737
5156
  * <p>The access token time limit. After this limit expires, your user can't use
4738
5157
  * their access token. To specify the time unit for <code>AccessTokenValidity</code> as
4739
5158
  * <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>,
@@ -4748,6 +5167,7 @@ export interface CreateUserPoolClientRequest {
4748
5167
  */
4749
5168
  AccessTokenValidity?: number;
4750
5169
  /**
5170
+ * @public
4751
5171
  * <p>The ID token time limit. After this limit expires, your user can't use
4752
5172
  * their ID token. To specify the time unit for <code>IdTokenValidity</code> as
4753
5173
  * <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>,
@@ -4762,15 +5182,18 @@ export interface CreateUserPoolClientRequest {
4762
5182
  */
4763
5183
  IdTokenValidity?: number;
4764
5184
  /**
5185
+ * @public
4765
5186
  * <p>The units in which the validity times are represented. The default unit for
4766
5187
  * RefreshToken is days, and default for ID and access tokens are hours.</p>
4767
5188
  */
4768
5189
  TokenValidityUnits?: TokenValidityUnitsType;
4769
5190
  /**
5191
+ * @public
4770
5192
  * <p>The read attributes.</p>
4771
5193
  */
4772
5194
  ReadAttributes?: string[];
4773
5195
  /**
5196
+ * @public
4774
5197
  * <p>The user pool attributes that the app client can write to.</p>
4775
5198
  * <p>If your app client allows users to sign in through an IdP, this array must include all
4776
5199
  * attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when
@@ -4781,6 +5204,7 @@ export interface CreateUserPoolClientRequest {
4781
5204
  */
4782
5205
  WriteAttributes?: string[];
4783
5206
  /**
5207
+ * @public
4784
5208
  * <p>The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in
4785
5209
  * your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and
4786
5210
  * password, or a custom authentication process that you define with Lambda functions.</p>
@@ -4824,6 +5248,7 @@ export interface CreateUserPoolClientRequest {
4824
5248
  */
4825
5249
  ExplicitAuthFlows?: (ExplicitAuthFlowsType | string)[];
4826
5250
  /**
5251
+ * @public
4827
5252
  * <p>A list of provider names for the identity providers (IdPs) that are supported on this
4828
5253
  * client. The following are supported: <code>COGNITO</code>, <code>Facebook</code>,
4829
5254
  * <code>Google</code>, <code>SignInWithApple</code>, and <code>LoginWithAmazon</code>. You can also specify the names
@@ -4832,6 +5257,7 @@ export interface CreateUserPoolClientRequest {
4832
5257
  */
4833
5258
  SupportedIdentityProviders?: string[];
4834
5259
  /**
5260
+ * @public
4835
5261
  * <p>A list of allowed redirect (callback) URLs for the IdPs.</p>
4836
5262
  * <p>A redirect URI must:</p>
4837
5263
  * <ul>
@@ -4853,10 +5279,12 @@ export interface CreateUserPoolClientRequest {
4853
5279
  */
4854
5280
  CallbackURLs?: string[];
4855
5281
  /**
5282
+ * @public
4856
5283
  * <p>A list of allowed logout URLs for the IdPs.</p>
4857
5284
  */
4858
5285
  LogoutURLs?: string[];
4859
5286
  /**
5287
+ * @public
4860
5288
  * <p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p>
4861
5289
  * <p>A redirect URI must:</p>
4862
5290
  * <ul>
@@ -4878,6 +5306,7 @@ export interface CreateUserPoolClientRequest {
4878
5306
  */
4879
5307
  DefaultRedirectURI?: string;
4880
5308
  /**
5309
+ * @public
4881
5310
  * <p>The allowed OAuth flows.</p>
4882
5311
  * <dl>
4883
5312
  * <dt>code</dt>
@@ -4901,6 +5330,7 @@ export interface CreateUserPoolClientRequest {
4901
5330
  */
4902
5331
  AllowedOAuthFlows?: (OAuthFlowType | string)[];
4903
5332
  /**
5333
+ * @public
4904
5334
  * <p>The allowed OAuth scopes. Possible values provided by OAuth are <code>phone</code>,
4905
5335
  * <code>email</code>, <code>openid</code>, and <code>profile</code>. Possible values
4906
5336
  * provided by Amazon Web Services are <code>aws.cognito.signin.user.admin</code>. Custom
@@ -4908,11 +5338,13 @@ export interface CreateUserPoolClientRequest {
4908
5338
  */
4909
5339
  AllowedOAuthScopes?: string[];
4910
5340
  /**
5341
+ * @public
4911
5342
  * <p>Set to true if the client is allowed to follow the OAuth protocol when interacting
4912
5343
  * with Amazon Cognito user pools.</p>
4913
5344
  */
4914
5345
  AllowedOAuthFlowsUserPoolClient?: boolean;
4915
5346
  /**
5347
+ * @public
4916
5348
  * <p>The user pool analytics configuration for collecting metrics and sending them to your
4917
5349
  * Amazon Pinpoint campaign.</p>
4918
5350
  * <note>
@@ -4924,6 +5356,7 @@ export interface CreateUserPoolClientRequest {
4924
5356
  */
4925
5357
  AnalyticsConfiguration?: AnalyticsConfigurationType;
4926
5358
  /**
5359
+ * @public
4927
5360
  * <p>Errors and responses that you want Amazon Cognito APIs to return during authentication, account
4928
5361
  * confirmation, and password recovery when the user doesn't exist in the user pool. When
4929
5362
  * set to <code>ENABLED</code> and the user doesn't exist, authentication returns an error
@@ -4947,6 +5380,7 @@ export interface CreateUserPoolClientRequest {
4947
5380
  */
4948
5381
  PreventUserExistenceErrors?: PreventUserExistenceErrorTypes | string;
4949
5382
  /**
5383
+ * @public
4950
5384
  * <p>Activates or deactivates token revocation. For more information about revoking tokens,
4951
5385
  * see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
4952
5386
  * <p>If you don't include this parameter, token revocation is automatically activated for
@@ -4954,6 +5388,7 @@ export interface CreateUserPoolClientRequest {
4954
5388
  */
4955
5389
  EnableTokenRevocation?: boolean;
4956
5390
  /**
5391
+ * @public
4957
5392
  * <p>Activates the propagation of additional user context data. For more information about
4958
5393
  * propagation of user context data, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html"> Adding advanced security to a user pool</a>. If you don’t include this
4959
5394
  * parameter, you can't send device fingerprint information, including source IP address,
@@ -4963,6 +5398,7 @@ export interface CreateUserPoolClientRequest {
4963
5398
  */
4964
5399
  EnablePropagateAdditionalUserContextData?: boolean;
4965
5400
  /**
5401
+ * @public
4966
5402
  * <p>Amazon Cognito creates a session token for each API request in an authentication flow. <code>AuthSessionValidity</code> is the duration,
4967
5403
  * in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.</p>
4968
5404
  */
@@ -4974,30 +5410,37 @@ export interface CreateUserPoolClientRequest {
4974
5410
  */
4975
5411
  export interface UserPoolClientType {
4976
5412
  /**
5413
+ * @public
4977
5414
  * <p>The user pool ID for the user pool client.</p>
4978
5415
  */
4979
5416
  UserPoolId?: string;
4980
5417
  /**
5418
+ * @public
4981
5419
  * <p>The client name from the user pool request of the client type.</p>
4982
5420
  */
4983
5421
  ClientName?: string;
4984
5422
  /**
5423
+ * @public
4985
5424
  * <p>The ID of the client associated with the user pool.</p>
4986
5425
  */
4987
5426
  ClientId?: string;
4988
5427
  /**
5428
+ * @public
4989
5429
  * <p>The client secret from the user pool request of the client type.</p>
4990
5430
  */
4991
5431
  ClientSecret?: string;
4992
5432
  /**
5433
+ * @public
4993
5434
  * <p>The date the user pool client was last modified.</p>
4994
5435
  */
4995
5436
  LastModifiedDate?: Date;
4996
5437
  /**
5438
+ * @public
4997
5439
  * <p>The date the user pool client was created.</p>
4998
5440
  */
4999
5441
  CreationDate?: Date;
5000
5442
  /**
5443
+ * @public
5001
5444
  * <p>The refresh token time limit. After this limit expires, your user can't use
5002
5445
  * their refresh token. To specify the time unit for <code>RefreshTokenValidity</code> as
5003
5446
  * <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>,
@@ -5014,6 +5457,7 @@ export interface UserPoolClientType {
5014
5457
  */
5015
5458
  RefreshTokenValidity?: number;
5016
5459
  /**
5460
+ * @public
5017
5461
  * <p>The access token time limit. After this limit expires, your user can't use
5018
5462
  * their access token. To specify the time unit for <code>AccessTokenValidity</code> as
5019
5463
  * <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>,
@@ -5028,6 +5472,7 @@ export interface UserPoolClientType {
5028
5472
  */
5029
5473
  AccessTokenValidity?: number;
5030
5474
  /**
5475
+ * @public
5031
5476
  * <p>The ID token time limit. After this limit expires, your user can't use
5032
5477
  * their ID token. To specify the time unit for <code>IdTokenValidity</code> as
5033
5478
  * <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>,
@@ -5042,19 +5487,23 @@ export interface UserPoolClientType {
5042
5487
  */
5043
5488
  IdTokenValidity?: number;
5044
5489
  /**
5490
+ * @public
5045
5491
  * <p>The time units used to specify the token validity times of each token type: ID,
5046
5492
  * access, and refresh.</p>
5047
5493
  */
5048
5494
  TokenValidityUnits?: TokenValidityUnitsType;
5049
5495
  /**
5496
+ * @public
5050
5497
  * <p>The Read-only attributes.</p>
5051
5498
  */
5052
5499
  ReadAttributes?: string[];
5053
5500
  /**
5501
+ * @public
5054
5502
  * <p>The writeable attributes.</p>
5055
5503
  */
5056
5504
  WriteAttributes?: string[];
5057
5505
  /**
5506
+ * @public
5058
5507
  * <p>The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in
5059
5508
  * your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and
5060
5509
  * password, or a custom authentication process that you define with Lambda functions.</p>
@@ -5098,12 +5547,14 @@ export interface UserPoolClientType {
5098
5547
  */
5099
5548
  ExplicitAuthFlows?: (ExplicitAuthFlowsType | string)[];
5100
5549
  /**
5550
+ * @public
5101
5551
  * <p>A list of provider names for the IdPs that this client supports. The following are
5102
5552
  * supported: <code>COGNITO</code>, <code>Facebook</code>, <code>Google</code>, <code>SignInWithApple</code>,
5103
5553
  * <code>LoginWithAmazon</code>, and the names of your own SAML and OIDC providers.</p>
5104
5554
  */
5105
5555
  SupportedIdentityProviders?: string[];
5106
5556
  /**
5557
+ * @public
5107
5558
  * <p>A list of allowed redirect (callback) URLs for the IdPs.</p>
5108
5559
  * <p>A redirect URI must:</p>
5109
5560
  * <ul>
@@ -5125,10 +5576,12 @@ export interface UserPoolClientType {
5125
5576
  */
5126
5577
  CallbackURLs?: string[];
5127
5578
  /**
5579
+ * @public
5128
5580
  * <p>A list of allowed logout URLs for the IdPs.</p>
5129
5581
  */
5130
5582
  LogoutURLs?: string[];
5131
5583
  /**
5584
+ * @public
5132
5585
  * <p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p>
5133
5586
  * <p>A redirect URI must:</p>
5134
5587
  * <ul>
@@ -5150,6 +5603,7 @@ export interface UserPoolClientType {
5150
5603
  */
5151
5604
  DefaultRedirectURI?: string;
5152
5605
  /**
5606
+ * @public
5153
5607
  * <p>The allowed OAuth flows.</p>
5154
5608
  * <dl>
5155
5609
  * <dt>code</dt>
@@ -5173,6 +5627,7 @@ export interface UserPoolClientType {
5173
5627
  */
5174
5628
  AllowedOAuthFlows?: (OAuthFlowType | string)[];
5175
5629
  /**
5630
+ * @public
5176
5631
  * <p>The OAuth scopes that your app client supports. Possible values that OAuth provides
5177
5632
  * are <code>phone</code>, <code>email</code>, <code>openid</code>, and
5178
5633
  * <code>profile</code>. Possible values that Amazon Web Services provides are
@@ -5181,11 +5636,13 @@ export interface UserPoolClientType {
5181
5636
  */
5182
5637
  AllowedOAuthScopes?: string[];
5183
5638
  /**
5639
+ * @public
5184
5640
  * <p>Set to true if the client is allowed to follow the OAuth protocol when interacting
5185
5641
  * with Amazon Cognito user pools.</p>
5186
5642
  */
5187
5643
  AllowedOAuthFlowsUserPoolClient?: boolean;
5188
5644
  /**
5645
+ * @public
5189
5646
  * <p>The Amazon Pinpoint analytics configuration for the user pool client.</p>
5190
5647
  * <note>
5191
5648
  * <p>Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East
@@ -5195,6 +5652,7 @@ export interface UserPoolClientType {
5195
5652
  */
5196
5653
  AnalyticsConfiguration?: AnalyticsConfigurationType;
5197
5654
  /**
5655
+ * @public
5198
5656
  * <p>Errors and responses that you want Amazon Cognito APIs to return during authentication, account
5199
5657
  * confirmation, and password recovery when the user doesn't exist in the user pool. When
5200
5658
  * set to <code>ENABLED</code> and the user doesn't exist, authentication returns an error
@@ -5218,12 +5676,14 @@ export interface UserPoolClientType {
5218
5676
  */
5219
5677
  PreventUserExistenceErrors?: PreventUserExistenceErrorTypes | string;
5220
5678
  /**
5679
+ * @public
5221
5680
  * <p>Indicates whether token revocation is activated for the user pool client. When you
5222
5681
  * create a new user pool client, token revocation is activated by default. For more
5223
5682
  * information about revoking tokens, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
5224
5683
  */
5225
5684
  EnableTokenRevocation?: boolean;
5226
5685
  /**
5686
+ * @public
5227
5687
  * <p>When <code>EnablePropagateAdditionalUserContextData</code> is true, Amazon Cognito accepts an
5228
5688
  * <code>IpAddress</code> value that you send in the <code>UserContextData</code>
5229
5689
  * parameter. The <code>UserContextData</code> parameter sends information to Amazon Cognito
@@ -5242,6 +5702,7 @@ export interface UserPoolClientType {
5242
5702
  */
5243
5703
  EnablePropagateAdditionalUserContextData?: boolean;
5244
5704
  /**
5705
+ * @public
5245
5706
  * <p>Amazon Cognito creates a session token for each API request in an authentication flow. <code>AuthSessionValidity</code> is the duration,
5246
5707
  * in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.</p>
5247
5708
  */
@@ -5253,6 +5714,7 @@ export interface UserPoolClientType {
5253
5714
  */
5254
5715
  export interface CreateUserPoolClientResponse {
5255
5716
  /**
5717
+ * @public
5256
5718
  * <p>The user pool client that was just created.</p>
5257
5719
  */
5258
5720
  UserPoolClient?: UserPoolClientType;
@@ -5288,6 +5750,7 @@ export declare class ScopeDoesNotExistException extends __BaseException {
5288
5750
  */
5289
5751
  export interface CustomDomainConfigType {
5290
5752
  /**
5753
+ * @public
5291
5754
  * <p>The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use
5292
5755
  * this certificate for the subdomain of your custom domain.</p>
5293
5756
  */
@@ -5298,16 +5761,19 @@ export interface CustomDomainConfigType {
5298
5761
  */
5299
5762
  export interface CreateUserPoolDomainRequest {
5300
5763
  /**
5764
+ * @public
5301
5765
  * <p>The domain string. For custom domains, this is the fully-qualified domain name, such
5302
5766
  * as <code>auth.example.com</code>. For Amazon Cognito prefix domains, this is the prefix alone,
5303
5767
  * such as <code>auth</code>.</p>
5304
5768
  */
5305
5769
  Domain: string | undefined;
5306
5770
  /**
5771
+ * @public
5307
5772
  * <p>The user pool ID.</p>
5308
5773
  */
5309
5774
  UserPoolId: string | undefined;
5310
5775
  /**
5776
+ * @public
5311
5777
  * <p>The configuration for a custom domain that hosts the sign-up and sign-in webpages for
5312
5778
  * your application.</p>
5313
5779
  * <p>Provide this parameter only if you want to use a custom domain for your user pool.
@@ -5322,6 +5788,7 @@ export interface CreateUserPoolDomainRequest {
5322
5788
  */
5323
5789
  export interface CreateUserPoolDomainResponse {
5324
5790
  /**
5791
+ * @public
5325
5792
  * <p>The Amazon CloudFront endpoint that you use as the target of the alias that you set up with
5326
5793
  * your Domain Name Service (DNS) provider.</p>
5327
5794
  */
@@ -5332,10 +5799,12 @@ export interface CreateUserPoolDomainResponse {
5332
5799
  */
5333
5800
  export interface DeleteGroupRequest {
5334
5801
  /**
5802
+ * @public
5335
5803
  * <p>The name of the group.</p>
5336
5804
  */
5337
5805
  GroupName: string | undefined;
5338
5806
  /**
5807
+ * @public
5339
5808
  * <p>The user pool ID for the user pool.</p>
5340
5809
  */
5341
5810
  UserPoolId: string | undefined;
@@ -5345,10 +5814,12 @@ export interface DeleteGroupRequest {
5345
5814
  */
5346
5815
  export interface DeleteIdentityProviderRequest {
5347
5816
  /**
5817
+ * @public
5348
5818
  * <p>The user pool ID.</p>
5349
5819
  */
5350
5820
  UserPoolId: string | undefined;
5351
5821
  /**
5822
+ * @public
5352
5823
  * <p>The IdP name.</p>
5353
5824
  */
5354
5825
  ProviderName: string | undefined;
@@ -5370,10 +5841,12 @@ export declare class UnsupportedIdentityProviderException extends __BaseExceptio
5370
5841
  */
5371
5842
  export interface DeleteResourceServerRequest {
5372
5843
  /**
5844
+ * @public
5373
5845
  * <p>The user pool ID for the user pool that hosts the resource server.</p>
5374
5846
  */
5375
5847
  UserPoolId: string | undefined;
5376
5848
  /**
5849
+ * @public
5377
5850
  * <p>The identifier for the resource server.</p>
5378
5851
  */
5379
5852
  Identifier: string | undefined;
@@ -5384,6 +5857,7 @@ export interface DeleteResourceServerRequest {
5384
5857
  */
5385
5858
  export interface DeleteUserRequest {
5386
5859
  /**
5860
+ * @public
5387
5861
  * <p>A valid access token that Amazon Cognito issued to the user whose user profile you want to
5388
5862
  * delete.</p>
5389
5863
  */
@@ -5395,12 +5869,14 @@ export interface DeleteUserRequest {
5395
5869
  */
5396
5870
  export interface DeleteUserAttributesRequest {
5397
5871
  /**
5872
+ * @public
5398
5873
  * <p>An array of strings representing the user attribute names you want to delete.</p>
5399
5874
  * <p>For custom attributes, you must prependattach the <code>custom:</code> prefix to the
5400
5875
  * front of the attribute name.</p>
5401
5876
  */
5402
5877
  UserAttributeNames: string[] | undefined;
5403
5878
  /**
5879
+ * @public
5404
5880
  * <p>A valid access token that Amazon Cognito issued to the user whose attributes you want to
5405
5881
  * delete.</p>
5406
5882
  */
@@ -5418,6 +5894,7 @@ export interface DeleteUserAttributesResponse {
5418
5894
  */
5419
5895
  export interface DeleteUserPoolRequest {
5420
5896
  /**
5897
+ * @public
5421
5898
  * <p>The user pool ID for the user pool you want to delete.</p>
5422
5899
  */
5423
5900
  UserPoolId: string | undefined;
@@ -5428,10 +5905,12 @@ export interface DeleteUserPoolRequest {
5428
5905
  */
5429
5906
  export interface DeleteUserPoolClientRequest {
5430
5907
  /**
5908
+ * @public
5431
5909
  * <p>The user pool ID for the user pool where you want to delete the client.</p>
5432
5910
  */
5433
5911
  UserPoolId: string | undefined;
5434
5912
  /**
5913
+ * @public
5435
5914
  * <p>The app client ID of the app associated with the user pool.</p>
5436
5915
  */
5437
5916
  ClientId: string | undefined;
@@ -5441,12 +5920,14 @@ export interface DeleteUserPoolClientRequest {
5441
5920
  */
5442
5921
  export interface DeleteUserPoolDomainRequest {
5443
5922
  /**
5923
+ * @public
5444
5924
  * <p>The domain string. For custom domains, this is the fully-qualified domain name, such
5445
5925
  * as <code>auth.example.com</code>. For Amazon Cognito prefix domains, this is the prefix alone,
5446
5926
  * such as <code>auth</code>.</p>
5447
5927
  */
5448
5928
  Domain: string | undefined;
5449
5929
  /**
5930
+ * @public
5450
5931
  * <p>The user pool ID.</p>
5451
5932
  */
5452
5933
  UserPoolId: string | undefined;
@@ -5461,10 +5942,12 @@ export interface DeleteUserPoolDomainResponse {
5461
5942
  */
5462
5943
  export interface DescribeIdentityProviderRequest {
5463
5944
  /**
5945
+ * @public
5464
5946
  * <p>The user pool ID.</p>
5465
5947
  */
5466
5948
  UserPoolId: string | undefined;
5467
5949
  /**
5950
+ * @public
5468
5951
  * <p>The IdP name.</p>
5469
5952
  */
5470
5953
  ProviderName: string | undefined;
@@ -5474,6 +5957,7 @@ export interface DescribeIdentityProviderRequest {
5474
5957
  */
5475
5958
  export interface DescribeIdentityProviderResponse {
5476
5959
  /**
5960
+ * @public
5477
5961
  * <p>The identity provider details.</p>
5478
5962
  */
5479
5963
  IdentityProvider: IdentityProviderType | undefined;
@@ -5483,10 +5967,12 @@ export interface DescribeIdentityProviderResponse {
5483
5967
  */
5484
5968
  export interface DescribeResourceServerRequest {
5485
5969
  /**
5970
+ * @public
5486
5971
  * <p>The user pool ID for the user pool that hosts the resource server.</p>
5487
5972
  */
5488
5973
  UserPoolId: string | undefined;
5489
5974
  /**
5975
+ * @public
5490
5976
  * <p>The identifier for the resource server</p>
5491
5977
  */
5492
5978
  Identifier: string | undefined;
@@ -5496,6 +5982,7 @@ export interface DescribeResourceServerRequest {
5496
5982
  */
5497
5983
  export interface DescribeResourceServerResponse {
5498
5984
  /**
5985
+ * @public
5499
5986
  * <p>The resource server.</p>
5500
5987
  */
5501
5988
  ResourceServer: ResourceServerType | undefined;
@@ -5505,10 +5992,12 @@ export interface DescribeResourceServerResponse {
5505
5992
  */
5506
5993
  export interface DescribeRiskConfigurationRequest {
5507
5994
  /**
5995
+ * @public
5508
5996
  * <p>The user pool ID.</p>
5509
5997
  */
5510
5998
  UserPoolId: string | undefined;
5511
5999
  /**
6000
+ * @public
5512
6001
  * <p>The app client ID.</p>
5513
6002
  */
5514
6003
  ClientId?: string;
@@ -5531,6 +6020,7 @@ export type CompromisedCredentialsEventActionType = (typeof CompromisedCredentia
5531
6020
  */
5532
6021
  export interface CompromisedCredentialsActionsType {
5533
6022
  /**
6023
+ * @public
5534
6024
  * <p>The event action.</p>
5535
6025
  */
5536
6026
  EventAction: CompromisedCredentialsEventActionType | string | undefined;
@@ -5554,11 +6044,13 @@ export type EventFilterType = (typeof EventFilterType)[keyof typeof EventFilterT
5554
6044
  */
5555
6045
  export interface CompromisedCredentialsRiskConfigurationType {
5556
6046
  /**
6047
+ * @public
5557
6048
  * <p>Perform the action for these events. The default is to perform all events if no event
5558
6049
  * filter is specified.</p>
5559
6050
  */
5560
6051
  EventFilter?: (EventFilterType | string)[];
5561
6052
  /**
6053
+ * @public
5562
6054
  * <p>The compromised credentials risk configuration actions.</p>
5563
6055
  */
5564
6056
  Actions: CompromisedCredentialsActionsType | undefined;
@@ -5569,12 +6061,14 @@ export interface CompromisedCredentialsRiskConfigurationType {
5569
6061
  */
5570
6062
  export interface RiskExceptionConfigurationType {
5571
6063
  /**
6064
+ * @public
5572
6065
  * <p>Overrides the risk decision to always block the pre-authentication requests. The IP
5573
6066
  * range is in CIDR notation, a compact representation of an IP address and its routing
5574
6067
  * prefix.</p>
5575
6068
  */
5576
6069
  BlockedIPRangeList?: string[];
5577
6070
  /**
6071
+ * @public
5578
6072
  * <p>Risk detection isn't performed on the IP addresses in this range list. The IP range is
5579
6073
  * in CIDR notation.</p>
5580
6074
  */
@@ -5586,29 +6080,35 @@ export interface RiskExceptionConfigurationType {
5586
6080
  */
5587
6081
  export interface RiskConfigurationType {
5588
6082
  /**
6083
+ * @public
5589
6084
  * <p>The user pool ID.</p>
5590
6085
  */
5591
6086
  UserPoolId?: string;
5592
6087
  /**
6088
+ * @public
5593
6089
  * <p>The app client ID.</p>
5594
6090
  */
5595
6091
  ClientId?: string;
5596
6092
  /**
6093
+ * @public
5597
6094
  * <p>The compromised credentials risk configuration object, including the
5598
6095
  * <code>EventFilter</code> and the <code>EventAction</code>.</p>
5599
6096
  */
5600
6097
  CompromisedCredentialsRiskConfiguration?: CompromisedCredentialsRiskConfigurationType;
5601
6098
  /**
6099
+ * @public
5602
6100
  * <p>The account takeover risk configuration object, including the
5603
6101
  * <code>NotifyConfiguration</code> object and <code>Actions</code> to take if there is
5604
6102
  * an account takeover.</p>
5605
6103
  */
5606
6104
  AccountTakeoverRiskConfiguration?: AccountTakeoverRiskConfigurationType;
5607
6105
  /**
6106
+ * @public
5608
6107
  * <p>The configuration to override the risk decision.</p>
5609
6108
  */
5610
6109
  RiskExceptionConfiguration?: RiskExceptionConfigurationType;
5611
6110
  /**
6111
+ * @public
5612
6112
  * <p>The last modified date.</p>
5613
6113
  */
5614
6114
  LastModifiedDate?: Date;
@@ -5618,6 +6118,7 @@ export interface RiskConfigurationType {
5618
6118
  */
5619
6119
  export interface DescribeRiskConfigurationResponse {
5620
6120
  /**
6121
+ * @public
5621
6122
  * <p>The risk configuration.</p>
5622
6123
  */
5623
6124
  RiskConfiguration: RiskConfigurationType | undefined;
@@ -5628,10 +6129,12 @@ export interface DescribeRiskConfigurationResponse {
5628
6129
  */
5629
6130
  export interface DescribeUserImportJobRequest {
5630
6131
  /**
6132
+ * @public
5631
6133
  * <p>The user pool ID for the user pool that the users are being imported into.</p>
5632
6134
  */
5633
6135
  UserPoolId: string | undefined;
5634
6136
  /**
6137
+ * @public
5635
6138
  * <p>The job ID for the user import job.</p>
5636
6139
  */
5637
6140
  JobId: string | undefined;
@@ -5643,6 +6146,7 @@ export interface DescribeUserImportJobRequest {
5643
6146
  */
5644
6147
  export interface DescribeUserImportJobResponse {
5645
6148
  /**
6149
+ * @public
5646
6150
  * <p>The job object that represents the user import job.</p>
5647
6151
  */
5648
6152
  UserImportJob?: UserImportJobType;
@@ -5653,6 +6157,7 @@ export interface DescribeUserImportJobResponse {
5653
6157
  */
5654
6158
  export interface DescribeUserPoolRequest {
5655
6159
  /**
6160
+ * @public
5656
6161
  * <p>The user pool ID for the user pool you want to describe.</p>
5657
6162
  */
5658
6163
  UserPoolId: string | undefined;
@@ -5663,6 +6168,7 @@ export interface DescribeUserPoolRequest {
5663
6168
  */
5664
6169
  export interface DescribeUserPoolResponse {
5665
6170
  /**
6171
+ * @public
5666
6172
  * <p>The container of metadata returned by the server to describe the pool.</p>
5667
6173
  */
5668
6174
  UserPool?: UserPoolType;
@@ -5673,10 +6179,12 @@ export interface DescribeUserPoolResponse {
5673
6179
  */
5674
6180
  export interface DescribeUserPoolClientRequest {
5675
6181
  /**
6182
+ * @public
5676
6183
  * <p>The user pool ID for the user pool you want to describe.</p>
5677
6184
  */
5678
6185
  UserPoolId: string | undefined;
5679
6186
  /**
6187
+ * @public
5680
6188
  * <p>The app client ID of the app associated with the user pool.</p>
5681
6189
  */
5682
6190
  ClientId: string | undefined;
@@ -5688,6 +6196,7 @@ export interface DescribeUserPoolClientRequest {
5688
6196
  */
5689
6197
  export interface DescribeUserPoolClientResponse {
5690
6198
  /**
6199
+ * @public
5691
6200
  * <p>The user pool client from a server response to describe the user pool client.</p>
5692
6201
  */
5693
6202
  UserPoolClient?: UserPoolClientType;
@@ -5697,6 +6206,7 @@ export interface DescribeUserPoolClientResponse {
5697
6206
  */
5698
6207
  export interface DescribeUserPoolDomainRequest {
5699
6208
  /**
6209
+ * @public
5700
6210
  * <p>The domain string. For custom domains, this is the fully-qualified domain name, such
5701
6211
  * as <code>auth.example.com</code>. For Amazon Cognito prefix domains, this is the prefix alone,
5702
6212
  * such as <code>auth</code>.</p>
@@ -5724,36 +6234,44 @@ export type DomainStatusType = (typeof DomainStatusType)[keyof typeof DomainStat
5724
6234
  */
5725
6235
  export interface DomainDescriptionType {
5726
6236
  /**
6237
+ * @public
5727
6238
  * <p>The user pool ID.</p>
5728
6239
  */
5729
6240
  UserPoolId?: string;
5730
6241
  /**
6242
+ * @public
5731
6243
  * <p>The Amazon Web Services ID for the user pool owner.</p>
5732
6244
  */
5733
6245
  AWSAccountId?: string;
5734
6246
  /**
6247
+ * @public
5735
6248
  * <p>The domain string. For custom domains, this is the fully-qualified domain name, such
5736
6249
  * as <code>auth.example.com</code>. For Amazon Cognito prefix domains, this is the prefix alone,
5737
6250
  * such as <code>auth</code>.</p>
5738
6251
  */
5739
6252
  Domain?: string;
5740
6253
  /**
6254
+ * @public
5741
6255
  * <p>The Amazon S3 bucket where the static files for this domain are stored.</p>
5742
6256
  */
5743
6257
  S3Bucket?: string;
5744
6258
  /**
6259
+ * @public
5745
6260
  * <p>The Amazon Resource Name (ARN) of the Amazon CloudFront distribution.</p>
5746
6261
  */
5747
6262
  CloudFrontDistribution?: string;
5748
6263
  /**
6264
+ * @public
5749
6265
  * <p>The app version.</p>
5750
6266
  */
5751
6267
  Version?: string;
5752
6268
  /**
6269
+ * @public
5753
6270
  * <p>The domain status.</p>
5754
6271
  */
5755
6272
  Status?: DomainStatusType | string;
5756
6273
  /**
6274
+ * @public
5757
6275
  * <p>The configuration for a custom domain that hosts the sign-up and sign-in webpages for
5758
6276
  * your application.</p>
5759
6277
  */
@@ -5764,6 +6282,7 @@ export interface DomainDescriptionType {
5764
6282
  */
5765
6283
  export interface DescribeUserPoolDomainResponse {
5766
6284
  /**
6285
+ * @public
5767
6286
  * <p>A domain description object containing information about the domain.</p>
5768
6287
  */
5769
6288
  DomainDescription?: DomainDescriptionType;
@@ -5774,11 +6293,13 @@ export interface DescribeUserPoolDomainResponse {
5774
6293
  */
5775
6294
  export interface ForgetDeviceRequest {
5776
6295
  /**
6296
+ * @public
5777
6297
  * <p>A valid access token that Amazon Cognito issued to the user whose registered device you want to
5778
6298
  * forget.</p>
5779
6299
  */
5780
6300
  AccessToken?: string;
5781
6301
  /**
6302
+ * @public
5782
6303
  * <p>The device key.</p>
5783
6304
  */
5784
6305
  DeviceKey: string | undefined;
@@ -5789,31 +6310,37 @@ export interface ForgetDeviceRequest {
5789
6310
  */
5790
6311
  export interface ForgotPasswordRequest {
5791
6312
  /**
6313
+ * @public
5792
6314
  * <p>The ID of the client associated with the user pool.</p>
5793
6315
  */
5794
6316
  ClientId: string | undefined;
5795
6317
  /**
6318
+ * @public
5796
6319
  * <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a
5797
6320
  * user pool client and username plus the client ID in the message.</p>
5798
6321
  */
5799
6322
  SecretHash?: string;
5800
6323
  /**
6324
+ * @public
5801
6325
  * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
5802
6326
  * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
5803
6327
  * when it makes API requests.</p>
5804
6328
  */
5805
6329
  UserContextData?: UserContextDataType;
5806
6330
  /**
6331
+ * @public
5807
6332
  * <p>The user name of the user for whom you want to enter a code to reset a forgotten
5808
6333
  * password.</p>
5809
6334
  */
5810
6335
  Username: string | undefined;
5811
6336
  /**
6337
+ * @public
5812
6338
  * <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for
5813
6339
  * <code>ForgotPassword</code> calls.</p>
5814
6340
  */
5815
6341
  AnalyticsMetadata?: AnalyticsMetadataType;
5816
6342
  /**
6343
+ * @public
5817
6344
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
5818
6345
  * that this action triggers.</p>
5819
6346
  * <p>You create custom workflows by assigning Lambda functions to user pool
@@ -5857,14 +6384,17 @@ export interface ForgotPasswordRequest {
5857
6384
  */
5858
6385
  export interface CodeDeliveryDetailsType {
5859
6386
  /**
6387
+ * @public
5860
6388
  * <p>The email address or phone number destination where Amazon Cognito sent the code.</p>
5861
6389
  */
5862
6390
  Destination?: string;
5863
6391
  /**
6392
+ * @public
5864
6393
  * <p>The method that Amazon Cognito used to send the code.</p>
5865
6394
  */
5866
6395
  DeliveryMedium?: DeliveryMediumType | string;
5867
6396
  /**
6397
+ * @public
5868
6398
  * <p>The name of the attribute that Amazon Cognito verifies with the code.</p>
5869
6399
  */
5870
6400
  AttributeName?: string;
@@ -5875,6 +6405,7 @@ export interface CodeDeliveryDetailsType {
5875
6405
  */
5876
6406
  export interface ForgotPasswordResponse {
5877
6407
  /**
6408
+ * @public
5878
6409
  * <p>The code delivery details returned by the server in response to the request to reset a
5879
6410
  * password.</p>
5880
6411
  */
@@ -5887,6 +6418,7 @@ export interface ForgotPasswordResponse {
5887
6418
  */
5888
6419
  export interface GetCSVHeaderRequest {
5889
6420
  /**
6421
+ * @public
5890
6422
  * <p>The user pool ID for the user pool that the users are to be imported into.</p>
5891
6423
  */
5892
6424
  UserPoolId: string | undefined;
@@ -5898,10 +6430,12 @@ export interface GetCSVHeaderRequest {
5898
6430
  */
5899
6431
  export interface GetCSVHeaderResponse {
5900
6432
  /**
6433
+ * @public
5901
6434
  * <p>The user pool ID for the user pool that the users are to be imported into.</p>
5902
6435
  */
5903
6436
  UserPoolId?: string;
5904
6437
  /**
6438
+ * @public
5905
6439
  * <p>The header information of the CSV file for the user import job.</p>
5906
6440
  */
5907
6441
  CSVHeader?: string[];
@@ -5912,10 +6446,12 @@ export interface GetCSVHeaderResponse {
5912
6446
  */
5913
6447
  export interface GetDeviceRequest {
5914
6448
  /**
6449
+ * @public
5915
6450
  * <p>The device key.</p>
5916
6451
  */
5917
6452
  DeviceKey: string | undefined;
5918
6453
  /**
6454
+ * @public
5919
6455
  * <p>A valid access token that Amazon Cognito issued to the user whose device information you want
5920
6456
  * to request.</p>
5921
6457
  */
@@ -5927,6 +6463,7 @@ export interface GetDeviceRequest {
5927
6463
  */
5928
6464
  export interface GetDeviceResponse {
5929
6465
  /**
6466
+ * @public
5930
6467
  * <p>The device.</p>
5931
6468
  */
5932
6469
  Device: DeviceType | undefined;
@@ -5936,10 +6473,12 @@ export interface GetDeviceResponse {
5936
6473
  */
5937
6474
  export interface GetGroupRequest {
5938
6475
  /**
6476
+ * @public
5939
6477
  * <p>The name of the group.</p>
5940
6478
  */
5941
6479
  GroupName: string | undefined;
5942
6480
  /**
6481
+ * @public
5943
6482
  * <p>The user pool ID for the user pool.</p>
5944
6483
  */
5945
6484
  UserPoolId: string | undefined;
@@ -5949,6 +6488,7 @@ export interface GetGroupRequest {
5949
6488
  */
5950
6489
  export interface GetGroupResponse {
5951
6490
  /**
6491
+ * @public
5952
6492
  * <p>The group object for the group.</p>
5953
6493
  */
5954
6494
  Group?: GroupType;
@@ -5958,10 +6498,12 @@ export interface GetGroupResponse {
5958
6498
  */
5959
6499
  export interface GetIdentityProviderByIdentifierRequest {
5960
6500
  /**
6501
+ * @public
5961
6502
  * <p>The user pool ID.</p>
5962
6503
  */
5963
6504
  UserPoolId: string | undefined;
5964
6505
  /**
6506
+ * @public
5965
6507
  * <p>The IdP identifier.</p>
5966
6508
  */
5967
6509
  IdpIdentifier: string | undefined;
@@ -5971,6 +6513,7 @@ export interface GetIdentityProviderByIdentifierRequest {
5971
6513
  */
5972
6514
  export interface GetIdentityProviderByIdentifierResponse {
5973
6515
  /**
6516
+ * @public
5974
6517
  * <p>The identity provider details.</p>
5975
6518
  */
5976
6519
  IdentityProvider: IdentityProviderType | undefined;
@@ -5981,6 +6524,7 @@ export interface GetIdentityProviderByIdentifierResponse {
5981
6524
  */
5982
6525
  export interface GetSigningCertificateRequest {
5983
6526
  /**
6527
+ * @public
5984
6528
  * <p>The user pool ID.</p>
5985
6529
  */
5986
6530
  UserPoolId: string | undefined;
@@ -5991,6 +6535,7 @@ export interface GetSigningCertificateRequest {
5991
6535
  */
5992
6536
  export interface GetSigningCertificateResponse {
5993
6537
  /**
6538
+ * @public
5994
6539
  * <p>The signing certificate.</p>
5995
6540
  */
5996
6541
  Certificate?: string;
@@ -6000,10 +6545,12 @@ export interface GetSigningCertificateResponse {
6000
6545
  */
6001
6546
  export interface GetUICustomizationRequest {
6002
6547
  /**
6548
+ * @public
6003
6549
  * <p>The user pool ID for the user pool.</p>
6004
6550
  */
6005
6551
  UserPoolId: string | undefined;
6006
6552
  /**
6553
+ * @public
6007
6554
  * <p>The client ID for the client app.</p>
6008
6555
  */
6009
6556
  ClientId?: string;
@@ -6015,30 +6562,37 @@ export interface GetUICustomizationRequest {
6015
6562
  */
6016
6563
  export interface UICustomizationType {
6017
6564
  /**
6565
+ * @public
6018
6566
  * <p>The user pool ID for the user pool.</p>
6019
6567
  */
6020
6568
  UserPoolId?: string;
6021
6569
  /**
6570
+ * @public
6022
6571
  * <p>The client ID for the client app.</p>
6023
6572
  */
6024
6573
  ClientId?: string;
6025
6574
  /**
6575
+ * @public
6026
6576
  * <p>The logo image for the UI customization.</p>
6027
6577
  */
6028
6578
  ImageUrl?: string;
6029
6579
  /**
6580
+ * @public
6030
6581
  * <p>The CSS values in the UI customization.</p>
6031
6582
  */
6032
6583
  CSS?: string;
6033
6584
  /**
6585
+ * @public
6034
6586
  * <p>The CSS version number.</p>
6035
6587
  */
6036
6588
  CSSVersion?: string;
6037
6589
  /**
6590
+ * @public
6038
6591
  * <p>The last-modified date for the UI customization.</p>
6039
6592
  */
6040
6593
  LastModifiedDate?: Date;
6041
6594
  /**
6595
+ * @public
6042
6596
  * <p>The creation date for the UI customization.</p>
6043
6597
  */
6044
6598
  CreationDate?: Date;
@@ -6048,6 +6602,7 @@ export interface UICustomizationType {
6048
6602
  */
6049
6603
  export interface GetUICustomizationResponse {
6050
6604
  /**
6605
+ * @public
6051
6606
  * <p>The UI customization information.</p>
6052
6607
  */
6053
6608
  UICustomization: UICustomizationType | undefined;
@@ -6058,6 +6613,7 @@ export interface GetUICustomizationResponse {
6058
6613
  */
6059
6614
  export interface GetUserRequest {
6060
6615
  /**
6616
+ * @public
6061
6617
  * <p>A non-expired access token for the user whose information you want to query.</p>
6062
6618
  */
6063
6619
  AccessToken: string | undefined;
@@ -6069,16 +6625,19 @@ export interface GetUserRequest {
6069
6625
  */
6070
6626
  export interface GetUserResponse {
6071
6627
  /**
6628
+ * @public
6072
6629
  * <p>The user name of the user you want to retrieve from the get user request.</p>
6073
6630
  */
6074
6631
  Username: string | undefined;
6075
6632
  /**
6633
+ * @public
6076
6634
  * <p>An array of name-value pairs representing user attributes.</p>
6077
6635
  * <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the
6078
6636
  * attribute name.</p>
6079
6637
  */
6080
6638
  UserAttributes: AttributeType[] | undefined;
6081
6639
  /**
6640
+ * @public
6082
6641
  * <p>
6083
6642
  * <i>This response parameter is no longer supported.</i> It provides
6084
6643
  * information only about SMS MFA configurations. It doesn't provide information about
@@ -6088,10 +6647,12 @@ export interface GetUserResponse {
6088
6647
  */
6089
6648
  MFAOptions?: MFAOptionType[];
6090
6649
  /**
6650
+ * @public
6091
6651
  * <p>The user's preferred MFA setting.</p>
6092
6652
  */
6093
6653
  PreferredMfaSetting?: string;
6094
6654
  /**
6655
+ * @public
6095
6656
  * <p>The MFA options that are activated for the user. The possible values in this list are
6096
6657
  * <code>SMS_MFA</code> and <code>SOFTWARE_TOKEN_MFA</code>.</p>
6097
6658
  */
@@ -6103,16 +6664,19 @@ export interface GetUserResponse {
6103
6664
  */
6104
6665
  export interface GetUserAttributeVerificationCodeRequest {
6105
6666
  /**
6667
+ * @public
6106
6668
  * <p>A non-expired access token for the user whose attribute verification code you want to
6107
6669
  * generate.</p>
6108
6670
  */
6109
6671
  AccessToken: string | undefined;
6110
6672
  /**
6673
+ * @public
6111
6674
  * <p>The attribute name returned by the server response to get the user attribute
6112
6675
  * verification code.</p>
6113
6676
  */
6114
6677
  AttributeName: string | undefined;
6115
6678
  /**
6679
+ * @public
6116
6680
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
6117
6681
  * that this action triggers.</p>
6118
6682
  * <p>You create custom workflows by assigning Lambda functions to user pool
@@ -6154,6 +6718,7 @@ export interface GetUserAttributeVerificationCodeRequest {
6154
6718
  */
6155
6719
  export interface GetUserAttributeVerificationCodeResponse {
6156
6720
  /**
6721
+ * @public
6157
6722
  * <p>The code delivery details returned by the server in response to the request to get the
6158
6723
  * user attribute verification code.</p>
6159
6724
  */
@@ -6164,6 +6729,7 @@ export interface GetUserAttributeVerificationCodeResponse {
6164
6729
  */
6165
6730
  export interface GetUserPoolMfaConfigRequest {
6166
6731
  /**
6732
+ * @public
6167
6733
  * <p>The user pool ID.</p>
6168
6734
  */
6169
6735
  UserPoolId: string | undefined;
@@ -6174,12 +6740,14 @@ export interface GetUserPoolMfaConfigRequest {
6174
6740
  */
6175
6741
  export interface SmsMfaConfigType {
6176
6742
  /**
6743
+ * @public
6177
6744
  * <p>The SMS authentication message that will be sent to users with the code they must sign
6178
6745
  * in. The message must contain the ‘\{####\}’ placeholder, which is replaced with the code.
6179
6746
  * If the message isn't included, and default message will be used.</p>
6180
6747
  */
6181
6748
  SmsAuthenticationMessage?: string;
6182
6749
  /**
6750
+ * @public
6183
6751
  * <p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an
6184
6752
  * SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To request Amazon SNS in
6185
6753
  * the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role that
@@ -6193,6 +6761,7 @@ export interface SmsMfaConfigType {
6193
6761
  */
6194
6762
  export interface SoftwareTokenMfaConfigType {
6195
6763
  /**
6764
+ * @public
6196
6765
  * <p>Specifies whether software token MFA is activated.</p>
6197
6766
  */
6198
6767
  Enabled?: boolean;
@@ -6202,14 +6771,17 @@ export interface SoftwareTokenMfaConfigType {
6202
6771
  */
6203
6772
  export interface GetUserPoolMfaConfigResponse {
6204
6773
  /**
6774
+ * @public
6205
6775
  * <p>The SMS text message multi-factor authentication (MFA) configuration.</p>
6206
6776
  */
6207
6777
  SmsMfaConfiguration?: SmsMfaConfigType;
6208
6778
  /**
6779
+ * @public
6209
6780
  * <p>The software token multi-factor authentication (MFA) configuration.</p>
6210
6781
  */
6211
6782
  SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType;
6212
6783
  /**
6784
+ * @public
6213
6785
  * <p>The multi-factor authentication (MFA) configuration. Valid values include:</p>
6214
6786
  * <ul>
6215
6787
  * <li>
@@ -6235,6 +6807,7 @@ export interface GetUserPoolMfaConfigResponse {
6235
6807
  */
6236
6808
  export interface GlobalSignOutRequest {
6237
6809
  /**
6810
+ * @public
6238
6811
  * <p>A valid access token that Amazon Cognito issued to the user who you want to sign out.</p>
6239
6812
  */
6240
6813
  AccessToken: string | undefined;
@@ -6251,6 +6824,7 @@ export interface GlobalSignOutResponse {
6251
6824
  */
6252
6825
  export interface InitiateAuthRequest {
6253
6826
  /**
6827
+ * @public
6254
6828
  * <p>The authentication flow for this call to run. The API action will depend on this
6255
6829
  * value. For example:</p>
6256
6830
  * <ul>
@@ -6301,6 +6875,7 @@ export interface InitiateAuthRequest {
6301
6875
  */
6302
6876
  AuthFlow: AuthFlowType | string | undefined;
6303
6877
  /**
6878
+ * @public
6304
6879
  * <p>The authentication parameters. These are inputs corresponding to the
6305
6880
  * <code>AuthFlow</code> that you're invoking. The required values depend on the value
6306
6881
  * of <code>AuthFlow</code>:</p>
@@ -6326,6 +6901,7 @@ export interface InitiateAuthRequest {
6326
6901
  */
6327
6902
  AuthParameters?: Record<string, string>;
6328
6903
  /**
6904
+ * @public
6329
6905
  * <p>A map of custom key-value pairs that you can provide as input for certain custom
6330
6906
  * workflows that this action triggers.</p>
6331
6907
  * <p>You create custom workflows by assigning Lambda functions to user pool triggers.
@@ -6395,15 +6971,18 @@ export interface InitiateAuthRequest {
6395
6971
  */
6396
6972
  ClientMetadata?: Record<string, string>;
6397
6973
  /**
6974
+ * @public
6398
6975
  * <p>The app client ID.</p>
6399
6976
  */
6400
6977
  ClientId: string | undefined;
6401
6978
  /**
6979
+ * @public
6402
6980
  * <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for
6403
6981
  * <code>InitiateAuth</code> calls.</p>
6404
6982
  */
6405
6983
  AnalyticsMetadata?: AnalyticsMetadataType;
6406
6984
  /**
6985
+ * @public
6407
6986
  * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
6408
6987
  * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
6409
6988
  * when it makes API requests.</p>
@@ -6416,6 +6995,7 @@ export interface InitiateAuthRequest {
6416
6995
  */
6417
6996
  export interface InitiateAuthResponse {
6418
6997
  /**
6998
+ * @public
6419
6999
  * <p>The name of the challenge that you're responding to with this call. This name is
6420
7000
  * returned in the <code>AdminInitiateAuth</code> response if you must pass another
6421
7001
  * challenge.</p>
@@ -6487,6 +7067,7 @@ export interface InitiateAuthResponse {
6487
7067
  */
6488
7068
  ChallengeName?: ChallengeNameType | string;
6489
7069
  /**
7070
+ * @public
6490
7071
  * <p>The session that should pass both ways in challenge-response calls to the service. If
6491
7072
  * the caller must pass another challenge, they return a session with other challenge
6492
7073
  * parameters. This session should be passed as it is to the next
@@ -6494,6 +7075,7 @@ export interface InitiateAuthResponse {
6494
7075
  */
6495
7076
  Session?: string;
6496
7077
  /**
7078
+ * @public
6497
7079
  * <p>The challenge parameters. These are returned in the <code>InitiateAuth</code> response
6498
7080
  * if you must pass another challenge. The responses in this parameter should be used to
6499
7081
  * compute inputs to the next call (<code>RespondToAuthChallenge</code>). </p>
@@ -6502,6 +7084,7 @@ export interface InitiateAuthResponse {
6502
7084
  */
6503
7085
  ChallengeParameters?: Record<string, string>;
6504
7086
  /**
7087
+ * @public
6505
7088
  * <p>The result of the authentication response. This result is only returned if the caller
6506
7089
  * doesn't need to pass another challenge. If the caller does need to pass another
6507
7090
  * challenge before it gets tokens, <code>ChallengeName</code>,
@@ -6515,15 +7098,18 @@ export interface InitiateAuthResponse {
6515
7098
  */
6516
7099
  export interface ListDevicesRequest {
6517
7100
  /**
7101
+ * @public
6518
7102
  * <p>A valid access token that Amazon Cognito issued to the user whose list of devices you want to
6519
7103
  * view.</p>
6520
7104
  */
6521
7105
  AccessToken: string | undefined;
6522
7106
  /**
7107
+ * @public
6523
7108
  * <p>The limit of the device request.</p>
6524
7109
  */
6525
7110
  Limit?: number;
6526
7111
  /**
7112
+ * @public
6527
7113
  * <p>The pagination token for the list request.</p>
6528
7114
  */
6529
7115
  PaginationToken?: string;
@@ -6534,10 +7120,12 @@ export interface ListDevicesRequest {
6534
7120
  */
6535
7121
  export interface ListDevicesResponse {
6536
7122
  /**
7123
+ * @public
6537
7124
  * <p>The devices returned in the list devices response.</p>
6538
7125
  */
6539
7126
  Devices?: DeviceType[];
6540
7127
  /**
7128
+ * @public
6541
7129
  * <p>The pagination token for the list device response.</p>
6542
7130
  */
6543
7131
  PaginationToken?: string;
@@ -6547,14 +7135,17 @@ export interface ListDevicesResponse {
6547
7135
  */
6548
7136
  export interface ListGroupsRequest {
6549
7137
  /**
7138
+ * @public
6550
7139
  * <p>The user pool ID for the user pool.</p>
6551
7140
  */
6552
7141
  UserPoolId: string | undefined;
6553
7142
  /**
7143
+ * @public
6554
7144
  * <p>The limit of the request to list groups.</p>
6555
7145
  */
6556
7146
  Limit?: number;
6557
7147
  /**
7148
+ * @public
6558
7149
  * <p>An identifier that was returned from the previous call to this operation, which can be
6559
7150
  * used to return the next set of items in the list.</p>
6560
7151
  */
@@ -6565,10 +7156,12 @@ export interface ListGroupsRequest {
6565
7156
  */
6566
7157
  export interface ListGroupsResponse {
6567
7158
  /**
7159
+ * @public
6568
7160
  * <p>The group objects for the groups.</p>
6569
7161
  */
6570
7162
  Groups?: GroupType[];
6571
7163
  /**
7164
+ * @public
6572
7165
  * <p>An identifier that was returned from the previous call to this operation, which can be
6573
7166
  * used to return the next set of items in the list.</p>
6574
7167
  */
@@ -6579,14 +7172,17 @@ export interface ListGroupsResponse {
6579
7172
  */
6580
7173
  export interface ListIdentityProvidersRequest {
6581
7174
  /**
7175
+ * @public
6582
7176
  * <p>The user pool ID.</p>
6583
7177
  */
6584
7178
  UserPoolId: string | undefined;
6585
7179
  /**
7180
+ * @public
6586
7181
  * <p>The maximum number of IdPs to return.</p>
6587
7182
  */
6588
7183
  MaxResults?: number;
6589
7184
  /**
7185
+ * @public
6590
7186
  * <p>A pagination token.</p>
6591
7187
  */
6592
7188
  NextToken?: string;
@@ -6597,18 +7193,22 @@ export interface ListIdentityProvidersRequest {
6597
7193
  */
6598
7194
  export interface ProviderDescription {
6599
7195
  /**
7196
+ * @public
6600
7197
  * <p>The IdP name.</p>
6601
7198
  */
6602
7199
  ProviderName?: string;
6603
7200
  /**
7201
+ * @public
6604
7202
  * <p>The IdP type.</p>
6605
7203
  */
6606
7204
  ProviderType?: IdentityProviderTypeType | string;
6607
7205
  /**
7206
+ * @public
6608
7207
  * <p>The date the provider was last modified.</p>
6609
7208
  */
6610
7209
  LastModifiedDate?: Date;
6611
7210
  /**
7211
+ * @public
6612
7212
  * <p>The date the provider was added to the user pool.</p>
6613
7213
  */
6614
7214
  CreationDate?: Date;
@@ -6618,10 +7218,12 @@ export interface ProviderDescription {
6618
7218
  */
6619
7219
  export interface ListIdentityProvidersResponse {
6620
7220
  /**
7221
+ * @public
6621
7222
  * <p>A list of IdP objects.</p>
6622
7223
  */
6623
7224
  Providers: ProviderDescription[] | undefined;
6624
7225
  /**
7226
+ * @public
6625
7227
  * <p>A pagination token.</p>
6626
7228
  */
6627
7229
  NextToken?: string;
@@ -6631,14 +7233,17 @@ export interface ListIdentityProvidersResponse {
6631
7233
  */
6632
7234
  export interface ListResourceServersRequest {
6633
7235
  /**
7236
+ * @public
6634
7237
  * <p>The user pool ID for the user pool.</p>
6635
7238
  */
6636
7239
  UserPoolId: string | undefined;
6637
7240
  /**
7241
+ * @public
6638
7242
  * <p>The maximum number of resource servers to return.</p>
6639
7243
  */
6640
7244
  MaxResults?: number;
6641
7245
  /**
7246
+ * @public
6642
7247
  * <p>A pagination token.</p>
6643
7248
  */
6644
7249
  NextToken?: string;
@@ -6648,10 +7253,12 @@ export interface ListResourceServersRequest {
6648
7253
  */
6649
7254
  export interface ListResourceServersResponse {
6650
7255
  /**
7256
+ * @public
6651
7257
  * <p>The resource servers.</p>
6652
7258
  */
6653
7259
  ResourceServers: ResourceServerType[] | undefined;
6654
7260
  /**
7261
+ * @public
6655
7262
  * <p>A pagination token.</p>
6656
7263
  */
6657
7264
  NextToken?: string;
@@ -6661,6 +7268,7 @@ export interface ListResourceServersResponse {
6661
7268
  */
6662
7269
  export interface ListTagsForResourceRequest {
6663
7270
  /**
7271
+ * @public
6664
7272
  * <p>The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.</p>
6665
7273
  */
6666
7274
  ResourceArn: string | undefined;
@@ -6670,6 +7278,7 @@ export interface ListTagsForResourceRequest {
6670
7278
  */
6671
7279
  export interface ListTagsForResourceResponse {
6672
7280
  /**
7281
+ * @public
6673
7282
  * <p>The tags that are assigned to the user pool.</p>
6674
7283
  */
6675
7284
  Tags?: Record<string, string>;
@@ -6680,14 +7289,17 @@ export interface ListTagsForResourceResponse {
6680
7289
  */
6681
7290
  export interface ListUserImportJobsRequest {
6682
7291
  /**
7292
+ * @public
6683
7293
  * <p>The user pool ID for the user pool that the users are being imported into.</p>
6684
7294
  */
6685
7295
  UserPoolId: string | undefined;
6686
7296
  /**
7297
+ * @public
6687
7298
  * <p>The maximum number of import jobs you want the request to return.</p>
6688
7299
  */
6689
7300
  MaxResults: number | undefined;
6690
7301
  /**
7302
+ * @public
6691
7303
  * <p>An identifier that was returned from the previous call to
6692
7304
  * <code>ListUserImportJobs</code>, which can be used to return the next set of import
6693
7305
  * jobs in the list.</p>
@@ -6701,10 +7313,12 @@ export interface ListUserImportJobsRequest {
6701
7313
  */
6702
7314
  export interface ListUserImportJobsResponse {
6703
7315
  /**
7316
+ * @public
6704
7317
  * <p>The user import jobs.</p>
6705
7318
  */
6706
7319
  UserImportJobs?: UserImportJobType[];
6707
7320
  /**
7321
+ * @public
6708
7322
  * <p>An identifier that can be used to return the next set of user import jobs in the
6709
7323
  * list.</p>
6710
7324
  */
@@ -6716,15 +7330,18 @@ export interface ListUserImportJobsResponse {
6716
7330
  */
6717
7331
  export interface ListUserPoolClientsRequest {
6718
7332
  /**
7333
+ * @public
6719
7334
  * <p>The user pool ID for the user pool where you want to list user pool clients.</p>
6720
7335
  */
6721
7336
  UserPoolId: string | undefined;
6722
7337
  /**
7338
+ * @public
6723
7339
  * <p>The maximum number of results you want the request to return when listing the user
6724
7340
  * pool clients.</p>
6725
7341
  */
6726
7342
  MaxResults?: number;
6727
7343
  /**
7344
+ * @public
6728
7345
  * <p>An identifier that was returned from the previous call to this operation, which can be
6729
7346
  * used to return the next set of items in the list.</p>
6730
7347
  */
@@ -6736,15 +7353,18 @@ export interface ListUserPoolClientsRequest {
6736
7353
  */
6737
7354
  export interface UserPoolClientDescription {
6738
7355
  /**
7356
+ * @public
6739
7357
  * <p>The ID of the client associated with the user pool.</p>
6740
7358
  */
6741
7359
  ClientId?: string;
6742
7360
  /**
7361
+ * @public
6743
7362
  * <p>The user pool ID for the user pool where you want to describe the user pool
6744
7363
  * client.</p>
6745
7364
  */
6746
7365
  UserPoolId?: string;
6747
7366
  /**
7367
+ * @public
6748
7368
  * <p>The client name from the user pool client description.</p>
6749
7369
  */
6750
7370
  ClientName?: string;
@@ -6755,10 +7375,12 @@ export interface UserPoolClientDescription {
6755
7375
  */
6756
7376
  export interface ListUserPoolClientsResponse {
6757
7377
  /**
7378
+ * @public
6758
7379
  * <p>The user pool clients in the response that lists user pool clients.</p>
6759
7380
  */
6760
7381
  UserPoolClients?: UserPoolClientDescription[];
6761
7382
  /**
7383
+ * @public
6762
7384
  * <p>An identifier that was returned from the previous call to this operation, which can be
6763
7385
  * used to return the next set of items in the list.</p>
6764
7386
  */
@@ -6770,11 +7392,13 @@ export interface ListUserPoolClientsResponse {
6770
7392
  */
6771
7393
  export interface ListUserPoolsRequest {
6772
7394
  /**
7395
+ * @public
6773
7396
  * <p>An identifier that was returned from the previous call to this operation, which can be
6774
7397
  * used to return the next set of items in the list.</p>
6775
7398
  */
6776
7399
  NextToken?: string;
6777
7400
  /**
7401
+ * @public
6778
7402
  * <p>The maximum number of results you want the request to return when listing the user
6779
7403
  * pools.</p>
6780
7404
  */
@@ -6786,26 +7410,32 @@ export interface ListUserPoolsRequest {
6786
7410
  */
6787
7411
  export interface UserPoolDescriptionType {
6788
7412
  /**
7413
+ * @public
6789
7414
  * <p>The ID in a user pool description.</p>
6790
7415
  */
6791
7416
  Id?: string;
6792
7417
  /**
7418
+ * @public
6793
7419
  * <p>The name in a user pool description.</p>
6794
7420
  */
6795
7421
  Name?: string;
6796
7422
  /**
7423
+ * @public
6797
7424
  * <p>The Lambda configuration information in a user pool description.</p>
6798
7425
  */
6799
7426
  LambdaConfig?: LambdaConfigType;
6800
7427
  /**
7428
+ * @public
6801
7429
  * <p>The user pool status in a user pool description.</p>
6802
7430
  */
6803
7431
  Status?: StatusType | string;
6804
7432
  /**
7433
+ * @public
6805
7434
  * <p>The date the user pool description was last modified.</p>
6806
7435
  */
6807
7436
  LastModifiedDate?: Date;
6808
7437
  /**
7438
+ * @public
6809
7439
  * <p>The date the user pool description was created.</p>
6810
7440
  */
6811
7441
  CreationDate?: Date;
@@ -6816,10 +7446,12 @@ export interface UserPoolDescriptionType {
6816
7446
  */
6817
7447
  export interface ListUserPoolsResponse {
6818
7448
  /**
7449
+ * @public
6819
7450
  * <p>The user pools from the response to list users.</p>
6820
7451
  */
6821
7452
  UserPools?: UserPoolDescriptionType[];
6822
7453
  /**
7454
+ * @public
6823
7455
  * <p>An identifier that was returned from the previous call to this operation, which can be
6824
7456
  * used to return the next set of items in the list.</p>
6825
7457
  */
@@ -6831,25 +7463,30 @@ export interface ListUserPoolsResponse {
6831
7463
  */
6832
7464
  export interface ListUsersRequest {
6833
7465
  /**
7466
+ * @public
6834
7467
  * <p>The user pool ID for the user pool on which the search should be performed.</p>
6835
7468
  */
6836
7469
  UserPoolId: string | undefined;
6837
7470
  /**
7471
+ * @public
6838
7472
  * <p>An array of strings, where each string is the name of a user attribute to be returned
6839
7473
  * for each user in the search results. If the array is null, all attributes are
6840
7474
  * returned.</p>
6841
7475
  */
6842
7476
  AttributesToGet?: string[];
6843
7477
  /**
7478
+ * @public
6844
7479
  * <p>Maximum number of users to be returned.</p>
6845
7480
  */
6846
7481
  Limit?: number;
6847
7482
  /**
7483
+ * @public
6848
7484
  * <p>An identifier that was returned from the previous call to this operation, which can be
6849
7485
  * used to return the next set of items in the list.</p>
6850
7486
  */
6851
7487
  PaginationToken?: string;
6852
7488
  /**
7489
+ * @public
6853
7490
  * <p>A filter string of the form "<i>AttributeName</i>
6854
7491
  * <i>Filter-Type</i> "<i>AttributeValue</i>"". Quotation marks
6855
7492
  * within the filter string must be escaped using the backslash (\) character. For example,
@@ -6949,10 +7586,12 @@ export interface ListUsersRequest {
6949
7586
  */
6950
7587
  export interface ListUsersResponse {
6951
7588
  /**
7589
+ * @public
6952
7590
  * <p>The users returned in the request to list users.</p>
6953
7591
  */
6954
7592
  Users?: UserType[];
6955
7593
  /**
7594
+ * @public
6956
7595
  * <p>An identifier that was returned from the previous call to this operation, which can be
6957
7596
  * used to return the next set of items in the list.</p>
6958
7597
  */
@@ -6963,18 +7602,22 @@ export interface ListUsersResponse {
6963
7602
  */
6964
7603
  export interface ListUsersInGroupRequest {
6965
7604
  /**
7605
+ * @public
6966
7606
  * <p>The user pool ID for the user pool.</p>
6967
7607
  */
6968
7608
  UserPoolId: string | undefined;
6969
7609
  /**
7610
+ * @public
6970
7611
  * <p>The name of the group.</p>
6971
7612
  */
6972
7613
  GroupName: string | undefined;
6973
7614
  /**
7615
+ * @public
6974
7616
  * <p>The limit of the request to list users.</p>
6975
7617
  */
6976
7618
  Limit?: number;
6977
7619
  /**
7620
+ * @public
6978
7621
  * <p>An identifier that was returned from the previous call to this operation, which can be
6979
7622
  * used to return the next set of items in the list.</p>
6980
7623
  */
@@ -6985,10 +7628,12 @@ export interface ListUsersInGroupRequest {
6985
7628
  */
6986
7629
  export interface ListUsersInGroupResponse {
6987
7630
  /**
7631
+ * @public
6988
7632
  * <p>The users returned in the request to list users.</p>
6989
7633
  */
6990
7634
  Users?: UserType[];
6991
7635
  /**
7636
+ * @public
6992
7637
  * <p>An identifier that you can use in a later request to return the next set of items in
6993
7638
  * the list.</p>
6994
7639
  */
@@ -7000,31 +7645,37 @@ export interface ListUsersInGroupResponse {
7000
7645
  */
7001
7646
  export interface ResendConfirmationCodeRequest {
7002
7647
  /**
7648
+ * @public
7003
7649
  * <p>The ID of the client associated with the user pool.</p>
7004
7650
  */
7005
7651
  ClientId: string | undefined;
7006
7652
  /**
7653
+ * @public
7007
7654
  * <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a
7008
7655
  * user pool client and username plus the client ID in the message.</p>
7009
7656
  */
7010
7657
  SecretHash?: string;
7011
7658
  /**
7659
+ * @public
7012
7660
  * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
7013
7661
  * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
7014
7662
  * when it makes API requests.</p>
7015
7663
  */
7016
7664
  UserContextData?: UserContextDataType;
7017
7665
  /**
7666
+ * @public
7018
7667
  * <p>The <code>username</code> attribute of the user to whom you want to resend a
7019
7668
  * confirmation code.</p>
7020
7669
  */
7021
7670
  Username: string | undefined;
7022
7671
  /**
7672
+ * @public
7023
7673
  * <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for
7024
7674
  * <code>ResendConfirmationCode</code> calls.</p>
7025
7675
  */
7026
7676
  AnalyticsMetadata?: AnalyticsMetadataType;
7027
7677
  /**
7678
+ * @public
7028
7679
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
7029
7680
  * that this action triggers.</p>
7030
7681
  * <p>You create custom workflows by assigning Lambda functions to user pool triggers.
@@ -7066,6 +7717,7 @@ export interface ResendConfirmationCodeRequest {
7066
7717
  */
7067
7718
  export interface ResendConfirmationCodeResponse {
7068
7719
  /**
7720
+ * @public
7069
7721
  * <p>The code delivery details returned by the server in response to the request to resend
7070
7722
  * the confirmation code.</p>
7071
7723
  */
@@ -7077,16 +7729,19 @@ export interface ResendConfirmationCodeResponse {
7077
7729
  */
7078
7730
  export interface RespondToAuthChallengeRequest {
7079
7731
  /**
7732
+ * @public
7080
7733
  * <p>The app client ID.</p>
7081
7734
  */
7082
7735
  ClientId: string | undefined;
7083
7736
  /**
7737
+ * @public
7084
7738
  * <p>The challenge name. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a>.</p>
7085
7739
  * <p>
7086
7740
  * <code>ADMIN_NO_SRP_AUTH</code> isn't a valid value.</p>
7087
7741
  */
7088
7742
  ChallengeName: ChallengeNameType | string | undefined;
7089
7743
  /**
7744
+ * @public
7090
7745
  * <p>The session that should be passed both ways in challenge-response calls to the
7091
7746
  * service. If <code>InitiateAuth</code> or <code>RespondToAuthChallenge</code> API call
7092
7747
  * determines that the caller must pass another challenge, they return a session with other
@@ -7095,6 +7750,7 @@ export interface RespondToAuthChallengeRequest {
7095
7750
  */
7096
7751
  Session?: string;
7097
7752
  /**
7753
+ * @public
7098
7754
  * <p>The challenge responses. These are inputs corresponding to the value of
7099
7755
  * <code>ChallengeName</code>, for example:</p>
7100
7756
  * <note>
@@ -7161,17 +7817,20 @@ export interface RespondToAuthChallengeRequest {
7161
7817
  */
7162
7818
  ChallengeResponses?: Record<string, string>;
7163
7819
  /**
7820
+ * @public
7164
7821
  * <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for
7165
7822
  * <code>RespondToAuthChallenge</code> calls.</p>
7166
7823
  */
7167
7824
  AnalyticsMetadata?: AnalyticsMetadataType;
7168
7825
  /**
7826
+ * @public
7169
7827
  * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
7170
7828
  * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
7171
7829
  * when it makes API requests.</p>
7172
7830
  */
7173
7831
  UserContextData?: UserContextDataType;
7174
7832
  /**
7833
+ * @public
7175
7834
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
7176
7835
  * that this action triggers.</p>
7177
7836
  * <p>You create custom workflows by assigning Lambda functions to user pool
@@ -7216,10 +7875,12 @@ export interface RespondToAuthChallengeRequest {
7216
7875
  */
7217
7876
  export interface RespondToAuthChallengeResponse {
7218
7877
  /**
7878
+ * @public
7219
7879
  * <p>The challenge name. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a>.</p>
7220
7880
  */
7221
7881
  ChallengeName?: ChallengeNameType | string;
7222
7882
  /**
7883
+ * @public
7223
7884
  * <p>The session that should be passed both ways in challenge-response calls to the
7224
7885
  * service. If the caller must pass another challenge, they return a session with other
7225
7886
  * challenge parameters. This session should be passed as it is to the next
@@ -7227,10 +7888,12 @@ export interface RespondToAuthChallengeResponse {
7227
7888
  */
7228
7889
  Session?: string;
7229
7890
  /**
7891
+ * @public
7230
7892
  * <p>The challenge parameters. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a>.</p>
7231
7893
  */
7232
7894
  ChallengeParameters?: Record<string, string>;
7233
7895
  /**
7896
+ * @public
7234
7897
  * <p>The result returned by the server in response to the request to respond to the
7235
7898
  * authentication challenge.</p>
7236
7899
  */
@@ -7241,14 +7904,17 @@ export interface RespondToAuthChallengeResponse {
7241
7904
  */
7242
7905
  export interface RevokeTokenRequest {
7243
7906
  /**
7907
+ * @public
7244
7908
  * <p>The refresh token that you want to revoke.</p>
7245
7909
  */
7246
7910
  Token: string | undefined;
7247
7911
  /**
7912
+ * @public
7248
7913
  * <p>The client ID for the token that you want to revoke.</p>
7249
7914
  */
7250
7915
  ClientId: string | undefined;
7251
7916
  /**
7917
+ * @public
7252
7918
  * <p>The secret for the client ID. This is required only if the client ID has a
7253
7919
  * secret.</p>
7254
7920
  */
@@ -7302,10 +7968,12 @@ export declare class UnsupportedTokenTypeException extends __BaseException {
7302
7968
  */
7303
7969
  export interface SetRiskConfigurationRequest {
7304
7970
  /**
7971
+ * @public
7305
7972
  * <p>The user pool ID. </p>
7306
7973
  */
7307
7974
  UserPoolId: string | undefined;
7308
7975
  /**
7976
+ * @public
7309
7977
  * <p>The app client ID. If <code>ClientId</code> is null, then the risk configuration is
7310
7978
  * mapped to <code>userPoolId</code>. When the client ID is null, the same risk
7311
7979
  * configuration is applied to all the clients in the userPool.</p>
@@ -7315,14 +7983,17 @@ export interface SetRiskConfigurationRequest {
7315
7983
  */
7316
7984
  ClientId?: string;
7317
7985
  /**
7986
+ * @public
7318
7987
  * <p>The compromised credentials risk configuration.</p>
7319
7988
  */
7320
7989
  CompromisedCredentialsRiskConfiguration?: CompromisedCredentialsRiskConfigurationType;
7321
7990
  /**
7991
+ * @public
7322
7992
  * <p>The account takeover risk configuration.</p>
7323
7993
  */
7324
7994
  AccountTakeoverRiskConfiguration?: AccountTakeoverRiskConfigurationType;
7325
7995
  /**
7996
+ * @public
7326
7997
  * <p>The configuration to override the risk decision.</p>
7327
7998
  */
7328
7999
  RiskExceptionConfiguration?: RiskExceptionConfigurationType;
@@ -7332,6 +8003,7 @@ export interface SetRiskConfigurationRequest {
7332
8003
  */
7333
8004
  export interface SetRiskConfigurationResponse {
7334
8005
  /**
8006
+ * @public
7335
8007
  * <p>The risk configuration.</p>
7336
8008
  */
7337
8009
  RiskConfiguration: RiskConfigurationType | undefined;
@@ -7341,18 +8013,22 @@ export interface SetRiskConfigurationResponse {
7341
8013
  */
7342
8014
  export interface SetUICustomizationRequest {
7343
8015
  /**
8016
+ * @public
7344
8017
  * <p>The user pool ID for the user pool.</p>
7345
8018
  */
7346
8019
  UserPoolId: string | undefined;
7347
8020
  /**
8021
+ * @public
7348
8022
  * <p>The client ID for the client app.</p>
7349
8023
  */
7350
8024
  ClientId?: string;
7351
8025
  /**
8026
+ * @public
7352
8027
  * <p>The CSS values in the UI customization.</p>
7353
8028
  */
7354
8029
  CSS?: string;
7355
8030
  /**
8031
+ * @public
7356
8032
  * <p>The uploaded logo image for the UI customization.</p>
7357
8033
  */
7358
8034
  ImageFile?: Uint8Array;
@@ -7362,6 +8038,7 @@ export interface SetUICustomizationRequest {
7362
8038
  */
7363
8039
  export interface SetUICustomizationResponse {
7364
8040
  /**
8041
+ * @public
7365
8042
  * <p>The UI customization information.</p>
7366
8043
  */
7367
8044
  UICustomization: UICustomizationType | undefined;
@@ -7371,14 +8048,17 @@ export interface SetUICustomizationResponse {
7371
8048
  */
7372
8049
  export interface SetUserMFAPreferenceRequest {
7373
8050
  /**
8051
+ * @public
7374
8052
  * <p>The SMS text message multi-factor authentication (MFA) settings.</p>
7375
8053
  */
7376
8054
  SMSMfaSettings?: SMSMfaSettingsType;
7377
8055
  /**
8056
+ * @public
7378
8057
  * <p>The time-based one-time password (TOTP) software token MFA settings.</p>
7379
8058
  */
7380
8059
  SoftwareTokenMfaSettings?: SoftwareTokenMfaSettingsType;
7381
8060
  /**
8061
+ * @public
7382
8062
  * <p>A valid access token that Amazon Cognito issued to the user whose MFA preference you want to
7383
8063
  * set.</p>
7384
8064
  */
@@ -7394,18 +8074,22 @@ export interface SetUserMFAPreferenceResponse {
7394
8074
  */
7395
8075
  export interface SetUserPoolMfaConfigRequest {
7396
8076
  /**
8077
+ * @public
7397
8078
  * <p>The user pool ID.</p>
7398
8079
  */
7399
8080
  UserPoolId: string | undefined;
7400
8081
  /**
8082
+ * @public
7401
8083
  * <p>The SMS text message MFA configuration.</p>
7402
8084
  */
7403
8085
  SmsMfaConfiguration?: SmsMfaConfigType;
7404
8086
  /**
8087
+ * @public
7405
8088
  * <p>The software token MFA configuration.</p>
7406
8089
  */
7407
8090
  SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType;
7408
8091
  /**
8092
+ * @public
7409
8093
  * <p>The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who
7410
8094
  * have set up an MFA factor can sign in. To learn more, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html">Adding Multi-Factor
7411
8095
  * Authentication (MFA) to a user pool</a>. Valid values include:</p>
@@ -7432,14 +8116,17 @@ export interface SetUserPoolMfaConfigRequest {
7432
8116
  */
7433
8117
  export interface SetUserPoolMfaConfigResponse {
7434
8118
  /**
8119
+ * @public
7435
8120
  * <p>The SMS text message MFA configuration.</p>
7436
8121
  */
7437
8122
  SmsMfaConfiguration?: SmsMfaConfigType;
7438
8123
  /**
8124
+ * @public
7439
8125
  * <p>The software token MFA configuration.</p>
7440
8126
  */
7441
8127
  SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType;
7442
8128
  /**
8129
+ * @public
7443
8130
  * <p>The MFA configuration. Valid values include:</p>
7444
8131
  * <ul>
7445
8132
  * <li>
@@ -7465,11 +8152,13 @@ export interface SetUserPoolMfaConfigResponse {
7465
8152
  */
7466
8153
  export interface SetUserSettingsRequest {
7467
8154
  /**
8155
+ * @public
7468
8156
  * <p>A valid access token that Amazon Cognito issued to the user whose user settings you want to
7469
8157
  * configure.</p>
7470
8158
  */
7471
8159
  AccessToken: string | undefined;
7472
8160
  /**
8161
+ * @public
7473
8162
  * <p>You can use this parameter only to set an SMS configuration that uses SMS for
7474
8163
  * delivery.</p>
7475
8164
  */