@aws-sdk/client-cognito-identity-provider 3.687.0 → 3.692.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.
@@ -39,7 +39,7 @@ export interface AccountRecoverySettingType {
39
39
  * <p>The list of <code>RecoveryOptionTypes</code>.</p>
40
40
  * @public
41
41
  */
42
- RecoveryMechanisms?: RecoveryOptionType[];
42
+ RecoveryMechanisms?: RecoveryOptionType[] | undefined;
43
43
  }
44
44
  /**
45
45
  * @public
@@ -101,17 +101,17 @@ export interface AccountTakeoverActionsType {
101
101
  * <p>Action to take for a low risk.</p>
102
102
  * @public
103
103
  */
104
- LowAction?: AccountTakeoverActionType;
104
+ LowAction?: AccountTakeoverActionType | undefined;
105
105
  /**
106
106
  * <p>Action to take for a medium risk.</p>
107
107
  * @public
108
108
  */
109
- MediumAction?: AccountTakeoverActionType;
109
+ MediumAction?: AccountTakeoverActionType | undefined;
110
110
  /**
111
111
  * <p>Action to take for a high risk.</p>
112
112
  * @public
113
113
  */
114
- HighAction?: AccountTakeoverActionType;
114
+ HighAction?: AccountTakeoverActionType | undefined;
115
115
  }
116
116
  /**
117
117
  * <p>The notify email type.</p>
@@ -127,12 +127,12 @@ export interface NotifyEmailType {
127
127
  * <p>The email HTML body.</p>
128
128
  * @public
129
129
  */
130
- HtmlBody?: string;
130
+ HtmlBody?: string | undefined;
131
131
  /**
132
132
  * <p>The email text body.</p>
133
133
  * @public
134
134
  */
135
- TextBody?: string;
135
+ TextBody?: string | undefined;
136
136
  }
137
137
  /**
138
138
  * <p>The notify configuration type.</p>
@@ -144,12 +144,12 @@ export interface NotifyConfigurationType {
144
144
  * verified with Amazon Simple Email Service, or from a domain that has been verified with Amazon SES.</p>
145
145
  * @public
146
146
  */
147
- From?: string;
147
+ From?: string | undefined;
148
148
  /**
149
149
  * <p>The destination to which the receiver of an email should reply to.</p>
150
150
  * @public
151
151
  */
152
- ReplyTo?: string;
152
+ ReplyTo?: string | undefined;
153
153
  /**
154
154
  * <p>The Amazon Resource Name (ARN) of the identity that is associated with the sending
155
155
  * authorization policy. This identity permits Amazon Cognito to send for the email address
@@ -161,18 +161,18 @@ export interface NotifyConfigurationType {
161
161
  * <p>Email template used when a detected risk event is blocked.</p>
162
162
  * @public
163
163
  */
164
- BlockEmail?: NotifyEmailType;
164
+ BlockEmail?: NotifyEmailType | undefined;
165
165
  /**
166
166
  * <p>The email template used when a detected risk event is allowed.</p>
167
167
  * @public
168
168
  */
169
- NoActionEmail?: NotifyEmailType;
169
+ NoActionEmail?: NotifyEmailType | undefined;
170
170
  /**
171
171
  * <p>The multi-factor authentication (MFA) email template used when MFA is challenged as
172
172
  * part of a detected risk.</p>
173
173
  * @public
174
174
  */
175
- MfaEmail?: NotifyEmailType;
175
+ MfaEmail?: NotifyEmailType | undefined;
176
176
  }
177
177
  /**
178
178
  * <p>Configuration for mitigation actions and notification for different levels of risk
@@ -184,7 +184,7 @@ export interface AccountTakeoverRiskConfigurationType {
184
184
  * <p>The notify configuration used to construct email notifications.</p>
185
185
  * @public
186
186
  */
187
- NotifyConfiguration?: NotifyConfigurationType;
187
+ NotifyConfiguration?: NotifyConfigurationType | undefined;
188
188
  /**
189
189
  * <p>Account takeover risk configuration actions.</p>
190
190
  * @public
@@ -214,14 +214,14 @@ export interface NumberAttributeConstraintsType {
214
214
  * <p>The minimum value of an attribute that is of the number data type.</p>
215
215
  * @public
216
216
  */
217
- MinValue?: string;
217
+ MinValue?: string | undefined;
218
218
  /**
219
219
  * <p>The maximum length of a number attribute value. Must be a number less than or equal to
220
220
  * <code>2^1023</code>, represented as a string with a length of 131072 characters or
221
221
  * fewer.</p>
222
222
  * @public
223
223
  */
224
- MaxValue?: string;
224
+ MaxValue?: string | undefined;
225
225
  }
226
226
  /**
227
227
  * <p>The constraints associated with a string attribute.</p>
@@ -232,14 +232,14 @@ export interface StringAttributeConstraintsType {
232
232
  * <p>The minimum length.</p>
233
233
  * @public
234
234
  */
235
- MinLength?: string;
235
+ MinLength?: string | undefined;
236
236
  /**
237
237
  * <p>The maximum length of a string attribute value. Must be a number less than or equal to
238
238
  * <code>2^1023</code>, represented as a string with a length of 131072 characters or
239
239
  * fewer.</p>
240
240
  * @public
241
241
  */
242
- MaxLength?: string;
242
+ MaxLength?: string | undefined;
243
243
  }
244
244
  /**
245
245
  * <p>A list of the user attributes and their properties in your user pool. The attribute
@@ -264,7 +264,7 @@ export interface SchemaAttributeType {
264
264
  * <code>dev:value</code> for developer-only attributes..</p>
265
265
  * @public
266
266
  */
267
- Name?: string;
267
+ Name?: string | undefined;
268
268
  /**
269
269
  * <p>The data format of the values for your attribute. When you choose an
270
270
  * <code>AttributeDataType</code>, Amazon Cognito validates the input against the data type. A
@@ -273,7 +273,7 @@ export interface SchemaAttributeType {
273
273
  * "12"</code>. </p>
274
274
  * @public
275
275
  */
276
- AttributeDataType?: AttributeDataType;
276
+ AttributeDataType?: AttributeDataType | undefined;
277
277
  /**
278
278
  * <note>
279
279
  * <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
@@ -286,7 +286,7 @@ export interface SchemaAttributeType {
286
286
  * AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.</p>
287
287
  * @public
288
288
  */
289
- DeveloperOnlyAttribute?: boolean;
289
+ DeveloperOnlyAttribute?: boolean | undefined;
290
290
  /**
291
291
  * <p>Specifies whether the value of the attribute can be changed.</p>
292
292
  * <p>Any user pool attribute whose value you map from an IdP attribute must be mutable,
@@ -296,23 +296,23 @@ export interface SchemaAttributeType {
296
296
  * Pool</a>.</p>
297
297
  * @public
298
298
  */
299
- Mutable?: boolean;
299
+ Mutable?: boolean | undefined;
300
300
  /**
301
301
  * <p>Specifies whether a user pool attribute is required. If the attribute is required and
302
302
  * the user doesn't provide a value, registration or sign-in will fail.</p>
303
303
  * @public
304
304
  */
305
- Required?: boolean;
305
+ Required?: boolean | undefined;
306
306
  /**
307
307
  * <p>Specifies the constraints for an attribute of the number type.</p>
308
308
  * @public
309
309
  */
310
- NumberAttributeConstraints?: NumberAttributeConstraintsType;
310
+ NumberAttributeConstraints?: NumberAttributeConstraintsType | undefined;
311
311
  /**
312
312
  * <p>Specifies the constraints for an attribute of the string type.</p>
313
313
  * @public
314
314
  */
315
- StringAttributeConstraints?: StringAttributeConstraintsType;
315
+ StringAttributeConstraints?: StringAttributeConstraintsType | undefined;
316
316
  }
317
317
  /**
318
318
  * <p>Represents the request to add custom attributes.</p>
@@ -502,7 +502,7 @@ export interface AdminConfirmSignUpRequest {
502
502
  * </note>
503
503
  * @public
504
504
  */
505
- ClientMetadata?: Record<string, string>;
505
+ ClientMetadata?: Record<string, string> | undefined;
506
506
  }
507
507
  /**
508
508
  * <p>Represents the response from the server for the request to confirm
@@ -613,7 +613,7 @@ export interface AttributeType {
613
613
  * <p>The value of the attribute.</p>
614
614
  * @public
615
615
  */
616
- Value?: string;
616
+ Value?: string | undefined;
617
617
  }
618
618
  /**
619
619
  * <p>Represents the request to create a user in the specified user pool.</p>
@@ -683,7 +683,7 @@ export interface AdminCreateUserRequest {
683
683
  * </ul>
684
684
  * @public
685
685
  */
686
- UserAttributes?: AttributeType[];
686
+ UserAttributes?: AttributeType[] | undefined;
687
687
  /**
688
688
  * <p>Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda
689
689
  * trigger. This set of key-value pairs are for custom validation of information that you
@@ -696,7 +696,7 @@ export interface AdminCreateUserRequest {
696
696
  * <p>For more information about the pre sign-up Lambda trigger, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html">Pre sign-up Lambda trigger</a>.</p>
697
697
  * @public
698
698
  */
699
- ValidationData?: AttributeType[];
699
+ ValidationData?: AttributeType[] | undefined;
700
700
  /**
701
701
  * <p>The user's temporary password. This password must conform to the password policy that
702
702
  * you specified when you created the user pool.</p>
@@ -711,7 +711,7 @@ export interface AdminCreateUserRequest {
711
711
  * <code>MessageAction</code> parameter.</p>
712
712
  * @public
713
713
  */
714
- TemporaryPassword?: string;
714
+ TemporaryPassword?: string | undefined;
715
715
  /**
716
716
  * <p>This parameter is used only if the <code>phone_number_verified</code> or
717
717
  * <code>email_verified</code> attribute is set to <code>True</code>. Otherwise, it is
@@ -725,7 +725,7 @@ export interface AdminCreateUserRequest {
725
725
  * value is <code>False</code>.</p>
726
726
  * @public
727
727
  */
728
- ForceAliasCreation?: boolean;
728
+ ForceAliasCreation?: boolean | undefined;
729
729
  /**
730
730
  * <p>Set to <code>RESEND</code> to resend the invitation message to a user that already
731
731
  * exists and reset the expiration limit on the user's account. Set to
@@ -733,14 +733,14 @@ export interface AdminCreateUserRequest {
733
733
  * value.</p>
734
734
  * @public
735
735
  */
736
- MessageAction?: MessageActionType;
736
+ MessageAction?: MessageActionType | undefined;
737
737
  /**
738
738
  * <p>Specify <code>"EMAIL"</code> if email will be used to send the welcome message.
739
739
  * Specify <code>"SMS"</code> if the phone number will be used. The default value is
740
740
  * <code>"SMS"</code>. You can specify more than one value.</p>
741
741
  * @public
742
742
  */
743
- DesiredDeliveryMediums?: DeliveryMediumType[];
743
+ DesiredDeliveryMediums?: DeliveryMediumType[] | undefined;
744
744
  /**
745
745
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
746
746
  * that this action triggers.</p>
@@ -775,7 +775,7 @@ export interface AdminCreateUserRequest {
775
775
  * </note>
776
776
  * @public
777
777
  */
778
- ClientMetadata?: Record<string, string>;
778
+ ClientMetadata?: Record<string, string> | undefined;
779
779
  }
780
780
  /**
781
781
  * <p>
@@ -790,13 +790,13 @@ export interface MFAOptionType {
790
790
  * <code>SMS</code> delivery medium value.</p>
791
791
  * @public
792
792
  */
793
- DeliveryMedium?: DeliveryMediumType;
793
+ DeliveryMedium?: DeliveryMediumType | undefined;
794
794
  /**
795
795
  * <p>The attribute name of the MFA option type. The only valid value is
796
796
  * <code>phone_number</code>.</p>
797
797
  * @public
798
798
  */
799
- AttributeName?: string;
799
+ AttributeName?: string | undefined;
800
800
  }
801
801
  /**
802
802
  * @public
@@ -825,28 +825,28 @@ export interface UserType {
825
825
  * <p>The user name of the user you want to describe.</p>
826
826
  * @public
827
827
  */
828
- Username?: string;
828
+ Username?: string | undefined;
829
829
  /**
830
830
  * <p>A container with information about the user type attributes.</p>
831
831
  * @public
832
832
  */
833
- Attributes?: AttributeType[];
833
+ Attributes?: AttributeType[] | undefined;
834
834
  /**
835
835
  * <p>The creation date of the user.</p>
836
836
  * @public
837
837
  */
838
- UserCreateDate?: Date;
838
+ UserCreateDate?: Date | undefined;
839
839
  /**
840
840
  * <p>The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
841
841
  * human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
842
842
  * @public
843
843
  */
844
- UserLastModifiedDate?: Date;
844
+ UserLastModifiedDate?: Date | undefined;
845
845
  /**
846
846
  * <p>Specifies whether the user is enabled.</p>
847
847
  * @public
848
848
  */
849
- Enabled?: boolean;
849
+ Enabled?: boolean | undefined;
850
850
  /**
851
851
  * <p>The user status. This can be one of the following:</p>
852
852
  * <ul>
@@ -874,12 +874,12 @@ export interface UserType {
874
874
  * </ul>
875
875
  * @public
876
876
  */
877
- UserStatus?: UserStatusType;
877
+ UserStatus?: UserStatusType | undefined;
878
878
  /**
879
879
  * <p>The MFA options for the user.</p>
880
880
  * @public
881
881
  */
882
- MFAOptions?: MFAOptionType[];
882
+ MFAOptions?: MFAOptionType[] | undefined;
883
883
  }
884
884
  /**
885
885
  * <p>Represents the response from the server to the request to create the user.</p>
@@ -890,7 +890,7 @@ export interface AdminCreateUserResponse {
890
890
  * <p>The newly created user.</p>
891
891
  * @public
892
892
  */
893
- User?: UserType;
893
+ User?: UserType | undefined;
894
894
  }
895
895
  /**
896
896
  * <p>This exception is thrown when a verification code fails to deliver
@@ -991,17 +991,17 @@ export interface MessageTemplateType {
991
991
  * <p>The message template for SMS messages.</p>
992
992
  * @public
993
993
  */
994
- SMSMessage?: string;
994
+ SMSMessage?: string | undefined;
995
995
  /**
996
996
  * <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>
997
997
  * @public
998
998
  */
999
- EmailMessage?: string;
999
+ EmailMessage?: string | undefined;
1000
1000
  /**
1001
1001
  * <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>
1002
1002
  * @public
1003
1003
  */
1004
- EmailSubject?: string;
1004
+ EmailSubject?: string | undefined;
1005
1005
  }
1006
1006
  /**
1007
1007
  * <p>The configuration for creating a new user profile.</p>
@@ -1013,7 +1013,7 @@ export interface AdminCreateUserConfigType {
1013
1013
  * Set to <code>False</code> if users can sign themselves up via an app.</p>
1014
1014
  * @public
1015
1015
  */
1016
- AllowAdminCreateUserOnly?: boolean;
1016
+ AllowAdminCreateUserOnly?: boolean | undefined;
1017
1017
  /**
1018
1018
  * <p>The user account expiration limit, in days, after which a new account that hasn't
1019
1019
  * signed in is no longer usable. To reset the account after that time limit, you must call
@@ -1028,13 +1028,13 @@ export interface AdminCreateUserConfigType {
1028
1028
  * </note>
1029
1029
  * @public
1030
1030
  */
1031
- UnusedAccountValidityDays?: number;
1031
+ UnusedAccountValidityDays?: number | undefined;
1032
1032
  /**
1033
1033
  * <p>The message template to be used for the welcome message to new users.</p>
1034
1034
  * <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>
1035
1035
  * @public
1036
1036
  */
1037
- InviteMessageTemplate?: MessageTemplateType;
1037
+ InviteMessageTemplate?: MessageTemplateType | undefined;
1038
1038
  }
1039
1039
  /**
1040
1040
  * <p>Represents the request to delete a user as an administrator.</p>
@@ -1099,18 +1099,18 @@ export interface ProviderUserIdentifierType {
1099
1099
  * <p>The name of the provider, such as Facebook, Google, or Login with Amazon.</p>
1100
1100
  * @public
1101
1101
  */
1102
- ProviderName?: string;
1102
+ ProviderName?: string | undefined;
1103
1103
  /**
1104
1104
  * <p>The name of the provider attribute to link to, such as <code>NameID</code>.</p>
1105
1105
  * @public
1106
1106
  */
1107
- ProviderAttributeName?: string;
1107
+ ProviderAttributeName?: string | undefined;
1108
1108
  /**
1109
1109
  * <p>The value of the provider attribute to link to, such as
1110
1110
  * <code>xxxxx_account</code>.</p>
1111
1111
  * @public
1112
1112
  */
1113
- ProviderAttributeValue?: string;
1113
+ ProviderAttributeValue?: string | undefined;
1114
1114
  }
1115
1115
  /**
1116
1116
  * @public
@@ -1273,28 +1273,28 @@ export interface DeviceType {
1273
1273
  * <p>The device key.</p>
1274
1274
  * @public
1275
1275
  */
1276
- DeviceKey?: string;
1276
+ DeviceKey?: string | undefined;
1277
1277
  /**
1278
1278
  * <p>The device attributes.</p>
1279
1279
  * @public
1280
1280
  */
1281
- DeviceAttributes?: AttributeType[];
1281
+ DeviceAttributes?: AttributeType[] | undefined;
1282
1282
  /**
1283
1283
  * <p>The creation date of the device.</p>
1284
1284
  * @public
1285
1285
  */
1286
- DeviceCreateDate?: Date;
1286
+ DeviceCreateDate?: Date | undefined;
1287
1287
  /**
1288
1288
  * <p>The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
1289
1289
  * human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
1290
1290
  * @public
1291
1291
  */
1292
- DeviceLastModifiedDate?: Date;
1292
+ DeviceLastModifiedDate?: Date | undefined;
1293
1293
  /**
1294
1294
  * <p>The date when the device was last authenticated.</p>
1295
1295
  * @public
1296
1296
  */
1297
- DeviceLastAuthenticatedDate?: Date;
1297
+ DeviceLastAuthenticatedDate?: Date | undefined;
1298
1298
  }
1299
1299
  /**
1300
1300
  * <p>Gets the device response, as an administrator.</p>
@@ -1343,23 +1343,23 @@ export interface AdminGetUserResponse {
1343
1343
  * <p>An array of name-value pairs representing user attributes.</p>
1344
1344
  * @public
1345
1345
  */
1346
- UserAttributes?: AttributeType[];
1346
+ UserAttributes?: AttributeType[] | undefined;
1347
1347
  /**
1348
1348
  * <p>The date the user was created.</p>
1349
1349
  * @public
1350
1350
  */
1351
- UserCreateDate?: Date;
1351
+ UserCreateDate?: Date | undefined;
1352
1352
  /**
1353
1353
  * <p>The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
1354
1354
  * human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
1355
1355
  * @public
1356
1356
  */
1357
- UserLastModifiedDate?: Date;
1357
+ UserLastModifiedDate?: Date | undefined;
1358
1358
  /**
1359
1359
  * <p>Indicates that the status is <code>enabled</code>.</p>
1360
1360
  * @public
1361
1361
  */
1362
- Enabled?: boolean;
1362
+ Enabled?: boolean | undefined;
1363
1363
  /**
1364
1364
  * <p>The user status. Can be one of the following:</p>
1365
1365
  * <ul>
@@ -1384,7 +1384,7 @@ export interface AdminGetUserResponse {
1384
1384
  * </ul>
1385
1385
  * @public
1386
1386
  */
1387
- UserStatus?: UserStatusType;
1387
+ UserStatus?: UserStatusType | undefined;
1388
1388
  /**
1389
1389
  * <p>
1390
1390
  * <i>This response parameter is no longer supported.</i> It provides
@@ -1394,18 +1394,18 @@ export interface AdminGetUserResponse {
1394
1394
  * instead.</p>
1395
1395
  * @public
1396
1396
  */
1397
- MFAOptions?: MFAOptionType[];
1397
+ MFAOptions?: MFAOptionType[] | undefined;
1398
1398
  /**
1399
1399
  * <p>The user's preferred MFA setting.</p>
1400
1400
  * @public
1401
1401
  */
1402
- PreferredMfaSetting?: string;
1402
+ PreferredMfaSetting?: string | undefined;
1403
1403
  /**
1404
1404
  * <p>The MFA options that are activated for the user. The possible values in this list are
1405
1405
  * <code>SMS_MFA</code>, <code>EMAIL_OTP</code>, and <code>SOFTWARE_TOKEN_MFA</code>.</p>
1406
1406
  * @public
1407
1407
  */
1408
- UserMFASettingList?: string[];
1408
+ UserMFASettingList?: string[] | undefined;
1409
1409
  }
1410
1410
  /**
1411
1411
  * <p>An Amazon Pinpoint analytics endpoint.</p>
@@ -1419,7 +1419,7 @@ export interface AnalyticsMetadataType {
1419
1419
  * <p>The endpoint ID.</p>
1420
1420
  * @public
1421
1421
  */
1422
- AnalyticsEndpointId?: string;
1422
+ AnalyticsEndpointId?: string | undefined;
1423
1423
  }
1424
1424
  /**
1425
1425
  * @public
@@ -1447,12 +1447,12 @@ export interface HttpHeader {
1447
1447
  * <p>The header name.</p>
1448
1448
  * @public
1449
1449
  */
1450
- headerName?: string;
1450
+ headerName?: string | undefined;
1451
1451
  /**
1452
1452
  * <p>The header value.</p>
1453
1453
  * @public
1454
1454
  */
1455
- headerValue?: string;
1455
+ headerValue?: string | undefined;
1456
1456
  }
1457
1457
  /**
1458
1458
  * <p>Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito
@@ -1485,7 +1485,7 @@ export interface ContextDataType {
1485
1485
  * 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>
1486
1486
  * @public
1487
1487
  */
1488
- EncodedData?: string;
1488
+ EncodedData?: string | undefined;
1489
1489
  }
1490
1490
  /**
1491
1491
  * <p>Initiates the authorization request, as an administrator.</p>
@@ -1589,7 +1589,7 @@ export interface AdminInitiateAuthRequest {
1589
1589
  * <code>DEVICE_KEY</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>
1590
1590
  * @public
1591
1591
  */
1592
- AuthParameters?: Record<string, string>;
1592
+ AuthParameters?: Record<string, string> | undefined;
1593
1593
  /**
1594
1594
  * <p>A map of custom key-value pairs that you can provide as input for certain custom
1595
1595
  * workflows that this action triggers.</p>
@@ -1656,20 +1656,20 @@ export interface AdminInitiateAuthRequest {
1656
1656
  * </note>
1657
1657
  * @public
1658
1658
  */
1659
- ClientMetadata?: Record<string, string>;
1659
+ ClientMetadata?: Record<string, string> | undefined;
1660
1660
  /**
1661
1661
  * <p>The analytics metadata for collecting Amazon Pinpoint metrics for
1662
1662
  * <code>AdminInitiateAuth</code> calls.</p>
1663
1663
  * @public
1664
1664
  */
1665
- AnalyticsMetadata?: AnalyticsMetadataType;
1665
+ AnalyticsMetadata?: AnalyticsMetadataType | undefined;
1666
1666
  /**
1667
1667
  * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
1668
1668
  * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
1669
1669
  * when it makes API requests.</p>
1670
1670
  * @public
1671
1671
  */
1672
- ContextData?: ContextDataType;
1672
+ ContextData?: ContextDataType | undefined;
1673
1673
  }
1674
1674
  /**
1675
1675
  * <p>The new device metadata type.</p>
@@ -1680,12 +1680,12 @@ export interface NewDeviceMetadataType {
1680
1680
  * <p>The device key.</p>
1681
1681
  * @public
1682
1682
  */
1683
- DeviceKey?: string;
1683
+ DeviceKey?: string | undefined;
1684
1684
  /**
1685
1685
  * <p>The device group key.</p>
1686
1686
  * @public
1687
1687
  */
1688
- DeviceGroupKey?: string;
1688
+ DeviceGroupKey?: string | undefined;
1689
1689
  }
1690
1690
  /**
1691
1691
  * <p>The authentication result.</p>
@@ -1697,32 +1697,32 @@ export interface AuthenticationResultType {
1697
1697
  * authenticate.</p>
1698
1698
  * @public
1699
1699
  */
1700
- AccessToken?: string;
1700
+ AccessToken?: string | undefined;
1701
1701
  /**
1702
1702
  * <p>The expiration period of the authentication result in seconds.</p>
1703
1703
  * @public
1704
1704
  */
1705
- ExpiresIn?: number;
1705
+ ExpiresIn?: number | undefined;
1706
1706
  /**
1707
1707
  * <p>The token type.</p>
1708
1708
  * @public
1709
1709
  */
1710
- TokenType?: string;
1710
+ TokenType?: string | undefined;
1711
1711
  /**
1712
1712
  * <p>The refresh token.</p>
1713
1713
  * @public
1714
1714
  */
1715
- RefreshToken?: string;
1715
+ RefreshToken?: string | undefined;
1716
1716
  /**
1717
1717
  * <p>The ID token.</p>
1718
1718
  * @public
1719
1719
  */
1720
- IdToken?: string;
1720
+ IdToken?: string | undefined;
1721
1721
  /**
1722
1722
  * <p>The new device metadata from an authentication result.</p>
1723
1723
  * @public
1724
1724
  */
1725
- NewDeviceMetadata?: NewDeviceMetadataType;
1725
+ NewDeviceMetadata?: NewDeviceMetadataType | undefined;
1726
1726
  }
1727
1727
  /**
1728
1728
  * @public
@@ -1842,7 +1842,7 @@ export interface AdminInitiateAuthResponse {
1842
1842
  * </ul>
1843
1843
  * @public
1844
1844
  */
1845
- ChallengeName?: ChallengeNameType;
1845
+ ChallengeName?: ChallengeNameType | undefined;
1846
1846
  /**
1847
1847
  * <p>The session that should be passed both ways in challenge-response calls to the
1848
1848
  * service. If <code>AdminInitiateAuth</code> or <code>AdminRespondToAuthChallenge</code>
@@ -1851,7 +1851,7 @@ export interface AdminInitiateAuthResponse {
1851
1851
  * <code>AdminRespondToAuthChallenge</code> API call.</p>
1852
1852
  * @public
1853
1853
  */
1854
- Session?: string;
1854
+ Session?: string | undefined;
1855
1855
  /**
1856
1856
  * <p>The challenge parameters. These are returned to you in the
1857
1857
  * <code>AdminInitiateAuth</code> response if you must pass another challenge. The
@@ -1866,7 +1866,7 @@ export interface AdminInitiateAuthResponse {
1866
1866
  * <code>USERNAME</code> attribute can't be an alias.</p>
1867
1867
  * @public
1868
1868
  */
1869
- ChallengeParameters?: Record<string, string>;
1869
+ ChallengeParameters?: Record<string, string> | undefined;
1870
1870
  /**
1871
1871
  * <p>The result of the authentication response. This is only returned if the caller doesn't
1872
1872
  * need to pass another challenge. If the caller does need to pass another challenge before
@@ -1874,7 +1874,7 @@ export interface AdminInitiateAuthResponse {
1874
1874
  * <code>Session</code> are returned.</p>
1875
1875
  * @public
1876
1876
  */
1877
- AuthenticationResult?: AuthenticationResultType;
1877
+ AuthenticationResult?: AuthenticationResultType | undefined;
1878
1878
  }
1879
1879
  /**
1880
1880
  * <p>This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP
@@ -2015,7 +2015,7 @@ export interface AdminListDevicesRequest {
2015
2015
  * <p>The limit of the devices request.</p>
2016
2016
  * @public
2017
2017
  */
2018
- Limit?: number;
2018
+ Limit?: number | undefined;
2019
2019
  /**
2020
2020
  * <p>This API operation returns a limited number of results. The pagination token is
2021
2021
  * an identifier that you can present in an additional API request with the same parameters. When
@@ -2024,7 +2024,7 @@ export interface AdminListDevicesRequest {
2024
2024
  * through the full list of items.</p>
2025
2025
  * @public
2026
2026
  */
2027
- PaginationToken?: string;
2027
+ PaginationToken?: string | undefined;
2028
2028
  }
2029
2029
  /**
2030
2030
  * <p>Lists the device's response, as an administrator.</p>
@@ -2035,14 +2035,14 @@ export interface AdminListDevicesResponse {
2035
2035
  * <p>The devices in the list of devices response.</p>
2036
2036
  * @public
2037
2037
  */
2038
- Devices?: DeviceType[];
2038
+ Devices?: DeviceType[] | undefined;
2039
2039
  /**
2040
2040
  * <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
2041
2041
  * you include a pagination token in your request, Amazon Cognito returns the next set of items in
2042
2042
  * the list. By use of this token, you can paginate through the full list of items.</p>
2043
2043
  * @public
2044
2044
  */
2045
- PaginationToken?: string;
2045
+ PaginationToken?: string | undefined;
2046
2046
  }
2047
2047
  /**
2048
2048
  * @public
@@ -2066,13 +2066,13 @@ export interface AdminListGroupsForUserRequest {
2066
2066
  * <p>The limit of the request to list groups.</p>
2067
2067
  * @public
2068
2068
  */
2069
- Limit?: number;
2069
+ Limit?: number | undefined;
2070
2070
  /**
2071
2071
  * <p>An identifier that was returned from the previous call to this operation, which can be
2072
2072
  * used to return the next set of items in the list.</p>
2073
2073
  * @public
2074
2074
  */
2075
- NextToken?: string;
2075
+ NextToken?: string | undefined;
2076
2076
  }
2077
2077
  /**
2078
2078
  * <p>The group type.</p>
@@ -2083,22 +2083,22 @@ export interface GroupType {
2083
2083
  * <p>The name of the group.</p>
2084
2084
  * @public
2085
2085
  */
2086
- GroupName?: string;
2086
+ GroupName?: string | undefined;
2087
2087
  /**
2088
2088
  * <p>The user pool ID for the user pool.</p>
2089
2089
  * @public
2090
2090
  */
2091
- UserPoolId?: string;
2091
+ UserPoolId?: string | undefined;
2092
2092
  /**
2093
2093
  * <p>A string containing the description of the group.</p>
2094
2094
  * @public
2095
2095
  */
2096
- Description?: string;
2096
+ Description?: string | undefined;
2097
2097
  /**
2098
2098
  * <p>The role Amazon Resource Name (ARN) for the group.</p>
2099
2099
  * @public
2100
2100
  */
2101
- RoleArn?: string;
2101
+ RoleArn?: string | undefined;
2102
2102
  /**
2103
2103
  * <p>A non-negative integer value that specifies the precedence of this group relative to
2104
2104
  * the other groups that a user can belong to in the user pool. Zero is the highest
@@ -2116,19 +2116,19 @@ export interface GroupType {
2116
2116
  * <p>The default <code>Precedence</code> value is null.</p>
2117
2117
  * @public
2118
2118
  */
2119
- Precedence?: number;
2119
+ Precedence?: number | undefined;
2120
2120
  /**
2121
2121
  * <p>The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
2122
2122
  * human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
2123
2123
  * @public
2124
2124
  */
2125
- LastModifiedDate?: Date;
2125
+ LastModifiedDate?: Date | undefined;
2126
2126
  /**
2127
2127
  * <p>The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
2128
2128
  * human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
2129
2129
  * @public
2130
2130
  */
2131
- CreationDate?: Date;
2131
+ CreationDate?: Date | undefined;
2132
2132
  }
2133
2133
  /**
2134
2134
  * @public
@@ -2138,13 +2138,13 @@ export interface AdminListGroupsForUserResponse {
2138
2138
  * <p>The groups that the user belongs to.</p>
2139
2139
  * @public
2140
2140
  */
2141
- Groups?: GroupType[];
2141
+ Groups?: GroupType[] | undefined;
2142
2142
  /**
2143
2143
  * <p>An identifier that was returned from the previous call to this operation, which can be
2144
2144
  * used to return the next set of items in the list.</p>
2145
2145
  * @public
2146
2146
  */
2147
- NextToken?: string;
2147
+ NextToken?: string | undefined;
2148
2148
  }
2149
2149
  /**
2150
2150
  * @public
@@ -2170,12 +2170,12 @@ export interface AdminListUserAuthEventsRequest {
2170
2170
  * parameter.</p>
2171
2171
  * @public
2172
2172
  */
2173
- MaxResults?: number;
2173
+ MaxResults?: number | undefined;
2174
2174
  /**
2175
2175
  * <p>A pagination token.</p>
2176
2176
  * @public
2177
2177
  */
2178
- NextToken?: string;
2178
+ NextToken?: string | undefined;
2179
2179
  }
2180
2180
  /**
2181
2181
  * @public
@@ -2210,12 +2210,12 @@ export interface ChallengeResponseType {
2210
2210
  * <p>The challenge name.</p>
2211
2211
  * @public
2212
2212
  */
2213
- ChallengeName?: ChallengeName;
2213
+ ChallengeName?: ChallengeName | undefined;
2214
2214
  /**
2215
2215
  * <p>The challenge response.</p>
2216
2216
  * @public
2217
2217
  */
2218
- ChallengeResponse?: ChallengeResponse;
2218
+ ChallengeResponse?: ChallengeResponse | undefined;
2219
2219
  }
2220
2220
  /**
2221
2221
  * <p>Specifies the user context data captured at the time of an event request.</p>
@@ -2226,27 +2226,27 @@ export interface EventContextDataType {
2226
2226
  * <p>The source IP address of your user's device.</p>
2227
2227
  * @public
2228
2228
  */
2229
- IpAddress?: string;
2229
+ IpAddress?: string | undefined;
2230
2230
  /**
2231
2231
  * <p>The user's device name.</p>
2232
2232
  * @public
2233
2233
  */
2234
- DeviceName?: string;
2234
+ DeviceName?: string | undefined;
2235
2235
  /**
2236
2236
  * <p>The user's time zone.</p>
2237
2237
  * @public
2238
2238
  */
2239
- Timezone?: string;
2239
+ Timezone?: string | undefined;
2240
2240
  /**
2241
2241
  * <p>The user's city.</p>
2242
2242
  * @public
2243
2243
  */
2244
- City?: string;
2244
+ City?: string | undefined;
2245
2245
  /**
2246
2246
  * <p>The user's country.</p>
2247
2247
  * @public
2248
2248
  */
2249
- Country?: string;
2249
+ Country?: string | undefined;
2250
2250
  }
2251
2251
  /**
2252
2252
  * @public
@@ -2283,7 +2283,7 @@ export interface EventFeedbackType {
2283
2283
  * <p>The event feedback date.</p>
2284
2284
  * @public
2285
2285
  */
2286
- FeedbackDate?: Date;
2286
+ FeedbackDate?: Date | undefined;
2287
2287
  }
2288
2288
  /**
2289
2289
  * @public
@@ -2333,18 +2333,18 @@ export interface EventRiskType {
2333
2333
  * <p>The risk decision.</p>
2334
2334
  * @public
2335
2335
  */
2336
- RiskDecision?: RiskDecisionType;
2336
+ RiskDecision?: RiskDecisionType | undefined;
2337
2337
  /**
2338
2338
  * <p>The risk level.</p>
2339
2339
  * @public
2340
2340
  */
2341
- RiskLevel?: RiskLevelType;
2341
+ RiskLevel?: RiskLevelType | undefined;
2342
2342
  /**
2343
2343
  * <p>Indicates whether compromised credentials were detected during an authentication
2344
2344
  * event.</p>
2345
2345
  * @public
2346
2346
  */
2347
- CompromisedCredentialsDetected?: boolean;
2347
+ CompromisedCredentialsDetected?: boolean | undefined;
2348
2348
  }
2349
2349
  /**
2350
2350
  * @public
@@ -2370,45 +2370,45 @@ export interface AuthEventType {
2370
2370
  * <p>The event ID.</p>
2371
2371
  * @public
2372
2372
  */
2373
- EventId?: string;
2373
+ EventId?: string | undefined;
2374
2374
  /**
2375
2375
  * <p>The event type.</p>
2376
2376
  * @public
2377
2377
  */
2378
- EventType?: EventType;
2378
+ EventType?: EventType | undefined;
2379
2379
  /**
2380
2380
  * <p>The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
2381
2381
  * human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
2382
2382
  * @public
2383
2383
  */
2384
- CreationDate?: Date;
2384
+ CreationDate?: Date | undefined;
2385
2385
  /**
2386
2386
  * <p>The event response.</p>
2387
2387
  * @public
2388
2388
  */
2389
- EventResponse?: EventResponseType;
2389
+ EventResponse?: EventResponseType | undefined;
2390
2390
  /**
2391
2391
  * <p>The event risk.</p>
2392
2392
  * @public
2393
2393
  */
2394
- EventRisk?: EventRiskType;
2394
+ EventRisk?: EventRiskType | undefined;
2395
2395
  /**
2396
2396
  * <p>The challenge responses.</p>
2397
2397
  * @public
2398
2398
  */
2399
- ChallengeResponses?: ChallengeResponseType[];
2399
+ ChallengeResponses?: ChallengeResponseType[] | undefined;
2400
2400
  /**
2401
2401
  * <p>The user context data captured at the time of an event request. This value provides
2402
2402
  * additional information about the client from which event the request is received.</p>
2403
2403
  * @public
2404
2404
  */
2405
- EventContextData?: EventContextDataType;
2405
+ EventContextData?: EventContextDataType | undefined;
2406
2406
  /**
2407
2407
  * <p>A flag specifying the user feedback captured at the time of an event request is good
2408
2408
  * or bad. </p>
2409
2409
  * @public
2410
2410
  */
2411
- EventFeedback?: EventFeedbackType;
2411
+ EventFeedback?: EventFeedbackType | undefined;
2412
2412
  }
2413
2413
  /**
2414
2414
  * @public
@@ -2420,12 +2420,12 @@ export interface AdminListUserAuthEventsResponse {
2420
2420
  * <code>EventResponse</code>.</p>
2421
2421
  * @public
2422
2422
  */
2423
- AuthEvents?: AuthEventType[];
2423
+ AuthEvents?: AuthEventType[] | undefined;
2424
2424
  /**
2425
2425
  * <p>A pagination token.</p>
2426
2426
  * @public
2427
2427
  */
2428
- NextToken?: string;
2428
+ NextToken?: string | undefined;
2429
2429
  }
2430
2430
  /**
2431
2431
  * <p>This exception is thrown when user pool add-ons aren't enabled.</p>
@@ -2516,7 +2516,7 @@ export interface AdminResetUserPasswordRequest {
2516
2516
  * </note>
2517
2517
  * @public
2518
2518
  */
2519
- ClientMetadata?: Record<string, string>;
2519
+ ClientMetadata?: Record<string, string> | undefined;
2520
2520
  }
2521
2521
  /**
2522
2522
  * <p>Represents the response from the server to reset a user password as an
@@ -2655,7 +2655,7 @@ export interface AdminRespondToAuthChallengeRequest {
2655
2655
  * <code>DEVICE_KEY</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>
2656
2656
  * @public
2657
2657
  */
2658
- ChallengeResponses?: Record<string, string>;
2658
+ ChallengeResponses?: Record<string, string> | undefined;
2659
2659
  /**
2660
2660
  * <p>The session that should be passed both ways in challenge-response calls to the
2661
2661
  * service. If an <code>InitiateAuth</code> or <code>RespondToAuthChallenge</code> API call
@@ -2664,20 +2664,20 @@ export interface AdminRespondToAuthChallengeRequest {
2664
2664
  * <code>RespondToAuthChallenge</code> API call.</p>
2665
2665
  * @public
2666
2666
  */
2667
- Session?: string;
2667
+ Session?: string | undefined;
2668
2668
  /**
2669
2669
  * <p>The analytics metadata for collecting Amazon Pinpoint metrics for
2670
2670
  * <code>AdminRespondToAuthChallenge</code> calls.</p>
2671
2671
  * @public
2672
2672
  */
2673
- AnalyticsMetadata?: AnalyticsMetadataType;
2673
+ AnalyticsMetadata?: AnalyticsMetadataType | undefined;
2674
2674
  /**
2675
2675
  * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
2676
2676
  * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
2677
2677
  * when it makes API requests.</p>
2678
2678
  * @public
2679
2679
  */
2680
- ContextData?: ContextDataType;
2680
+ ContextData?: ContextDataType | undefined;
2681
2681
  /**
2682
2682
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
2683
2683
  * that this action triggers.</p>
@@ -2739,7 +2739,7 @@ export interface AdminRespondToAuthChallengeRequest {
2739
2739
  * </note>
2740
2740
  * @public
2741
2741
  */
2742
- ClientMetadata?: Record<string, string>;
2742
+ ClientMetadata?: Record<string, string> | undefined;
2743
2743
  }
2744
2744
  /**
2745
2745
  * <p>Responds to the authentication challenge, as an administrator.</p>
@@ -2750,7 +2750,7 @@ export interface AdminRespondToAuthChallengeResponse {
2750
2750
  * <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>
2751
2751
  * @public
2752
2752
  */
2753
- ChallengeName?: ChallengeNameType;
2753
+ ChallengeName?: ChallengeNameType | undefined;
2754
2754
  /**
2755
2755
  * <p>The session that should be passed both ways in challenge-response calls to the
2756
2756
  * service. If the caller must pass another challenge, they return a session with other
@@ -2758,17 +2758,17 @@ export interface AdminRespondToAuthChallengeResponse {
2758
2758
  * <code>RespondToAuthChallenge</code> API call.</p>
2759
2759
  * @public
2760
2760
  */
2761
- Session?: string;
2761
+ Session?: string | undefined;
2762
2762
  /**
2763
2763
  * <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>
2764
2764
  * @public
2765
2765
  */
2766
- ChallengeParameters?: Record<string, string>;
2766
+ ChallengeParameters?: Record<string, string> | undefined;
2767
2767
  /**
2768
2768
  * <p>The result returned by the server in response to the authentication request.</p>
2769
2769
  * @public
2770
2770
  */
2771
- AuthenticationResult?: AuthenticationResultType;
2771
+ AuthenticationResult?: AuthenticationResultType | undefined;
2772
2772
  }
2773
2773
  /**
2774
2774
  * <p>This exception is thrown if the provided code doesn't match what the server was
@@ -2835,12 +2835,12 @@ export interface EmailMfaSettingsType {
2835
2835
  * attempts, unless device tracking is turned on and the device has been trusted.</p>
2836
2836
  * @public
2837
2837
  */
2838
- Enabled?: boolean;
2838
+ Enabled?: boolean | undefined;
2839
2839
  /**
2840
2840
  * <p>Specifies whether email message MFA is the user's preferred method.</p>
2841
2841
  * @public
2842
2842
  */
2843
- PreferredMfa?: boolean;
2843
+ PreferredMfa?: boolean | undefined;
2844
2844
  }
2845
2845
  /**
2846
2846
  * <p>The type used for enabling SMS multi-factor authentication (MFA) at the user level.
@@ -2858,12 +2858,12 @@ export interface SMSMfaSettingsType {
2858
2858
  * tracking is turned on and the device has been trusted.</p>
2859
2859
  * @public
2860
2860
  */
2861
- Enabled?: boolean;
2861
+ Enabled?: boolean | undefined;
2862
2862
  /**
2863
2863
  * <p>Specifies whether SMS is the preferred MFA method.</p>
2864
2864
  * @public
2865
2865
  */
2866
- PreferredMfa?: boolean;
2866
+ PreferredMfa?: boolean | undefined;
2867
2867
  }
2868
2868
  /**
2869
2869
  * <p>The type used for enabling software token MFA at the user level. If an MFA type is
@@ -2880,12 +2880,12 @@ export interface SoftwareTokenMfaSettingsType {
2880
2880
  * tracking is turned on and the device has been trusted.</p>
2881
2881
  * @public
2882
2882
  */
2883
- Enabled?: boolean;
2883
+ Enabled?: boolean | undefined;
2884
2884
  /**
2885
2885
  * <p>Specifies whether software token MFA is the preferred MFA method.</p>
2886
2886
  * @public
2887
2887
  */
2888
- PreferredMfa?: boolean;
2888
+ PreferredMfa?: boolean | undefined;
2889
2889
  }
2890
2890
  /**
2891
2891
  * @public
@@ -2896,21 +2896,21 @@ export interface AdminSetUserMFAPreferenceRequest {
2896
2896
  * the preferred MFA method when multiple methods are available.</p>
2897
2897
  * @public
2898
2898
  */
2899
- SMSMfaSettings?: SMSMfaSettingsType;
2899
+ SMSMfaSettings?: SMSMfaSettingsType | undefined;
2900
2900
  /**
2901
2901
  * <p>User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates
2902
2902
  * TOTP MFA and sets it as the preferred MFA method when multiple methods are
2903
2903
  * available.</p>
2904
2904
  * @public
2905
2905
  */
2906
- SoftwareTokenMfaSettings?: SoftwareTokenMfaSettingsType;
2906
+ SoftwareTokenMfaSettings?: SoftwareTokenMfaSettingsType | undefined;
2907
2907
  /**
2908
2908
  * <p>User preferences for email message MFA. Activates or deactivates email MFA and sets it
2909
2909
  * as the preferred MFA method when multiple methods are available. To activate this setting, <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">
2910
2910
  * advanced security features</a> must be active in your user pool.</p>
2911
2911
  * @public
2912
2912
  */
2913
- EmailMfaSettings?: EmailMfaSettingsType;
2913
+ EmailMfaSettings?: EmailMfaSettingsType | undefined;
2914
2914
  /**
2915
2915
  * <p>The username of the user that you want to query or modify. The value of this parameter
2916
2916
  * is typically your user's username, but it can be any of their alias attributes. If
@@ -2960,7 +2960,7 @@ export interface AdminSetUserPasswordRequest {
2960
2960
  * temporary.</p>
2961
2961
  * @public
2962
2962
  */
2963
- Permanent?: boolean;
2963
+ Permanent?: boolean | undefined;
2964
2964
  }
2965
2965
  /**
2966
2966
  * @public
@@ -3079,7 +3079,7 @@ export interface AdminUpdateDeviceStatusRequest {
3079
3079
  * <p>The status indicating whether a device has been remembered or not.</p>
3080
3080
  * @public
3081
3081
  */
3082
- DeviceRememberedStatus?: DeviceRememberedStatusType;
3082
+ DeviceRememberedStatus?: DeviceRememberedStatusType | undefined;
3083
3083
  }
3084
3084
  /**
3085
3085
  * <p>The status response to the request to update the device, as an administrator.</p>
@@ -3159,7 +3159,7 @@ export interface AdminUpdateUserAttributesRequest {
3159
3159
  * </note>
3160
3160
  * @public
3161
3161
  */
3162
- ClientMetadata?: Record<string, string>;
3162
+ ClientMetadata?: Record<string, string> | undefined;
3163
3163
  }
3164
3164
  /**
3165
3165
  * <p>Represents the response from the server for the request to update user attributes as
@@ -3220,7 +3220,7 @@ export interface AdvancedSecurityAdditionalFlowsType {
3220
3220
  * </p>
3221
3221
  * @public
3222
3222
  */
3223
- CustomAuthMode?: AdvancedSecurityEnabledModeType;
3223
+ CustomAuthMode?: AdvancedSecurityEnabledModeType | undefined;
3224
3224
  }
3225
3225
  /**
3226
3226
  * @public
@@ -3263,31 +3263,31 @@ export interface AnalyticsConfigurationType {
3263
3263
  * <p>The application ID for an Amazon Pinpoint application.</p>
3264
3264
  * @public
3265
3265
  */
3266
- ApplicationId?: string;
3266
+ ApplicationId?: string | undefined;
3267
3267
  /**
3268
3268
  * <p>The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project
3269
3269
  * to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint
3270
3270
  * project that the app ARN declares.</p>
3271
3271
  * @public
3272
3272
  */
3273
- ApplicationArn?: string;
3273
+ ApplicationArn?: string | undefined;
3274
3274
  /**
3275
3275
  * <p>The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint
3276
3276
  * analytics.</p>
3277
3277
  * @public
3278
3278
  */
3279
- RoleArn?: string;
3279
+ RoleArn?: string | undefined;
3280
3280
  /**
3281
3281
  * <p>The external ID.</p>
3282
3282
  * @public
3283
3283
  */
3284
- ExternalId?: string;
3284
+ ExternalId?: string | undefined;
3285
3285
  /**
3286
3286
  * <p>If <code>UserDataShared</code> is <code>true</code>, Amazon Cognito includes user data in the
3287
3287
  * events that it publishes to Amazon Pinpoint analytics.</p>
3288
3288
  * @public
3289
3289
  */
3290
- UserDataShared?: boolean;
3290
+ UserDataShared?: boolean | undefined;
3291
3291
  }
3292
3292
  /**
3293
3293
  * @public
@@ -3298,13 +3298,13 @@ export interface AssociateSoftwareTokenRequest {
3298
3298
  * generate.</p>
3299
3299
  * @public
3300
3300
  */
3301
- AccessToken?: string;
3301
+ AccessToken?: string | undefined;
3302
3302
  /**
3303
3303
  * <p>The session that should be passed both ways in challenge-response calls to the
3304
3304
  * service. This allows authentication of the user as part of the MFA setup process.</p>
3305
3305
  * @public
3306
3306
  */
3307
- Session?: string;
3307
+ Session?: string | undefined;
3308
3308
  }
3309
3309
  /**
3310
3310
  * @public
@@ -3315,13 +3315,13 @@ export interface AssociateSoftwareTokenResponse {
3315
3315
  * one-time code.</p>
3316
3316
  * @public
3317
3317
  */
3318
- SecretCode?: string;
3318
+ SecretCode?: string | undefined;
3319
3319
  /**
3320
3320
  * <p>The session that should be passed both ways in challenge-response calls to the
3321
3321
  * service. This allows authentication of the user as part of the MFA setup process.</p>
3322
3322
  * @public
3323
3323
  */
3324
- Session?: string;
3324
+ Session?: string | undefined;
3325
3325
  }
3326
3326
  /**
3327
3327
  * <p>This exception is thrown if two or more modifications are happening
@@ -3398,13 +3398,13 @@ export interface DeviceSecretVerifierConfigType {
3398
3398
  * <p>The password verifier.</p>
3399
3399
  * @public
3400
3400
  */
3401
- PasswordVerifier?: string;
3401
+ PasswordVerifier?: string | undefined;
3402
3402
  /**
3403
3403
  * <p>The <a href="https://en.wikipedia.org/wiki/Salt_(cryptography)">salt</a>
3404
3404
  * </p>
3405
3405
  * @public
3406
3406
  */
3407
- Salt?: string;
3407
+ Salt?: string | undefined;
3408
3408
  }
3409
3409
  /**
3410
3410
  * <p>Confirms the device request.</p>
@@ -3426,12 +3426,12 @@ export interface ConfirmDeviceRequest {
3426
3426
  * <p>The configuration of the device secret verifier.</p>
3427
3427
  * @public
3428
3428
  */
3429
- DeviceSecretVerifierConfig?: DeviceSecretVerifierConfigType;
3429
+ DeviceSecretVerifierConfig?: DeviceSecretVerifierConfigType | undefined;
3430
3430
  /**
3431
3431
  * <p>The device name.</p>
3432
3432
  * @public
3433
3433
  */
3434
- DeviceName?: string;
3434
+ DeviceName?: string | undefined;
3435
3435
  }
3436
3436
  /**
3437
3437
  * <p>Confirms the device response.</p>
@@ -3442,7 +3442,7 @@ export interface ConfirmDeviceResponse {
3442
3442
  * <p>Indicates whether the user confirmation must confirm the device response.</p>
3443
3443
  * @public
3444
3444
  */
3445
- UserConfirmationNecessary?: boolean;
3445
+ UserConfirmationNecessary?: boolean | undefined;
3446
3446
  }
3447
3447
  /**
3448
3448
  * <p>Contextual data, such as the user's device fingerprint, IP address, or location, used
@@ -3454,13 +3454,13 @@ export interface UserContextDataType {
3454
3454
  * <p>The source IP address of your user's device.</p>
3455
3455
  * @public
3456
3456
  */
3457
- IpAddress?: string;
3457
+ IpAddress?: string | undefined;
3458
3458
  /**
3459
3459
  * <p>Encoded device-fingerprint details that your app collected with the Amazon Cognito
3460
3460
  * 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>
3461
3461
  * @public
3462
3462
  */
3463
- EncodedData?: string;
3463
+ EncodedData?: string | undefined;
3464
3464
  }
3465
3465
  /**
3466
3466
  * <p>The request representing the confirmation for a password reset.</p>
@@ -3478,7 +3478,7 @@ export interface ConfirmForgotPasswordRequest {
3478
3478
  * about <code>SecretHash</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash">Computing secret hash values</a>.</p>
3479
3479
  * @public
3480
3480
  */
3481
- SecretHash?: string;
3481
+ SecretHash?: string | undefined;
3482
3482
  /**
3483
3483
  * <p>The username of the user that you want to query or modify. The value of this parameter
3484
3484
  * is typically your user's username, but it can be any of their alias attributes. If
@@ -3504,14 +3504,14 @@ export interface ConfirmForgotPasswordRequest {
3504
3504
  * <code>ConfirmForgotPassword</code> calls.</p>
3505
3505
  * @public
3506
3506
  */
3507
- AnalyticsMetadata?: AnalyticsMetadataType;
3507
+ AnalyticsMetadata?: AnalyticsMetadataType | undefined;
3508
3508
  /**
3509
3509
  * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
3510
3510
  * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
3511
3511
  * when it makes API requests.</p>
3512
3512
  * @public
3513
3513
  */
3514
- UserContextData?: UserContextDataType;
3514
+ UserContextData?: UserContextDataType | undefined;
3515
3515
  /**
3516
3516
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
3517
3517
  * that this action triggers.</p>
@@ -3546,7 +3546,7 @@ export interface ConfirmForgotPasswordRequest {
3546
3546
  * </note>
3547
3547
  * @public
3548
3548
  */
3549
- ClientMetadata?: Record<string, string>;
3549
+ ClientMetadata?: Record<string, string> | undefined;
3550
3550
  }
3551
3551
  /**
3552
3552
  * <p>The response from the server that results from a user's request to retrieve a
@@ -3570,7 +3570,7 @@ export interface ConfirmSignUpRequest {
3570
3570
  * user pool client and username plus the client ID in the message.</p>
3571
3571
  * @public
3572
3572
  */
3573
- SecretHash?: string;
3573
+ SecretHash?: string | undefined;
3574
3574
  /**
3575
3575
  * <p>The username of the user that you want to query or modify. The value of this parameter
3576
3576
  * is typically your user's username, but it can be any of their alias attributes. If
@@ -3594,20 +3594,20 @@ export interface ConfirmSignUpRequest {
3594
3594
  * <b>AliasExistsException</b> error.</p>
3595
3595
  * @public
3596
3596
  */
3597
- ForceAliasCreation?: boolean;
3597
+ ForceAliasCreation?: boolean | undefined;
3598
3598
  /**
3599
3599
  * <p>The Amazon Pinpoint analytics metadata for collecting metrics for <code>ConfirmSignUp</code>
3600
3600
  * calls.</p>
3601
3601
  * @public
3602
3602
  */
3603
- AnalyticsMetadata?: AnalyticsMetadataType;
3603
+ AnalyticsMetadata?: AnalyticsMetadataType | undefined;
3604
3604
  /**
3605
3605
  * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
3606
3606
  * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
3607
3607
  * when it makes API requests.</p>
3608
3608
  * @public
3609
3609
  */
3610
- UserContextData?: UserContextDataType;
3610
+ UserContextData?: UserContextDataType | undefined;
3611
3611
  /**
3612
3612
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
3613
3613
  * that this action triggers.</p>
@@ -3642,7 +3642,7 @@ export interface ConfirmSignUpRequest {
3642
3642
  * </note>
3643
3643
  * @public
3644
3644
  */
3645
- ClientMetadata?: Record<string, string>;
3645
+ ClientMetadata?: Record<string, string> | undefined;
3646
3646
  }
3647
3647
  /**
3648
3648
  * <p>Represents the response from the server for the registration confirmation.</p>
@@ -3668,12 +3668,12 @@ export interface CreateGroupRequest {
3668
3668
  * <p>A string containing the description of the group.</p>
3669
3669
  * @public
3670
3670
  */
3671
- Description?: string;
3671
+ Description?: string | undefined;
3672
3672
  /**
3673
3673
  * <p>The role Amazon Resource Name (ARN) for the group.</p>
3674
3674
  * @public
3675
3675
  */
3676
- RoleArn?: string;
3676
+ RoleArn?: string | undefined;
3677
3677
  /**
3678
3678
  * <p>A non-negative integer value that specifies the precedence of this group relative to
3679
3679
  * the other groups that a user can belong to in the user pool. Zero is the highest
@@ -3692,7 +3692,7 @@ export interface CreateGroupRequest {
3692
3692
  * value is <code>2^31-1</code>.</p>
3693
3693
  * @public
3694
3694
  */
3695
- Precedence?: number;
3695
+ Precedence?: number | undefined;
3696
3696
  }
3697
3697
  /**
3698
3698
  * @public
@@ -3702,7 +3702,7 @@ export interface CreateGroupResponse {
3702
3702
  * <p>The group object for the group.</p>
3703
3703
  * @public
3704
3704
  */
3705
- Group?: GroupType;
3705
+ Group?: GroupType | undefined;
3706
3706
  }
3707
3707
  /**
3708
3708
  * <p>This exception is thrown when Amazon Cognito encounters a group that already exists in the user
@@ -3879,12 +3879,12 @@ export interface CreateIdentityProviderRequest {
3879
3879
  * <p>A mapping of IdP attributes to standard and custom user pool attributes.</p>
3880
3880
  * @public
3881
3881
  */
3882
- AttributeMapping?: Record<string, string>;
3882
+ AttributeMapping?: Record<string, string> | undefined;
3883
3883
  /**
3884
3884
  * <p>A list of IdP identifiers.</p>
3885
3885
  * @public
3886
3886
  */
3887
- IdpIdentifiers?: string[];
3887
+ IdpIdentifiers?: string[] | undefined;
3888
3888
  }
3889
3889
  /**
3890
3890
  * <p>A container for information about an IdP.</p>
@@ -3895,17 +3895,17 @@ export interface IdentityProviderType {
3895
3895
  * <p>The user pool ID.</p>
3896
3896
  * @public
3897
3897
  */
3898
- UserPoolId?: string;
3898
+ UserPoolId?: string | undefined;
3899
3899
  /**
3900
3900
  * <p>The IdP name.</p>
3901
3901
  * @public
3902
3902
  */
3903
- ProviderName?: string;
3903
+ ProviderName?: string | undefined;
3904
3904
  /**
3905
3905
  * <p>The IdP type.</p>
3906
3906
  * @public
3907
3907
  */
3908
- ProviderType?: IdentityProviderTypeType;
3908
+ ProviderType?: IdentityProviderTypeType | undefined;
3909
3909
  /**
3910
3910
  * <p>The scopes, URLs, and identifiers for your external identity provider. The following
3911
3911
  * examples describe the provider detail keys for each IdP type. These values and their
@@ -4028,29 +4028,29 @@ export interface IdentityProviderType {
4028
4028
  * </dl>
4029
4029
  * @public
4030
4030
  */
4031
- ProviderDetails?: Record<string, string>;
4031
+ ProviderDetails?: Record<string, string> | undefined;
4032
4032
  /**
4033
4033
  * <p>A mapping of IdP attributes to standard and custom user pool attributes.</p>
4034
4034
  * @public
4035
4035
  */
4036
- AttributeMapping?: Record<string, string>;
4036
+ AttributeMapping?: Record<string, string> | undefined;
4037
4037
  /**
4038
4038
  * <p>A list of IdP identifiers.</p>
4039
4039
  * @public
4040
4040
  */
4041
- IdpIdentifiers?: string[];
4041
+ IdpIdentifiers?: string[] | undefined;
4042
4042
  /**
4043
4043
  * <p>The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
4044
4044
  * human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
4045
4045
  * @public
4046
4046
  */
4047
- LastModifiedDate?: Date;
4047
+ LastModifiedDate?: Date | undefined;
4048
4048
  /**
4049
4049
  * <p>The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
4050
4050
  * human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
4051
4051
  * @public
4052
4052
  */
4053
- CreationDate?: Date;
4053
+ CreationDate?: Date | undefined;
4054
4054
  }
4055
4055
  /**
4056
4056
  * @public
@@ -4120,7 +4120,7 @@ export interface CreateResourceServerRequest {
4120
4120
  * <code>description</code>.</p>
4121
4121
  * @public
4122
4122
  */
4123
- Scopes?: ResourceServerScopeType[];
4123
+ Scopes?: ResourceServerScopeType[] | undefined;
4124
4124
  }
4125
4125
  /**
4126
4126
  * <p>A container for information about a resource server for a user pool.</p>
@@ -4131,7 +4131,7 @@ export interface ResourceServerType {
4131
4131
  * <p>The user pool ID for the user pool that hosts the resource server.</p>
4132
4132
  * @public
4133
4133
  */
4134
- UserPoolId?: string;
4134
+ UserPoolId?: string | undefined;
4135
4135
  /**
4136
4136
  * <p>A unique resource server identifier for the resource server. The identifier can be an
4137
4137
  * API friendly name like <code>solar-system-data</code>. You can also set an API URL like
@@ -4141,17 +4141,17 @@ export interface ResourceServerType {
4141
4141
  * increase the size of your access tokens.</p>
4142
4142
  * @public
4143
4143
  */
4144
- Identifier?: string;
4144
+ Identifier?: string | undefined;
4145
4145
  /**
4146
4146
  * <p>The name of the resource server.</p>
4147
4147
  * @public
4148
4148
  */
4149
- Name?: string;
4149
+ Name?: string | undefined;
4150
4150
  /**
4151
4151
  * <p>A list of scopes that are defined for the resource server.</p>
4152
4152
  * @public
4153
4153
  */
4154
- Scopes?: ResourceServerScopeType[];
4154
+ Scopes?: ResourceServerScopeType[] | undefined;
4155
4155
  }
4156
4156
  /**
4157
4157
  * @public
@@ -4211,38 +4211,38 @@ export interface UserImportJobType {
4211
4211
  * <p>The job name for the user import job.</p>
4212
4212
  * @public
4213
4213
  */
4214
- JobName?: string;
4214
+ JobName?: string | undefined;
4215
4215
  /**
4216
4216
  * <p>The job ID for the user import job.</p>
4217
4217
  * @public
4218
4218
  */
4219
- JobId?: string;
4219
+ JobId?: string | undefined;
4220
4220
  /**
4221
4221
  * <p>The user pool ID for the user pool that the users are being imported into.</p>
4222
4222
  * @public
4223
4223
  */
4224
- UserPoolId?: string;
4224
+ UserPoolId?: string | undefined;
4225
4225
  /**
4226
4226
  * <p>The pre-signed URL to be used to upload the <code>.csv</code> file.</p>
4227
4227
  * @public
4228
4228
  */
4229
- PreSignedUrl?: string;
4229
+ PreSignedUrl?: string | undefined;
4230
4230
  /**
4231
4231
  * <p>The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
4232
4232
  * human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
4233
4233
  * @public
4234
4234
  */
4235
- CreationDate?: Date;
4235
+ CreationDate?: Date | undefined;
4236
4236
  /**
4237
4237
  * <p>The date when the user import job was started.</p>
4238
4238
  * @public
4239
4239
  */
4240
- StartDate?: Date;
4240
+ StartDate?: Date | undefined;
4241
4241
  /**
4242
4242
  * <p>The date when the user import job was completed.</p>
4243
4243
  * @public
4244
4244
  */
4245
- CompletionDate?: Date;
4245
+ CompletionDate?: Date | undefined;
4246
4246
  /**
4247
4247
  * <p>The status of the user import job. One of the following:</p>
4248
4248
  * <ul>
@@ -4287,34 +4287,34 @@ export interface UserImportJobType {
4287
4287
  * </ul>
4288
4288
  * @public
4289
4289
  */
4290
- Status?: UserImportJobStatusType;
4290
+ Status?: UserImportJobStatusType | undefined;
4291
4291
  /**
4292
4292
  * <p>The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging role for the user import
4293
4293
  * job. For more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer
4294
4294
  * Guide.</p>
4295
4295
  * @public
4296
4296
  */
4297
- CloudWatchLogsRoleArn?: string;
4297
+ CloudWatchLogsRoleArn?: string | undefined;
4298
4298
  /**
4299
4299
  * <p>The number of users that were successfully imported.</p>
4300
4300
  * @public
4301
4301
  */
4302
- ImportedUsers?: number;
4302
+ ImportedUsers?: number | undefined;
4303
4303
  /**
4304
4304
  * <p>The number of users that were skipped.</p>
4305
4305
  * @public
4306
4306
  */
4307
- SkippedUsers?: number;
4307
+ SkippedUsers?: number | undefined;
4308
4308
  /**
4309
4309
  * <p>The number of users that couldn't be imported.</p>
4310
4310
  * @public
4311
4311
  */
4312
- FailedUsers?: number;
4312
+ FailedUsers?: number | undefined;
4313
4313
  /**
4314
4314
  * <p>The message returned when the user import job is completed.</p>
4315
4315
  * @public
4316
4316
  */
4317
- CompletionMessage?: string;
4317
+ CompletionMessage?: string | undefined;
4318
4318
  }
4319
4319
  /**
4320
4320
  * <p>Represents the response from the server to the request to create the user import
@@ -4326,7 +4326,7 @@ export interface CreateUserImportJobResponse {
4326
4326
  * <p>The job object that represents the user import job.</p>
4327
4327
  * @public
4328
4328
  */
4329
- UserImportJob?: UserImportJobType;
4329
+ UserImportJob?: UserImportJobType | undefined;
4330
4330
  }
4331
4331
  /**
4332
4332
  * @public
@@ -4372,7 +4372,7 @@ export interface DeviceConfigurationType {
4372
4372
  * </note>
4373
4373
  * @public
4374
4374
  */
4375
- ChallengeRequiredOnNewDevice?: boolean;
4375
+ ChallengeRequiredOnNewDevice?: boolean | undefined;
4376
4376
  /**
4377
4377
  * <p>When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a
4378
4378
  * <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html">
@@ -4384,7 +4384,7 @@ export interface DeviceConfigurationType {
4384
4384
  * API request.</p>
4385
4385
  * @public
4386
4386
  */
4387
- DeviceOnlyRememberedOnUserPrompt?: boolean;
4387
+ DeviceOnlyRememberedOnUserPrompt?: boolean | undefined;
4388
4388
  }
4389
4389
  /**
4390
4390
  * @public
@@ -4434,12 +4434,12 @@ export interface EmailConfigurationType {
4434
4434
  * Guide</a>.</p>
4435
4435
  * @public
4436
4436
  */
4437
- SourceArn?: string;
4437
+ SourceArn?: string | undefined;
4438
4438
  /**
4439
4439
  * <p>The destination to which the receiver of the email should reply.</p>
4440
4440
  * @public
4441
4441
  */
4442
- ReplyToEmailAddress?: string;
4442
+ ReplyToEmailAddress?: string | undefined;
4443
4443
  /**
4444
4444
  * <p>Specifies whether Amazon Cognito uses its built-in functionality to send your users email
4445
4445
  * messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following
@@ -4480,7 +4480,7 @@ export interface EmailConfigurationType {
4480
4480
  * </dl>
4481
4481
  * @public
4482
4482
  */
4483
- EmailSendingAccount?: EmailSendingAccountType;
4483
+ EmailSendingAccount?: EmailSendingAccountType | undefined;
4484
4484
  /**
4485
4485
  * <p>Either the sender’s email address or the sender’s name with their email address. For
4486
4486
  * example, <code>testuser@example.com</code> or <code>Test User
@@ -4488,7 +4488,7 @@ export interface EmailConfigurationType {
4488
4488
  * email.</p>
4489
4489
  * @public
4490
4490
  */
4491
- From?: string;
4491
+ From?: string | undefined;
4492
4492
  /**
4493
4493
  * <p>The set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. A
4494
4494
  * configuration set is applied to an email by including a reference to the configuration
@@ -4512,7 +4512,7 @@ export interface EmailConfigurationType {
4512
4512
  * </dl>
4513
4513
  * @public
4514
4514
  */
4515
- ConfigurationSet?: string;
4515
+ ConfigurationSet?: string | undefined;
4516
4516
  }
4517
4517
  /**
4518
4518
  * @public
@@ -4612,42 +4612,42 @@ export interface LambdaConfigType {
4612
4612
  * <p>A pre-registration Lambda trigger.</p>
4613
4613
  * @public
4614
4614
  */
4615
- PreSignUp?: string;
4615
+ PreSignUp?: string | undefined;
4616
4616
  /**
4617
4617
  * <p>A custom Message Lambda trigger.</p>
4618
4618
  * @public
4619
4619
  */
4620
- CustomMessage?: string;
4620
+ CustomMessage?: string | undefined;
4621
4621
  /**
4622
4622
  * <p>A post-confirmation Lambda trigger.</p>
4623
4623
  * @public
4624
4624
  */
4625
- PostConfirmation?: string;
4625
+ PostConfirmation?: string | undefined;
4626
4626
  /**
4627
4627
  * <p>A pre-authentication Lambda trigger.</p>
4628
4628
  * @public
4629
4629
  */
4630
- PreAuthentication?: string;
4630
+ PreAuthentication?: string | undefined;
4631
4631
  /**
4632
4632
  * <p>A post-authentication Lambda trigger.</p>
4633
4633
  * @public
4634
4634
  */
4635
- PostAuthentication?: string;
4635
+ PostAuthentication?: string | undefined;
4636
4636
  /**
4637
4637
  * <p>Defines the authentication challenge.</p>
4638
4638
  * @public
4639
4639
  */
4640
- DefineAuthChallenge?: string;
4640
+ DefineAuthChallenge?: string | undefined;
4641
4641
  /**
4642
4642
  * <p>Creates an authentication challenge.</p>
4643
4643
  * @public
4644
4644
  */
4645
- CreateAuthChallenge?: string;
4645
+ CreateAuthChallenge?: string | undefined;
4646
4646
  /**
4647
4647
  * <p>Verifies the authentication challenge response.</p>
4648
4648
  * @public
4649
4649
  */
4650
- VerifyAuthChallengeResponse?: string;
4650
+ VerifyAuthChallengeResponse?: string | undefined;
4651
4651
  /**
4652
4652
  * <p>The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.</p>
4653
4653
  * <p>Set this parameter for legacy purposes. If you also set an ARN in
@@ -4658,36 +4658,36 @@ export interface LambdaConfigType {
4658
4658
  * </p>
4659
4659
  * @public
4660
4660
  */
4661
- PreTokenGeneration?: string;
4661
+ PreTokenGeneration?: string | undefined;
4662
4662
  /**
4663
4663
  * <p>The user migration Lambda config type.</p>
4664
4664
  * @public
4665
4665
  */
4666
- UserMigration?: string;
4666
+ UserMigration?: string | undefined;
4667
4667
  /**
4668
4668
  * <p>The detailed configuration of a pre token generation trigger. If you also set an ARN
4669
4669
  * in <code>PreTokenGeneration</code>, its value must be identical to
4670
4670
  * <code>PreTokenGenerationConfig</code>.</p>
4671
4671
  * @public
4672
4672
  */
4673
- PreTokenGenerationConfig?: PreTokenGenerationVersionConfigType;
4673
+ PreTokenGenerationConfig?: PreTokenGenerationVersionConfigType | undefined;
4674
4674
  /**
4675
4675
  * <p>A custom SMS sender Lambda trigger.</p>
4676
4676
  * @public
4677
4677
  */
4678
- CustomSMSSender?: CustomSMSLambdaVersionConfigType;
4678
+ CustomSMSSender?: CustomSMSLambdaVersionConfigType | undefined;
4679
4679
  /**
4680
4680
  * <p>A custom email sender Lambda trigger.</p>
4681
4681
  * @public
4682
4682
  */
4683
- CustomEmailSender?: CustomEmailLambdaVersionConfigType;
4683
+ CustomEmailSender?: CustomEmailLambdaVersionConfigType | undefined;
4684
4684
  /**
4685
4685
  * <p>The Amazon Resource Name (ARN) of an <a href="/kms/latest/developerguide/concepts.html#master_keys">KMS key</a>. Amazon Cognito
4686
4686
  * uses the key to encrypt codes and temporary passwords sent to
4687
4687
  * <code>CustomEmailSender</code> and <code>CustomSMSSender</code>.</p>
4688
4688
  * @public
4689
4689
  */
4690
- KMSKeyID?: string;
4690
+ KMSKeyID?: string | undefined;
4691
4691
  }
4692
4692
  /**
4693
4693
  * @public
@@ -4712,31 +4712,31 @@ export interface PasswordPolicyType {
4712
4712
  * be less than 6.</p>
4713
4713
  * @public
4714
4714
  */
4715
- MinimumLength?: number;
4715
+ MinimumLength?: number | undefined;
4716
4716
  /**
4717
4717
  * <p>In the password policy that you have set, refers to whether you have required users to
4718
4718
  * use at least one uppercase letter in their password.</p>
4719
4719
  * @public
4720
4720
  */
4721
- RequireUppercase?: boolean;
4721
+ RequireUppercase?: boolean | undefined;
4722
4722
  /**
4723
4723
  * <p>In the password policy that you have set, refers to whether you have required users to
4724
4724
  * use at least one lowercase letter in their password.</p>
4725
4725
  * @public
4726
4726
  */
4727
- RequireLowercase?: boolean;
4727
+ RequireLowercase?: boolean | undefined;
4728
4728
  /**
4729
4729
  * <p>In the password policy that you have set, refers to whether you have required users to
4730
4730
  * use at least one number in their password.</p>
4731
4731
  * @public
4732
4732
  */
4733
- RequireNumbers?: boolean;
4733
+ RequireNumbers?: boolean | undefined;
4734
4734
  /**
4735
4735
  * <p>In the password policy that you have set, refers to whether you have required users to
4736
4736
  * use at least one symbol in their password.</p>
4737
4737
  * @public
4738
4738
  */
4739
- RequireSymbols?: boolean;
4739
+ RequireSymbols?: boolean | undefined;
4740
4740
  /**
4741
4741
  * <p>The number of previous passwords that you want Amazon Cognito to restrict each user from
4742
4742
  * reusing. Users can't set a password that matches any of <code>n</code> previous
@@ -4746,7 +4746,7 @@ export interface PasswordPolicyType {
4746
4746
  * advanced security features</a> must be active in your user pool.</p>
4747
4747
  * @public
4748
4748
  */
4749
- PasswordHistorySize?: number;
4749
+ PasswordHistorySize?: number | undefined;
4750
4750
  /**
4751
4751
  * <p>The number of days a temporary password is valid in the password policy. If the user
4752
4752
  * doesn't sign in during this time, an administrator must reset their password. Defaults
@@ -4759,7 +4759,7 @@ export interface PasswordPolicyType {
4759
4759
  * </note>
4760
4760
  * @public
4761
4761
  */
4762
- TemporaryPasswordValidityDays?: number;
4762
+ TemporaryPasswordValidityDays?: number | undefined;
4763
4763
  }
4764
4764
  /**
4765
4765
  * <p>The policy associated with a user pool.</p>
@@ -4770,7 +4770,7 @@ export interface UserPoolPolicyType {
4770
4770
  * <p>The password policy.</p>
4771
4771
  * @public
4772
4772
  */
4773
- PasswordPolicy?: PasswordPolicyType;
4773
+ PasswordPolicy?: PasswordPolicyType | undefined;
4774
4774
  }
4775
4775
  /**
4776
4776
  * <p>The SMS configuration type is the settings that your Amazon Cognito user pool must use to send
@@ -4803,7 +4803,7 @@ export interface SmsConfigurationType {
4803
4803
  * </p>
4804
4804
  * @public
4805
4805
  */
4806
- ExternalId?: string;
4806
+ ExternalId?: string | undefined;
4807
4807
  /**
4808
4808
  * <p>The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your
4809
4809
  * user pool, or a supported <b>Legacy Amazon SNS alternate
@@ -4813,7 +4813,7 @@ export interface SmsConfigurationType {
4813
4813
  * configuration in the Asia Pacific (Tokyo) Region. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html">SMS message settings for Amazon Cognito user pools</a>.</p>
4814
4814
  * @public
4815
4815
  */
4816
- SnsRegion?: string;
4816
+ SnsRegion?: string | undefined;
4817
4817
  }
4818
4818
  /**
4819
4819
  * <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>,
@@ -4838,7 +4838,7 @@ export interface UserAttributeUpdateSettingsType {
4838
4838
  * <code>email</code> or <code>phone_number</code> attribute.</p>
4839
4839
  * @public
4840
4840
  */
4841
- AttributesRequireVerificationBeforeUpdate?: VerifiedAttributeType[];
4841
+ AttributesRequireVerificationBeforeUpdate?: VerifiedAttributeType[] | undefined;
4842
4842
  }
4843
4843
  /**
4844
4844
  * @public
@@ -4908,7 +4908,7 @@ export interface UserPoolAddOnsType {
4908
4908
  * authentication. </p>
4909
4909
  * @public
4910
4910
  */
4911
- AdvancedSecurityAdditionalFlows?: AdvancedSecurityAdditionalFlowsType;
4911
+ AdvancedSecurityAdditionalFlows?: AdvancedSecurityAdditionalFlowsType | undefined;
4912
4912
  }
4913
4913
  /**
4914
4914
  * @public
@@ -4931,28 +4931,28 @@ export interface VerificationMessageTemplateType {
4931
4931
  * <p>The template for SMS messages that Amazon Cognito sends to your users.</p>
4932
4932
  * @public
4933
4933
  */
4934
- SmsMessage?: string;
4934
+ SmsMessage?: string | undefined;
4935
4935
  /**
4936
4936
  * <p>The template for email messages that Amazon Cognito sends to your users. You can set an
4937
4937
  * <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
4938
4938
  * messages with your own Amazon SES configuration.</p>
4939
4939
  * @public
4940
4940
  */
4941
- EmailMessage?: string;
4941
+ EmailMessage?: string | undefined;
4942
4942
  /**
4943
4943
  * <p>The subject line for the email message template. You can set an
4944
4944
  * <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
4945
4945
  * messages with your own Amazon SES configuration.</p>
4946
4946
  * @public
4947
4947
  */
4948
- EmailSubject?: string;
4948
+ EmailSubject?: string | undefined;
4949
4949
  /**
4950
4950
  * <p>The email message template for sending a confirmation link to the user. You can set an
4951
4951
  * <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
4952
4952
  * messages with your own Amazon SES configuration.</p>
4953
4953
  * @public
4954
4954
  */
4955
- EmailMessageByLink?: string;
4955
+ EmailMessageByLink?: string | undefined;
4956
4956
  /**
4957
4957
  * <p>The subject line for the email message template for sending a confirmation link to the
4958
4958
  * user. You can set an <code>EmailSubjectByLink</code> template only if the value of
@@ -4960,12 +4960,12 @@ export interface VerificationMessageTemplateType {
4960
4960
  * messages with your own Amazon SES configuration.</p>
4961
4961
  * @public
4962
4962
  */
4963
- EmailSubjectByLink?: string;
4963
+ EmailSubjectByLink?: string | undefined;
4964
4964
  /**
4965
4965
  * <p>The default email option.</p>
4966
4966
  * @public
4967
4967
  */
4968
- DefaultEmailOption?: DefaultEmailOptionType;
4968
+ DefaultEmailOption?: DefaultEmailOptionType | undefined;
4969
4969
  }
4970
4970
  /**
4971
4971
  * <p>Represents the request to create a user pool.</p>
@@ -4981,7 +4981,7 @@ export interface CreateUserPoolRequest {
4981
4981
  * <p>The policies associated with the new user pool.</p>
4982
4982
  * @public
4983
4983
  */
4984
- Policies?: UserPoolPolicyType;
4984
+ Policies?: UserPoolPolicyType | undefined;
4985
4985
  /**
4986
4986
  * <p>When active, <code>DeletionProtection</code> prevents accidental deletion of your user
4987
4987
  * pool. Before you can delete a user pool that you have protected against deletion, you
@@ -4992,7 +4992,7 @@ export interface CreateUserPoolRequest {
4992
4992
  * <code>UpdateUserPool</code> API request.</p>
4993
4993
  * @public
4994
4994
  */
4995
- DeletionProtection?: DeletionProtectionType;
4995
+ DeletionProtection?: DeletionProtectionType | undefined;
4996
4996
  /**
4997
4997
  * <p>The Lambda trigger configuration information for the new user pool.</p>
4998
4998
  * <note>
@@ -5007,55 +5007,55 @@ export interface CreateUserPoolRequest {
5007
5007
  * </note>
5008
5008
  * @public
5009
5009
  */
5010
- LambdaConfig?: LambdaConfigType;
5010
+ LambdaConfig?: LambdaConfigType | undefined;
5011
5011
  /**
5012
5012
  * <p>The attributes to be auto-verified. Possible values: <b>email</b>, <b>phone_number</b>.</p>
5013
5013
  * @public
5014
5014
  */
5015
- AutoVerifiedAttributes?: VerifiedAttributeType[];
5015
+ AutoVerifiedAttributes?: VerifiedAttributeType[] | undefined;
5016
5016
  /**
5017
5017
  * <p>Attributes supported as an alias for this user pool. Possible values: <b>phone_number</b>, <b>email</b>, or
5018
5018
  * <b>preferred_username</b>.</p>
5019
5019
  * @public
5020
5020
  */
5021
- AliasAttributes?: AliasAttributeType[];
5021
+ AliasAttributes?: AliasAttributeType[] | undefined;
5022
5022
  /**
5023
5023
  * <p>Specifies whether a user can use an email address or phone number as a username when
5024
5024
  * they sign up.</p>
5025
5025
  * @public
5026
5026
  */
5027
- UsernameAttributes?: UsernameAttributeType[];
5027
+ UsernameAttributes?: UsernameAttributeType[] | undefined;
5028
5028
  /**
5029
5029
  * <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>
5030
5030
  * @public
5031
5031
  */
5032
- SmsVerificationMessage?: string;
5032
+ SmsVerificationMessage?: string | undefined;
5033
5033
  /**
5034
5034
  * <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>
5035
5035
  * @public
5036
5036
  */
5037
- EmailVerificationMessage?: string;
5037
+ EmailVerificationMessage?: string | undefined;
5038
5038
  /**
5039
5039
  * <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>
5040
5040
  * @public
5041
5041
  */
5042
- EmailVerificationSubject?: string;
5042
+ EmailVerificationSubject?: string | undefined;
5043
5043
  /**
5044
5044
  * <p>The template for the verification message that the user sees when the app requests
5045
5045
  * permission to access the user's information.</p>
5046
5046
  * @public
5047
5047
  */
5048
- VerificationMessageTemplate?: VerificationMessageTemplateType;
5048
+ VerificationMessageTemplate?: VerificationMessageTemplateType | undefined;
5049
5049
  /**
5050
5050
  * <p>A string representing the SMS authentication message.</p>
5051
5051
  * @public
5052
5052
  */
5053
- SmsAuthenticationMessage?: string;
5053
+ SmsAuthenticationMessage?: string | undefined;
5054
5054
  /**
5055
5055
  * <p>Specifies MFA configuration details.</p>
5056
5056
  * @public
5057
5057
  */
5058
- MfaConfiguration?: UserPoolMfaType;
5058
+ MfaConfiguration?: UserPoolMfaType | undefined;
5059
5059
  /**
5060
5060
  * <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>,
5061
5061
  * 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
@@ -5063,7 +5063,7 @@ export interface CreateUserPoolRequest {
5063
5063
  * Verifying updates to email addresses and phone numbers</a>.</p>
5064
5064
  * @public
5065
5065
  */
5066
- UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType;
5066
+ UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType | undefined;
5067
5067
  /**
5068
5068
  * <p>The device-remembering configuration for a user pool. A null value indicates that you
5069
5069
  * have deactivated device remembering in your user pool.</p>
@@ -5073,14 +5073,14 @@ export interface CreateUserPoolRequest {
5073
5073
  * </note>
5074
5074
  * @public
5075
5075
  */
5076
- DeviceConfiguration?: DeviceConfigurationType;
5076
+ DeviceConfiguration?: DeviceConfigurationType | undefined;
5077
5077
  /**
5078
5078
  * <p>The email configuration of your user pool. The email configuration type sets your
5079
5079
  * preferred sending method, Amazon Web Services Region, and sender for messages from your user
5080
5080
  * pool.</p>
5081
5081
  * @public
5082
5082
  */
5083
- EmailConfiguration?: EmailConfigurationType;
5083
+ EmailConfiguration?: EmailConfigurationType | undefined;
5084
5084
  /**
5085
5085
  * <p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an
5086
5086
  * SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages
@@ -5088,25 +5088,25 @@ export interface CreateUserPoolRequest {
5088
5088
  * (IAM) role in your Amazon Web Services account.</p>
5089
5089
  * @public
5090
5090
  */
5091
- SmsConfiguration?: SmsConfigurationType;
5091
+ SmsConfiguration?: SmsConfigurationType | undefined;
5092
5092
  /**
5093
5093
  * <p>The tag keys and values to assign to the user pool. A tag is a label that you can use
5094
5094
  * to categorize and manage user pools in different ways, such as by purpose, owner,
5095
5095
  * environment, or other criteria.</p>
5096
5096
  * @public
5097
5097
  */
5098
- UserPoolTags?: Record<string, string>;
5098
+ UserPoolTags?: Record<string, string> | undefined;
5099
5099
  /**
5100
5100
  * <p>The configuration for <code>AdminCreateUser</code> requests.</p>
5101
5101
  * @public
5102
5102
  */
5103
- AdminCreateUserConfig?: AdminCreateUserConfigType;
5103
+ AdminCreateUserConfig?: AdminCreateUserConfigType | undefined;
5104
5104
  /**
5105
5105
  * <p>An array of schema attributes for the new user pool. These attributes can be standard
5106
5106
  * or custom attributes.</p>
5107
5107
  * @public
5108
5108
  */
5109
- Schema?: SchemaAttributeType[];
5109
+ Schema?: SchemaAttributeType[] | undefined;
5110
5110
  /**
5111
5111
  * <p>User pool add-ons. Contains settings for activation of advanced security features. To
5112
5112
  * log user security information but take no action, set to <code>AUDIT</code>. To
@@ -5115,7 +5115,7 @@ export interface CreateUserPoolRequest {
5115
5115
  * <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">Adding advanced security to a user pool</a>.</p>
5116
5116
  * @public
5117
5117
  */
5118
- UserPoolAddOns?: UserPoolAddOnsType;
5118
+ UserPoolAddOns?: UserPoolAddOnsType | undefined;
5119
5119
  /**
5120
5120
  * <p>Case sensitivity on the username input for the selected sign-in option. When case
5121
5121
  * sensitivity is set to <code>False</code> (case insensitive), users can sign in with any
@@ -5129,7 +5129,7 @@ export interface CreateUserPoolRequest {
5129
5129
  * <p>This configuration is immutable after you set it. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html">UsernameConfigurationType</a>.</p>
5130
5130
  * @public
5131
5131
  */
5132
- UsernameConfiguration?: UsernameConfigurationType;
5132
+ UsernameConfiguration?: UsernameConfigurationType | undefined;
5133
5133
  /**
5134
5134
  * <p>The available verified method a user can use to recover their password when they call
5135
5135
  * <code>ForgotPassword</code>. You can use this setting to define a preferred method
@@ -5139,7 +5139,7 @@ export interface CreateUserPoolRequest {
5139
5139
  * behavior to determine the recovery method where SMS is preferred through email.</p>
5140
5140
  * @public
5141
5141
  */
5142
- AccountRecoverySetting?: AccountRecoverySettingType;
5142
+ AccountRecoverySetting?: AccountRecoverySettingType | undefined;
5143
5143
  }
5144
5144
  /**
5145
5145
  * @public
@@ -5162,17 +5162,17 @@ export interface UserPoolType {
5162
5162
  * <p>The ID of the user pool.</p>
5163
5163
  * @public
5164
5164
  */
5165
- Id?: string;
5165
+ Id?: string | undefined;
5166
5166
  /**
5167
5167
  * <p>The name of the user pool.</p>
5168
5168
  * @public
5169
5169
  */
5170
- Name?: string;
5170
+ Name?: string | undefined;
5171
5171
  /**
5172
5172
  * <p>The policies associated with the user pool.</p>
5173
5173
  * @public
5174
5174
  */
5175
- Policies?: UserPoolPolicyType;
5175
+ Policies?: UserPoolPolicyType | undefined;
5176
5176
  /**
5177
5177
  * <p>When active, <code>DeletionProtection</code> prevents accidental deletion of your user
5178
5178
  * pool. Before you can delete a user pool that you have protected against deletion, you
@@ -5183,31 +5183,31 @@ export interface UserPoolType {
5183
5183
  * <code>UpdateUserPool</code> API request.</p>
5184
5184
  * @public
5185
5185
  */
5186
- DeletionProtection?: DeletionProtectionType;
5186
+ DeletionProtection?: DeletionProtectionType | undefined;
5187
5187
  /**
5188
5188
  * <p>The Lambda triggers associated with the user pool.</p>
5189
5189
  * @public
5190
5190
  */
5191
- LambdaConfig?: LambdaConfigType;
5191
+ LambdaConfig?: LambdaConfigType | undefined;
5192
5192
  /**
5193
5193
  * @deprecated
5194
5194
  *
5195
5195
  * <p>This parameter is no longer used.</p>
5196
5196
  * @public
5197
5197
  */
5198
- Status?: StatusType;
5198
+ Status?: StatusType | undefined;
5199
5199
  /**
5200
5200
  * <p>The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
5201
5201
  * human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
5202
5202
  * @public
5203
5203
  */
5204
- LastModifiedDate?: Date;
5204
+ LastModifiedDate?: Date | undefined;
5205
5205
  /**
5206
5206
  * <p>The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
5207
5207
  * human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
5208
5208
  * @public
5209
5209
  */
5210
- CreationDate?: Date;
5210
+ CreationDate?: Date | undefined;
5211
5211
  /**
5212
5212
  * <p>A list of the user attributes and their properties in your user pool. The attribute
5213
5213
  * schema contains standard attributes, custom attributes with a <code>custom:</code>
@@ -5219,48 +5219,48 @@ export interface UserPoolType {
5219
5219
  * API operations. Use app client read/write permissions instead.</p>
5220
5220
  * @public
5221
5221
  */
5222
- SchemaAttributes?: SchemaAttributeType[];
5222
+ SchemaAttributes?: SchemaAttributeType[] | undefined;
5223
5223
  /**
5224
5224
  * <p>The attributes that are auto-verified in a user pool.</p>
5225
5225
  * @public
5226
5226
  */
5227
- AutoVerifiedAttributes?: VerifiedAttributeType[];
5227
+ AutoVerifiedAttributes?: VerifiedAttributeType[] | undefined;
5228
5228
  /**
5229
5229
  * <p>The attributes that are aliased in a user pool.</p>
5230
5230
  * @public
5231
5231
  */
5232
- AliasAttributes?: AliasAttributeType[];
5232
+ AliasAttributes?: AliasAttributeType[] | undefined;
5233
5233
  /**
5234
5234
  * <p>Specifies whether a user can use an email address or phone number as a username when
5235
5235
  * they sign up.</p>
5236
5236
  * @public
5237
5237
  */
5238
- UsernameAttributes?: UsernameAttributeType[];
5238
+ UsernameAttributes?: UsernameAttributeType[] | undefined;
5239
5239
  /**
5240
5240
  * <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>
5241
5241
  * @public
5242
5242
  */
5243
- SmsVerificationMessage?: string;
5243
+ SmsVerificationMessage?: string | undefined;
5244
5244
  /**
5245
5245
  * <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>
5246
5246
  * @public
5247
5247
  */
5248
- EmailVerificationMessage?: string;
5248
+ EmailVerificationMessage?: string | undefined;
5249
5249
  /**
5250
5250
  * <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>
5251
5251
  * @public
5252
5252
  */
5253
- EmailVerificationSubject?: string;
5253
+ EmailVerificationSubject?: string | undefined;
5254
5254
  /**
5255
5255
  * <p>The template for verification messages.</p>
5256
5256
  * @public
5257
5257
  */
5258
- VerificationMessageTemplate?: VerificationMessageTemplateType;
5258
+ VerificationMessageTemplate?: VerificationMessageTemplateType | undefined;
5259
5259
  /**
5260
5260
  * <p>The contents of the SMS authentication message.</p>
5261
5261
  * @public
5262
5262
  */
5263
- SmsAuthenticationMessage?: string;
5263
+ SmsAuthenticationMessage?: string | undefined;
5264
5264
  /**
5265
5265
  * <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>,
5266
5266
  * 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
@@ -5268,7 +5268,7 @@ export interface UserPoolType {
5268
5268
  * Verifying updates to email addresses and phone numbers</a>.</p>
5269
5269
  * @public
5270
5270
  */
5271
- UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType;
5271
+ UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType | undefined;
5272
5272
  /**
5273
5273
  * <p>Can be one of the following values:</p>
5274
5274
  * <ul>
@@ -5290,7 +5290,7 @@ export interface UserPoolType {
5290
5290
  * </ul>
5291
5291
  * @public
5292
5292
  */
5293
- MfaConfiguration?: UserPoolMfaType;
5293
+ MfaConfiguration?: UserPoolMfaType | undefined;
5294
5294
  /**
5295
5295
  * <p>The device-remembering configuration for a user pool. A null value indicates that you
5296
5296
  * have deactivated device remembering in your user pool.</p>
@@ -5300,19 +5300,19 @@ export interface UserPoolType {
5300
5300
  * </note>
5301
5301
  * @public
5302
5302
  */
5303
- DeviceConfiguration?: DeviceConfigurationType;
5303
+ DeviceConfiguration?: DeviceConfigurationType | undefined;
5304
5304
  /**
5305
5305
  * <p>A number estimating the size of the user pool.</p>
5306
5306
  * @public
5307
5307
  */
5308
- EstimatedNumberOfUsers?: number;
5308
+ EstimatedNumberOfUsers?: number | undefined;
5309
5309
  /**
5310
5310
  * <p>The email configuration of your user pool. The email configuration type sets your
5311
5311
  * preferred sending method, Amazon Web Services Region, and sender for messages from your user
5312
5312
  * pool.</p>
5313
5313
  * @public
5314
5314
  */
5315
- EmailConfiguration?: EmailConfigurationType;
5315
+ EmailConfiguration?: EmailConfigurationType | undefined;
5316
5316
  /**
5317
5317
  * <p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an
5318
5318
  * SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages
@@ -5320,14 +5320,14 @@ export interface UserPoolType {
5320
5320
  * (IAM) role in your Amazon Web Services account.</p>
5321
5321
  * @public
5322
5322
  */
5323
- SmsConfiguration?: SmsConfigurationType;
5323
+ SmsConfiguration?: SmsConfigurationType | undefined;
5324
5324
  /**
5325
5325
  * <p>The tags that are assigned to the user pool. A tag is a label that you can apply to
5326
5326
  * user pools to categorize and manage them in different ways, such as by purpose, owner,
5327
5327
  * environment, or other criteria.</p>
5328
5328
  * @public
5329
5329
  */
5330
- UserPoolTags?: Record<string, string>;
5330
+ UserPoolTags?: Record<string, string> | undefined;
5331
5331
  /**
5332
5332
  * <p>The reason why the SMS configuration can't send the messages to your users.</p>
5333
5333
  * <p>This message might include comma-separated values to describe why your SMS
@@ -5350,19 +5350,19 @@ export interface UserPoolType {
5350
5350
  * </dl>
5351
5351
  * @public
5352
5352
  */
5353
- SmsConfigurationFailure?: string;
5353
+ SmsConfigurationFailure?: string | undefined;
5354
5354
  /**
5355
5355
  * <p>Deprecated. Review error codes from API requests with
5356
5356
  * <code>EventSource:cognito-idp.amazonaws.com</code> in CloudTrail for
5357
5357
  * information about problems with user pool email configuration.</p>
5358
5358
  * @public
5359
5359
  */
5360
- EmailConfigurationFailure?: string;
5360
+ EmailConfigurationFailure?: string | undefined;
5361
5361
  /**
5362
5362
  * <p>The domain prefix, if the user pool has a domain associated with it.</p>
5363
5363
  * @public
5364
5364
  */
5365
- Domain?: string;
5365
+ Domain?: string | undefined;
5366
5366
  /**
5367
5367
  * <p>A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use
5368
5368
  * a custom domain to host the sign-up and sign-in pages for your application. An example
@@ -5370,12 +5370,12 @@ export interface UserPoolType {
5370
5370
  * <p>For more information about adding a custom domain to your user pool, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html">Using Your Own Domain for the Hosted UI</a>.</p>
5371
5371
  * @public
5372
5372
  */
5373
- CustomDomain?: string;
5373
+ CustomDomain?: string | undefined;
5374
5374
  /**
5375
5375
  * <p>The configuration for <code>AdminCreateUser</code> requests.</p>
5376
5376
  * @public
5377
5377
  */
5378
- AdminCreateUserConfig?: AdminCreateUserConfigType;
5378
+ AdminCreateUserConfig?: AdminCreateUserConfigType | undefined;
5379
5379
  /**
5380
5380
  * <p>User pool add-ons. Contains settings for activation of advanced security features. To
5381
5381
  * log user security information but take no action, set to <code>AUDIT</code>. To
@@ -5384,7 +5384,7 @@ export interface UserPoolType {
5384
5384
  * <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">Adding advanced security to a user pool</a>.</p>
5385
5385
  * @public
5386
5386
  */
5387
- UserPoolAddOns?: UserPoolAddOnsType;
5387
+ UserPoolAddOns?: UserPoolAddOnsType | undefined;
5388
5388
  /**
5389
5389
  * <p>Case sensitivity of the username input for the selected sign-in option. For example,
5390
5390
  * when case sensitivity is set to <code>False</code>, users can sign in using either
@@ -5392,12 +5392,12 @@ export interface UserPoolType {
5392
5392
  * information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html">UsernameConfigurationType</a>.</p>
5393
5393
  * @public
5394
5394
  */
5395
- UsernameConfiguration?: UsernameConfigurationType;
5395
+ UsernameConfiguration?: UsernameConfigurationType | undefined;
5396
5396
  /**
5397
5397
  * <p>The Amazon Resource Name (ARN) for the user pool.</p>
5398
5398
  * @public
5399
5399
  */
5400
- Arn?: string;
5400
+ Arn?: string | undefined;
5401
5401
  /**
5402
5402
  * <p>The available verified method a user can use to recover their password when they call
5403
5403
  * <code>ForgotPassword</code>. You can use this setting to define a preferred method
@@ -5407,7 +5407,7 @@ export interface UserPoolType {
5407
5407
  * behavior to determine the recovery method where SMS is preferred through email.</p>
5408
5408
  * @public
5409
5409
  */
5410
- AccountRecoverySetting?: AccountRecoverySettingType;
5410
+ AccountRecoverySetting?: AccountRecoverySettingType | undefined;
5411
5411
  }
5412
5412
  /**
5413
5413
  * <p>Represents the response from the server for the request to create a user pool.</p>
@@ -5418,7 +5418,7 @@ export interface CreateUserPoolResponse {
5418
5418
  * <p>A container for the user pool details.</p>
5419
5419
  * @public
5420
5420
  */
5421
- UserPool?: UserPoolType;
5421
+ UserPool?: UserPoolType | undefined;
5422
5422
  }
5423
5423
  /**
5424
5424
  * <p>This exception is thrown when a user pool tag can't be set or updated.</p>
@@ -5503,7 +5503,7 @@ export interface TokenValidityUnitsType {
5503
5503
  * day.</p>
5504
5504
  * @public
5505
5505
  */
5506
- AccessToken?: TimeUnitsType;
5506
+ AccessToken?: TimeUnitsType | undefined;
5507
5507
  /**
5508
5508
  * <p>A time unit of <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or
5509
5509
  * <code>days</code> for the value that you set in the <code>IdTokenValidity</code>
@@ -5511,7 +5511,7 @@ export interface TokenValidityUnitsType {
5511
5511
  * <code>IdTokenValidity</code> duration can range from five minutes to one day.</p>
5512
5512
  * @public
5513
5513
  */
5514
- IdToken?: TimeUnitsType;
5514
+ IdToken?: TimeUnitsType | undefined;
5515
5515
  /**
5516
5516
  * <p>A time unit of <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or
5517
5517
  * <code>days</code> for the value that you set in the
@@ -5521,7 +5521,7 @@ export interface TokenValidityUnitsType {
5521
5521
  * years.</p>
5522
5522
  * @public
5523
5523
  */
5524
- RefreshToken?: TimeUnitsType;
5524
+ RefreshToken?: TimeUnitsType | undefined;
5525
5525
  }
5526
5526
  /**
5527
5527
  * <p>Represents the request to create a user pool client.</p>
@@ -5543,7 +5543,7 @@ export interface CreateUserPoolClientRequest {
5543
5543
  * being created.</p>
5544
5544
  * @public
5545
5545
  */
5546
- GenerateSecret?: boolean;
5546
+ GenerateSecret?: boolean | undefined;
5547
5547
  /**
5548
5548
  * <p>The refresh token time limit. After this limit expires, your user can't use
5549
5549
  * their refresh token. To specify the time unit for <code>RefreshTokenValidity</code> as
@@ -5560,7 +5560,7 @@ export interface CreateUserPoolClientRequest {
5560
5560
  * tokens are valid for 30 days.</p>
5561
5561
  * @public
5562
5562
  */
5563
- RefreshTokenValidity?: number;
5563
+ RefreshTokenValidity?: number | undefined;
5564
5564
  /**
5565
5565
  * <p>The access token time limit. After this limit expires, your user can't use
5566
5566
  * their access token. To specify the time unit for <code>AccessTokenValidity</code> as
@@ -5575,7 +5575,7 @@ export interface CreateUserPoolClientRequest {
5575
5575
  * tokens are valid for one hour.</p>
5576
5576
  * @public
5577
5577
  */
5578
- AccessTokenValidity?: number;
5578
+ AccessTokenValidity?: number | undefined;
5579
5579
  /**
5580
5580
  * <p>The ID token time limit. After this limit expires, your user can't use
5581
5581
  * their ID token. To specify the time unit for <code>IdTokenValidity</code> as
@@ -5590,13 +5590,13 @@ export interface CreateUserPoolClientRequest {
5590
5590
  * tokens are valid for one hour.</p>
5591
5591
  * @public
5592
5592
  */
5593
- IdTokenValidity?: number;
5593
+ IdTokenValidity?: number | undefined;
5594
5594
  /**
5595
5595
  * <p>The units in which the validity times are represented. The default unit for
5596
5596
  * RefreshToken is days, and default for ID and access tokens are hours.</p>
5597
5597
  * @public
5598
5598
  */
5599
- TokenValidityUnits?: TokenValidityUnitsType;
5599
+ TokenValidityUnits?: TokenValidityUnitsType | undefined;
5600
5600
  /**
5601
5601
  * <p>The list of user attributes that you want your app client to have read access to.
5602
5602
  * After your user authenticates in your app, their access token authorizes them to read
@@ -5613,7 +5613,7 @@ export interface CreateUserPoolClientRequest {
5613
5613
  * custom set of read attributes.</p>
5614
5614
  * @public
5615
5615
  */
5616
- ReadAttributes?: string[];
5616
+ ReadAttributes?: string[] | undefined;
5617
5617
  /**
5618
5618
  * <p>The list of user attributes that you want your app client to have write access to.
5619
5619
  * After your user authenticates in your app, their access token authorizes them to set or
@@ -5635,7 +5635,7 @@ export interface CreateUserPoolClientRequest {
5635
5635
  * pool</a>.</p>
5636
5636
  * @public
5637
5637
  */
5638
- WriteAttributes?: string[];
5638
+ WriteAttributes?: string[] | undefined;
5639
5639
  /**
5640
5640
  * <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
5641
5641
  * your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and
@@ -5679,7 +5679,7 @@ export interface CreateUserPoolClientRequest {
5679
5679
  * like <code>ALLOW_USER_SRP_AUTH</code>.</p>
5680
5680
  * @public
5681
5681
  */
5682
- ExplicitAuthFlows?: ExplicitAuthFlowsType[];
5682
+ ExplicitAuthFlows?: ExplicitAuthFlowsType[] | undefined;
5683
5683
  /**
5684
5684
  * <p>A list of provider names for the identity providers (IdPs) that are supported on this
5685
5685
  * client. The following are supported: <code>COGNITO</code>, <code>Facebook</code>,
@@ -5688,7 +5688,7 @@ export interface CreateUserPoolClientRequest {
5688
5688
  * user pool, for example <code>MySAMLIdP</code> or <code>MyOIDCIdP</code>.</p>
5689
5689
  * @public
5690
5690
  */
5691
- SupportedIdentityProviders?: string[];
5691
+ SupportedIdentityProviders?: string[] | undefined;
5692
5692
  /**
5693
5693
  * <p>A list of allowed redirect (callback) URLs for the IdPs.</p>
5694
5694
  * <p>A redirect URI must:</p>
@@ -5710,12 +5710,12 @@ export interface CreateUserPoolClientRequest {
5710
5710
  * <p>App callback URLs such as myapp://example are also supported.</p>
5711
5711
  * @public
5712
5712
  */
5713
- CallbackURLs?: string[];
5713
+ CallbackURLs?: string[] | undefined;
5714
5714
  /**
5715
5715
  * <p>A list of allowed logout URLs for the IdPs.</p>
5716
5716
  * @public
5717
5717
  */
5718
- LogoutURLs?: string[];
5718
+ LogoutURLs?: string[] | undefined;
5719
5719
  /**
5720
5720
  * <p>The default redirect URI. In app clients with one assigned IdP, replaces
5721
5721
  * <code>redirect_uri</code> in authentication requests. Must be in the
@@ -5738,7 +5738,7 @@ export interface CreateUserPoolClientRequest {
5738
5738
  * <p>App callback URLs such as myapp://example are also supported.</p>
5739
5739
  * @public
5740
5740
  */
5741
- DefaultRedirectURI?: string;
5741
+ DefaultRedirectURI?: string | undefined;
5742
5742
  /**
5743
5743
  * <p>The OAuth grant types that you want your app client to generate. To create an app
5744
5744
  * client that generates client credentials grants, you must add
@@ -5764,7 +5764,7 @@ export interface CreateUserPoolClientRequest {
5764
5764
  * </dl>
5765
5765
  * @public
5766
5766
  */
5767
- AllowedOAuthFlows?: OAuthFlowType[];
5767
+ AllowedOAuthFlows?: OAuthFlowType[] | undefined;
5768
5768
  /**
5769
5769
  * <p>The allowed OAuth scopes. Possible values provided by OAuth are <code>phone</code>,
5770
5770
  * <code>email</code>, <code>openid</code>, and <code>profile</code>. Possible values
@@ -5772,7 +5772,7 @@ export interface CreateUserPoolClientRequest {
5772
5772
  * scopes created in Resource Servers are also supported.</p>
5773
5773
  * @public
5774
5774
  */
5775
- AllowedOAuthScopes?: string[];
5775
+ AllowedOAuthScopes?: string[] | undefined;
5776
5776
  /**
5777
5777
  * <p>Set to <code>true</code> to use OAuth 2.0 features in your user pool app client.</p>
5778
5778
  * <p>
@@ -5803,7 +5803,7 @@ export interface CreateUserPoolClientRequest {
5803
5803
  * to <code>false</code>.</p>
5804
5804
  * @public
5805
5805
  */
5806
- AllowedOAuthFlowsUserPoolClient?: boolean;
5806
+ AllowedOAuthFlowsUserPoolClient?: boolean | undefined;
5807
5807
  /**
5808
5808
  * <p>The user pool analytics configuration for collecting metrics and sending them to your
5809
5809
  * Amazon Pinpoint campaign.</p>
@@ -5815,7 +5815,7 @@ export interface CreateUserPoolClientRequest {
5815
5815
  * </note>
5816
5816
  * @public
5817
5817
  */
5818
- AnalyticsConfiguration?: AnalyticsConfigurationType;
5818
+ AnalyticsConfiguration?: AnalyticsConfigurationType | undefined;
5819
5819
  /**
5820
5820
  * <p>Errors and responses that you want Amazon Cognito APIs to return during authentication, account
5821
5821
  * confirmation, and password recovery when the user doesn't exist in the user pool. When
@@ -5840,7 +5840,7 @@ export interface CreateUserPoolClientRequest {
5840
5840
  * <p>Defaults to <code>LEGACY</code> when you don't provide a value.</p>
5841
5841
  * @public
5842
5842
  */
5843
- PreventUserExistenceErrors?: PreventUserExistenceErrorTypes;
5843
+ PreventUserExistenceErrors?: PreventUserExistenceErrorTypes | undefined;
5844
5844
  /**
5845
5845
  * <p>Activates or deactivates token revocation. For more information about revoking tokens,
5846
5846
  * see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
@@ -5848,7 +5848,7 @@ export interface CreateUserPoolClientRequest {
5848
5848
  * the new user pool client.</p>
5849
5849
  * @public
5850
5850
  */
5851
- EnableTokenRevocation?: boolean;
5851
+ EnableTokenRevocation?: boolean | undefined;
5852
5852
  /**
5853
5853
  * <p>Activates the propagation of additional user context data. For more information about
5854
5854
  * 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
@@ -5858,13 +5858,13 @@ export interface CreateUserPoolClientRequest {
5858
5858
  * client secret.</p>
5859
5859
  * @public
5860
5860
  */
5861
- EnablePropagateAdditionalUserContextData?: boolean;
5861
+ EnablePropagateAdditionalUserContextData?: boolean | undefined;
5862
5862
  /**
5863
5863
  * <p>Amazon Cognito creates a session token for each API request in an authentication flow. <code>AuthSessionValidity</code> is the duration,
5864
5864
  * in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.</p>
5865
5865
  * @public
5866
5866
  */
5867
- AuthSessionValidity?: number;
5867
+ AuthSessionValidity?: number | undefined;
5868
5868
  }
5869
5869
  /**
5870
5870
  * <p>Contains information about a user pool client.</p>
@@ -5875,34 +5875,34 @@ export interface UserPoolClientType {
5875
5875
  * <p>The user pool ID for the user pool client.</p>
5876
5876
  * @public
5877
5877
  */
5878
- UserPoolId?: string;
5878
+ UserPoolId?: string | undefined;
5879
5879
  /**
5880
5880
  * <p>The client name from the user pool request of the client type.</p>
5881
5881
  * @public
5882
5882
  */
5883
- ClientName?: string;
5883
+ ClientName?: string | undefined;
5884
5884
  /**
5885
5885
  * <p>The ID of the client associated with the user pool.</p>
5886
5886
  * @public
5887
5887
  */
5888
- ClientId?: string;
5888
+ ClientId?: string | undefined;
5889
5889
  /**
5890
5890
  * <p>The client secret from the user pool request of the client type.</p>
5891
5891
  * @public
5892
5892
  */
5893
- ClientSecret?: string;
5893
+ ClientSecret?: string | undefined;
5894
5894
  /**
5895
5895
  * <p>The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
5896
5896
  * human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
5897
5897
  * @public
5898
5898
  */
5899
- LastModifiedDate?: Date;
5899
+ LastModifiedDate?: Date | undefined;
5900
5900
  /**
5901
5901
  * <p>The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
5902
5902
  * human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
5903
5903
  * @public
5904
5904
  */
5905
- CreationDate?: Date;
5905
+ CreationDate?: Date | undefined;
5906
5906
  /**
5907
5907
  * <p>The refresh token time limit. After this limit expires, your user can't use
5908
5908
  * their refresh token. To specify the time unit for <code>RefreshTokenValidity</code> as
@@ -5919,7 +5919,7 @@ export interface UserPoolClientType {
5919
5919
  * tokens are valid for 30 days.</p>
5920
5920
  * @public
5921
5921
  */
5922
- RefreshTokenValidity?: number;
5922
+ RefreshTokenValidity?: number | undefined;
5923
5923
  /**
5924
5924
  * <p>The access token time limit. After this limit expires, your user can't use
5925
5925
  * their access token. To specify the time unit for <code>AccessTokenValidity</code> as
@@ -5934,7 +5934,7 @@ export interface UserPoolClientType {
5934
5934
  * tokens are valid for one hour.</p>
5935
5935
  * @public
5936
5936
  */
5937
- AccessTokenValidity?: number;
5937
+ AccessTokenValidity?: number | undefined;
5938
5938
  /**
5939
5939
  * <p>The ID token time limit. After this limit expires, your user can't use
5940
5940
  * their ID token. To specify the time unit for <code>IdTokenValidity</code> as
@@ -5949,13 +5949,13 @@ export interface UserPoolClientType {
5949
5949
  * tokens are valid for one hour.</p>
5950
5950
  * @public
5951
5951
  */
5952
- IdTokenValidity?: number;
5952
+ IdTokenValidity?: number | undefined;
5953
5953
  /**
5954
5954
  * <p>The time units used to specify the token validity times of each token type: ID,
5955
5955
  * access, and refresh.</p>
5956
5956
  * @public
5957
5957
  */
5958
- TokenValidityUnits?: TokenValidityUnitsType;
5958
+ TokenValidityUnits?: TokenValidityUnitsType | undefined;
5959
5959
  /**
5960
5960
  * <p>The list of user attributes that you want your app client to have read access to.
5961
5961
  * After your user authenticates in your app, their access token authorizes them to read
@@ -5972,7 +5972,7 @@ export interface UserPoolClientType {
5972
5972
  * custom set of read attributes.</p>
5973
5973
  * @public
5974
5974
  */
5975
- ReadAttributes?: string[];
5975
+ ReadAttributes?: string[] | undefined;
5976
5976
  /**
5977
5977
  * <p>The list of user attributes that you want your app client to have write access to.
5978
5978
  * After your user authenticates in your app, their access token authorizes them to set or
@@ -5994,7 +5994,7 @@ export interface UserPoolClientType {
5994
5994
  * pool</a>.</p>
5995
5995
  * @public
5996
5996
  */
5997
- WriteAttributes?: string[];
5997
+ WriteAttributes?: string[] | undefined;
5998
5998
  /**
5999
5999
  * <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
6000
6000
  * your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and
@@ -6038,7 +6038,7 @@ export interface UserPoolClientType {
6038
6038
  * like <code>ALLOW_USER_SRP_AUTH</code>.</p>
6039
6039
  * @public
6040
6040
  */
6041
- ExplicitAuthFlows?: ExplicitAuthFlowsType[];
6041
+ ExplicitAuthFlows?: ExplicitAuthFlowsType[] | undefined;
6042
6042
  /**
6043
6043
  * <p>A list of provider names for the IdPs that this client supports. The following are
6044
6044
  * supported: <code>COGNITO</code>, <code>Facebook</code>, <code>Google</code>,
@@ -6046,7 +6046,7 @@ export interface UserPoolClientType {
6046
6046
  * own SAML and OIDC providers.</p>
6047
6047
  * @public
6048
6048
  */
6049
- SupportedIdentityProviders?: string[];
6049
+ SupportedIdentityProviders?: string[] | undefined;
6050
6050
  /**
6051
6051
  * <p>A list of allowed redirect (callback) URLs for the IdPs.</p>
6052
6052
  * <p>A redirect URI must:</p>
@@ -6068,12 +6068,12 @@ export interface UserPoolClientType {
6068
6068
  * <p>App callback URLs such as myapp://example are also supported.</p>
6069
6069
  * @public
6070
6070
  */
6071
- CallbackURLs?: string[];
6071
+ CallbackURLs?: string[] | undefined;
6072
6072
  /**
6073
6073
  * <p>A list of allowed logout URLs for the IdPs.</p>
6074
6074
  * @public
6075
6075
  */
6076
- LogoutURLs?: string[];
6076
+ LogoutURLs?: string[] | undefined;
6077
6077
  /**
6078
6078
  * <p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p>
6079
6079
  * <p>A redirect URI must:</p>
@@ -6095,7 +6095,7 @@ export interface UserPoolClientType {
6095
6095
  * <p>App callback URLs such as myapp://example are also supported.</p>
6096
6096
  * @public
6097
6097
  */
6098
- DefaultRedirectURI?: string;
6098
+ DefaultRedirectURI?: string | undefined;
6099
6099
  /**
6100
6100
  * <p>The allowed OAuth flows.</p>
6101
6101
  * <dl>
@@ -6119,7 +6119,7 @@ export interface UserPoolClientType {
6119
6119
  * </dl>
6120
6120
  * @public
6121
6121
  */
6122
- AllowedOAuthFlows?: OAuthFlowType[];
6122
+ AllowedOAuthFlows?: OAuthFlowType[] | undefined;
6123
6123
  /**
6124
6124
  * <p>The OAuth scopes that your app client supports. Possible values that OAuth provides
6125
6125
  * are <code>phone</code>, <code>email</code>, <code>openid</code>, and
@@ -6128,7 +6128,7 @@ export interface UserPoolClientType {
6128
6128
  * you create in Resource Servers.</p>
6129
6129
  * @public
6130
6130
  */
6131
- AllowedOAuthScopes?: string[];
6131
+ AllowedOAuthScopes?: string[] | undefined;
6132
6132
  /**
6133
6133
  * <p>Set to <code>true</code> to use OAuth 2.0 features in your user pool app client.</p>
6134
6134
  * <p>
@@ -6159,7 +6159,7 @@ export interface UserPoolClientType {
6159
6159
  * to <code>false</code>.</p>
6160
6160
  * @public
6161
6161
  */
6162
- AllowedOAuthFlowsUserPoolClient?: boolean;
6162
+ AllowedOAuthFlowsUserPoolClient?: boolean | undefined;
6163
6163
  /**
6164
6164
  * <p>The Amazon Pinpoint analytics configuration for the user pool client.</p>
6165
6165
  * <note>
@@ -6169,7 +6169,7 @@ export interface UserPoolClientType {
6169
6169
  * </note>
6170
6170
  * @public
6171
6171
  */
6172
- AnalyticsConfiguration?: AnalyticsConfigurationType;
6172
+ AnalyticsConfiguration?: AnalyticsConfigurationType | undefined;
6173
6173
  /**
6174
6174
  * <p>Errors and responses that you want Amazon Cognito APIs to return during authentication, account
6175
6175
  * confirmation, and password recovery when the user doesn't exist in the user pool. When
@@ -6194,14 +6194,14 @@ export interface UserPoolClientType {
6194
6194
  * <p>Defaults to <code>LEGACY</code> when you don't provide a value.</p>
6195
6195
  * @public
6196
6196
  */
6197
- PreventUserExistenceErrors?: PreventUserExistenceErrorTypes;
6197
+ PreventUserExistenceErrors?: PreventUserExistenceErrorTypes | undefined;
6198
6198
  /**
6199
6199
  * <p>Indicates whether token revocation is activated for the user pool client. When you
6200
6200
  * create a new user pool client, token revocation is activated by default. For more
6201
6201
  * information about revoking tokens, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
6202
6202
  * @public
6203
6203
  */
6204
- EnableTokenRevocation?: boolean;
6204
+ EnableTokenRevocation?: boolean | undefined;
6205
6205
  /**
6206
6206
  * <p>When <code>EnablePropagateAdditionalUserContextData</code> is true, Amazon Cognito accepts an
6207
6207
  * <code>IpAddress</code> value that you send in the <code>UserContextData</code>
@@ -6220,13 +6220,13 @@ export interface UserPoolClientType {
6220
6220
  * data, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint">Adding user device and session data to API requests</a>.</p>
6221
6221
  * @public
6222
6222
  */
6223
- EnablePropagateAdditionalUserContextData?: boolean;
6223
+ EnablePropagateAdditionalUserContextData?: boolean | undefined;
6224
6224
  /**
6225
6225
  * <p>Amazon Cognito creates a session token for each API request in an authentication flow. <code>AuthSessionValidity</code> is the duration,
6226
6226
  * in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.</p>
6227
6227
  * @public
6228
6228
  */
6229
- AuthSessionValidity?: number;
6229
+ AuthSessionValidity?: number | undefined;
6230
6230
  }
6231
6231
  /**
6232
6232
  * <p>Represents the response from the server to create a user pool client.</p>
@@ -6237,7 +6237,7 @@ export interface CreateUserPoolClientResponse {
6237
6237
  * <p>The user pool client that was just created.</p>
6238
6238
  * @public
6239
6239
  */
6240
- UserPoolClient?: UserPoolClientType;
6240
+ UserPoolClient?: UserPoolClientType | undefined;
6241
6241
  }
6242
6242
  /**
6243
6243
  * <p>This exception is thrown when the specified OAuth flow is not valid.</p>
@@ -6301,7 +6301,7 @@ export interface CreateUserPoolDomainRequest {
6301
6301
  * <p>For more information about the hosted domain and custom domains, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html">Configuring a User Pool Domain</a>.</p>
6302
6302
  * @public
6303
6303
  */
6304
- CustomDomainConfig?: CustomDomainConfigType;
6304
+ CustomDomainConfig?: CustomDomainConfigType | undefined;
6305
6305
  }
6306
6306
  /**
6307
6307
  * @public
@@ -6314,7 +6314,7 @@ export interface CreateUserPoolDomainResponse {
6314
6314
  * operation returns a blank response.</p>
6315
6315
  * @public
6316
6316
  */
6317
- CloudFrontDomain?: string;
6317
+ CloudFrontDomain?: string | undefined;
6318
6318
  }
6319
6319
  /**
6320
6320
  * @public
@@ -6527,7 +6527,7 @@ export interface DescribeRiskConfigurationRequest {
6527
6527
  * <p>The app client ID.</p>
6528
6528
  * @public
6529
6529
  */
6530
- ClientId?: string;
6530
+ ClientId?: string | undefined;
6531
6531
  }
6532
6532
  /**
6533
6533
  * @public
@@ -6575,7 +6575,7 @@ export interface CompromisedCredentialsRiskConfigurationType {
6575
6575
  * filter is specified.</p>
6576
6576
  * @public
6577
6577
  */
6578
- EventFilter?: EventFilterType[];
6578
+ EventFilter?: EventFilterType[] | undefined;
6579
6579
  /**
6580
6580
  * <p>The compromised credentials risk configuration actions.</p>
6581
6581
  * @public
@@ -6593,13 +6593,13 @@ export interface RiskExceptionConfigurationType {
6593
6593
  * prefix.</p>
6594
6594
  * @public
6595
6595
  */
6596
- BlockedIPRangeList?: string[];
6596
+ BlockedIPRangeList?: string[] | undefined;
6597
6597
  /**
6598
6598
  * <p>Risk detection isn't performed on the IP addresses in this range list. The IP range is
6599
6599
  * in CIDR notation.</p>
6600
6600
  * @public
6601
6601
  */
6602
- SkippedIPRangeList?: string[];
6602
+ SkippedIPRangeList?: string[] | undefined;
6603
6603
  }
6604
6604
  /**
6605
6605
  * <p>The risk configuration type.</p>
@@ -6610,36 +6610,36 @@ export interface RiskConfigurationType {
6610
6610
  * <p>The user pool ID.</p>
6611
6611
  * @public
6612
6612
  */
6613
- UserPoolId?: string;
6613
+ UserPoolId?: string | undefined;
6614
6614
  /**
6615
6615
  * <p>The app client ID.</p>
6616
6616
  * @public
6617
6617
  */
6618
- ClientId?: string;
6618
+ ClientId?: string | undefined;
6619
6619
  /**
6620
6620
  * <p>The compromised credentials risk configuration object, including the
6621
6621
  * <code>EventFilter</code> and the <code>EventAction</code>.</p>
6622
6622
  * @public
6623
6623
  */
6624
- CompromisedCredentialsRiskConfiguration?: CompromisedCredentialsRiskConfigurationType;
6624
+ CompromisedCredentialsRiskConfiguration?: CompromisedCredentialsRiskConfigurationType | undefined;
6625
6625
  /**
6626
6626
  * <p>The account takeover risk configuration object, including the
6627
6627
  * <code>NotifyConfiguration</code> object and <code>Actions</code> to take if there is
6628
6628
  * an account takeover.</p>
6629
6629
  * @public
6630
6630
  */
6631
- AccountTakeoverRiskConfiguration?: AccountTakeoverRiskConfigurationType;
6631
+ AccountTakeoverRiskConfiguration?: AccountTakeoverRiskConfigurationType | undefined;
6632
6632
  /**
6633
6633
  * <p>The configuration to override the risk decision.</p>
6634
6634
  * @public
6635
6635
  */
6636
- RiskExceptionConfiguration?: RiskExceptionConfigurationType;
6636
+ RiskExceptionConfiguration?: RiskExceptionConfigurationType | undefined;
6637
6637
  /**
6638
6638
  * <p>The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
6639
6639
  * human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
6640
6640
  * @public
6641
6641
  */
6642
- LastModifiedDate?: Date;
6642
+ LastModifiedDate?: Date | undefined;
6643
6643
  }
6644
6644
  /**
6645
6645
  * @public
@@ -6677,7 +6677,7 @@ export interface DescribeUserImportJobResponse {
6677
6677
  * <p>The job object that represents the user import job.</p>
6678
6678
  * @public
6679
6679
  */
6680
- UserImportJob?: UserImportJobType;
6680
+ UserImportJob?: UserImportJobType | undefined;
6681
6681
  }
6682
6682
  /**
6683
6683
  * <p>Represents the request to describe the user pool.</p>
@@ -6699,7 +6699,7 @@ export interface DescribeUserPoolResponse {
6699
6699
  * <p>The container of metadata returned by the server to describe the pool.</p>
6700
6700
  * @public
6701
6701
  */
6702
- UserPool?: UserPoolType;
6702
+ UserPool?: UserPoolType | undefined;
6703
6703
  }
6704
6704
  /**
6705
6705
  * <p>Represents the request to describe a user pool client.</p>
@@ -6727,7 +6727,7 @@ export interface DescribeUserPoolClientResponse {
6727
6727
  * <p>The user pool client from a server response to describe the user pool client.</p>
6728
6728
  * @public
6729
6729
  */
6730
- UserPoolClient?: UserPoolClientType;
6730
+ UserPoolClient?: UserPoolClientType | undefined;
6731
6731
  }
6732
6732
  /**
6733
6733
  * @public
@@ -6765,46 +6765,46 @@ export interface DomainDescriptionType {
6765
6765
  * <p>The user pool ID.</p>
6766
6766
  * @public
6767
6767
  */
6768
- UserPoolId?: string;
6768
+ UserPoolId?: string | undefined;
6769
6769
  /**
6770
6770
  * <p>The Amazon Web Services ID for the user pool owner.</p>
6771
6771
  * @public
6772
6772
  */
6773
- AWSAccountId?: string;
6773
+ AWSAccountId?: string | undefined;
6774
6774
  /**
6775
6775
  * <p>The domain string. For custom domains, this is the fully-qualified domain name, such
6776
6776
  * as <code>auth.example.com</code>. For Amazon Cognito prefix domains, this is the prefix alone,
6777
6777
  * such as <code>auth</code>.</p>
6778
6778
  * @public
6779
6779
  */
6780
- Domain?: string;
6780
+ Domain?: string | undefined;
6781
6781
  /**
6782
6782
  * <p>The Amazon S3 bucket where the static files for this domain are stored.</p>
6783
6783
  * @public
6784
6784
  */
6785
- S3Bucket?: string;
6785
+ S3Bucket?: string | undefined;
6786
6786
  /**
6787
6787
  * <p>The Amazon CloudFront endpoint that you use as the target of the alias that you set up with
6788
6788
  * your Domain Name Service (DNS) provider.</p>
6789
6789
  * @public
6790
6790
  */
6791
- CloudFrontDistribution?: string;
6791
+ CloudFrontDistribution?: string | undefined;
6792
6792
  /**
6793
6793
  * <p>The app version.</p>
6794
6794
  * @public
6795
6795
  */
6796
- Version?: string;
6796
+ Version?: string | undefined;
6797
6797
  /**
6798
6798
  * <p>The domain status.</p>
6799
6799
  * @public
6800
6800
  */
6801
- Status?: DomainStatusType;
6801
+ Status?: DomainStatusType | undefined;
6802
6802
  /**
6803
6803
  * <p>The configuration for a custom domain that hosts the sign-up and sign-in webpages for
6804
6804
  * your application.</p>
6805
6805
  * @public
6806
6806
  */
6807
- CustomDomainConfig?: CustomDomainConfigType;
6807
+ CustomDomainConfig?: CustomDomainConfigType | undefined;
6808
6808
  }
6809
6809
  /**
6810
6810
  * @public
@@ -6814,7 +6814,7 @@ export interface DescribeUserPoolDomainResponse {
6814
6814
  * <p>A domain description object containing information about the domain.</p>
6815
6815
  * @public
6816
6816
  */
6817
- DomainDescription?: DomainDescriptionType;
6817
+ DomainDescription?: DomainDescriptionType | undefined;
6818
6818
  }
6819
6819
  /**
6820
6820
  * <p>Represents the request to forget the device.</p>
@@ -6826,7 +6826,7 @@ export interface ForgetDeviceRequest {
6826
6826
  * forget.</p>
6827
6827
  * @public
6828
6828
  */
6829
- AccessToken?: string;
6829
+ AccessToken?: string | undefined;
6830
6830
  /**
6831
6831
  * <p>The device key.</p>
6832
6832
  * @public
@@ -6848,14 +6848,14 @@ export interface ForgotPasswordRequest {
6848
6848
  * user pool client and username plus the client ID in the message.</p>
6849
6849
  * @public
6850
6850
  */
6851
- SecretHash?: string;
6851
+ SecretHash?: string | undefined;
6852
6852
  /**
6853
6853
  * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
6854
6854
  * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
6855
6855
  * when it makes API requests.</p>
6856
6856
  * @public
6857
6857
  */
6858
- UserContextData?: UserContextDataType;
6858
+ UserContextData?: UserContextDataType | undefined;
6859
6859
  /**
6860
6860
  * <p>The username of the user that you want to query or modify. The value of this parameter
6861
6861
  * is typically your user's username, but it can be any of their alias attributes. If
@@ -6870,7 +6870,7 @@ export interface ForgotPasswordRequest {
6870
6870
  * <code>ForgotPassword</code> calls.</p>
6871
6871
  * @public
6872
6872
  */
6873
- AnalyticsMetadata?: AnalyticsMetadataType;
6873
+ AnalyticsMetadata?: AnalyticsMetadataType | undefined;
6874
6874
  /**
6875
6875
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
6876
6876
  * that this action triggers.</p>
@@ -6907,7 +6907,7 @@ export interface ForgotPasswordRequest {
6907
6907
  * </note>
6908
6908
  * @public
6909
6909
  */
6910
- ClientMetadata?: Record<string, string>;
6910
+ ClientMetadata?: Record<string, string> | undefined;
6911
6911
  }
6912
6912
  /**
6913
6913
  * <p>The delivery details for an email or SMS message that Amazon Cognito sent for authentication or
@@ -6919,17 +6919,17 @@ export interface CodeDeliveryDetailsType {
6919
6919
  * <p>The email address or phone number destination where Amazon Cognito sent the code.</p>
6920
6920
  * @public
6921
6921
  */
6922
- Destination?: string;
6922
+ Destination?: string | undefined;
6923
6923
  /**
6924
6924
  * <p>The method that Amazon Cognito used to send the code.</p>
6925
6925
  * @public
6926
6926
  */
6927
- DeliveryMedium?: DeliveryMediumType;
6927
+ DeliveryMedium?: DeliveryMediumType | undefined;
6928
6928
  /**
6929
6929
  * <p>The name of the attribute that Amazon Cognito verifies with the code.</p>
6930
6930
  * @public
6931
6931
  */
6932
- AttributeName?: string;
6932
+ AttributeName?: string | undefined;
6933
6933
  }
6934
6934
  /**
6935
6935
  * <p>The response from Amazon Cognito to a request to reset a password.</p>
@@ -6941,7 +6941,7 @@ export interface ForgotPasswordResponse {
6941
6941
  * password.</p>
6942
6942
  * @public
6943
6943
  */
6944
- CodeDeliveryDetails?: CodeDeliveryDetailsType;
6944
+ CodeDeliveryDetails?: CodeDeliveryDetailsType | undefined;
6945
6945
  }
6946
6946
  /**
6947
6947
  * <p>Represents the request to get the header information of the CSV file for the user
@@ -6965,12 +6965,12 @@ export interface GetCSVHeaderResponse {
6965
6965
  * <p>The user pool ID for the user pool that the users are to be imported into.</p>
6966
6966
  * @public
6967
6967
  */
6968
- UserPoolId?: string;
6968
+ UserPoolId?: string | undefined;
6969
6969
  /**
6970
6970
  * <p>The header information of the CSV file for the user import job.</p>
6971
6971
  * @public
6972
6972
  */
6973
- CSVHeader?: string[];
6973
+ CSVHeader?: string[] | undefined;
6974
6974
  }
6975
6975
  /**
6976
6976
  * <p>Represents the request to get the device.</p>
@@ -6987,7 +6987,7 @@ export interface GetDeviceRequest {
6987
6987
  * to request.</p>
6988
6988
  * @public
6989
6989
  */
6990
- AccessToken?: string;
6990
+ AccessToken?: string | undefined;
6991
6991
  }
6992
6992
  /**
6993
6993
  * <p>Gets the device response.</p>
@@ -7023,7 +7023,7 @@ export interface GetGroupResponse {
7023
7023
  * <p>The group object for the group.</p>
7024
7024
  * @public
7025
7025
  */
7026
- Group?: GroupType;
7026
+ Group?: GroupType | undefined;
7027
7027
  }
7028
7028
  /**
7029
7029
  * @public
@@ -7077,7 +7077,7 @@ export interface CloudWatchLogsConfigurationType {
7077
7077
  * logging from certain Amazon Web Services services</a>.</p>
7078
7078
  * @public
7079
7079
  */
7080
- LogGroupArn?: string;
7080
+ LogGroupArn?: string | undefined;
7081
7081
  }
7082
7082
  /**
7083
7083
  * @public
@@ -7102,7 +7102,7 @@ export interface FirehoseConfigurationType {
7102
7102
  * features log export.</p>
7103
7103
  * @public
7104
7104
  */
7105
- StreamArn?: string;
7105
+ StreamArn?: string | undefined;
7106
7106
  }
7107
7107
  /**
7108
7108
  * @public
@@ -7127,7 +7127,7 @@ export interface S3ConfigurationType {
7127
7127
  * log export.</p>
7128
7128
  * @public
7129
7129
  */
7130
- BucketArn?: string;
7130
+ BucketArn?: string | undefined;
7131
7131
  }
7132
7132
  /**
7133
7133
  * <p>The logging parameters of a user pool.</p>
@@ -7157,21 +7157,21 @@ export interface LogConfigurationType {
7157
7157
  * activity log export with advanced security features.</p>
7158
7158
  * @public
7159
7159
  */
7160
- CloudWatchLogsConfiguration?: CloudWatchLogsConfigurationType;
7160
+ CloudWatchLogsConfiguration?: CloudWatchLogsConfigurationType | undefined;
7161
7161
  /**
7162
7162
  * <p>The Amazon S3 bucket destination of user activity log export with advanced security
7163
7163
  * features. To activate this setting, <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">
7164
7164
  * advanced security features</a> must be active in your user pool.</p>
7165
7165
  * @public
7166
7166
  */
7167
- S3Configuration?: S3ConfigurationType;
7167
+ S3Configuration?: S3ConfigurationType | undefined;
7168
7168
  /**
7169
7169
  * <p>The Amazon Data Firehose stream destination of user activity log export with advanced security
7170
7170
  * features. To activate this setting, <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">
7171
7171
  * advanced security features</a> must be active in your user pool.</p>
7172
7172
  * @public
7173
7173
  */
7174
- FirehoseConfiguration?: FirehoseConfigurationType;
7174
+ FirehoseConfiguration?: FirehoseConfigurationType | undefined;
7175
7175
  }
7176
7176
  /**
7177
7177
  * <p>The logging parameters of a user pool returned in response to
@@ -7199,7 +7199,7 @@ export interface GetLogDeliveryConfigurationResponse {
7199
7199
  * <p>The logging configuration of the requested user pool.</p>
7200
7200
  * @public
7201
7201
  */
7202
- LogDeliveryConfiguration?: LogDeliveryConfigurationType;
7202
+ LogDeliveryConfiguration?: LogDeliveryConfigurationType | undefined;
7203
7203
  }
7204
7204
  /**
7205
7205
  * <p>Request to get a signing certificate from Amazon Cognito.</p>
@@ -7221,7 +7221,7 @@ export interface GetSigningCertificateResponse {
7221
7221
  * <p>The signing certificate.</p>
7222
7222
  * @public
7223
7223
  */
7224
- Certificate?: string;
7224
+ Certificate?: string | undefined;
7225
7225
  }
7226
7226
  /**
7227
7227
  * @public
@@ -7236,7 +7236,7 @@ export interface GetUICustomizationRequest {
7236
7236
  * <p>The client ID for the client app.</p>
7237
7237
  * @public
7238
7238
  */
7239
- ClientId?: string;
7239
+ ClientId?: string | undefined;
7240
7240
  }
7241
7241
  /**
7242
7242
  * <p>A container for the UI customization information for a user pool's built-in app
@@ -7248,39 +7248,39 @@ export interface UICustomizationType {
7248
7248
  * <p>The user pool ID for the user pool.</p>
7249
7249
  * @public
7250
7250
  */
7251
- UserPoolId?: string;
7251
+ UserPoolId?: string | undefined;
7252
7252
  /**
7253
7253
  * <p>The client ID for the client app.</p>
7254
7254
  * @public
7255
7255
  */
7256
- ClientId?: string;
7256
+ ClientId?: string | undefined;
7257
7257
  /**
7258
7258
  * <p>The logo image for the UI customization.</p>
7259
7259
  * @public
7260
7260
  */
7261
- ImageUrl?: string;
7261
+ ImageUrl?: string | undefined;
7262
7262
  /**
7263
7263
  * <p>The CSS values in the UI customization.</p>
7264
7264
  * @public
7265
7265
  */
7266
- CSS?: string;
7266
+ CSS?: string | undefined;
7267
7267
  /**
7268
7268
  * <p>The CSS version number.</p>
7269
7269
  * @public
7270
7270
  */
7271
- CSSVersion?: string;
7271
+ CSSVersion?: string | undefined;
7272
7272
  /**
7273
7273
  * <p>The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
7274
7274
  * human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
7275
7275
  * @public
7276
7276
  */
7277
- LastModifiedDate?: Date;
7277
+ LastModifiedDate?: Date | undefined;
7278
7278
  /**
7279
7279
  * <p>The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
7280
7280
  * human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
7281
7281
  * @public
7282
7282
  */
7283
- CreationDate?: Date;
7283
+ CreationDate?: Date | undefined;
7284
7284
  }
7285
7285
  /**
7286
7286
  * @public
@@ -7330,18 +7330,18 @@ export interface GetUserResponse {
7330
7330
  * instead.</p>
7331
7331
  * @public
7332
7332
  */
7333
- MFAOptions?: MFAOptionType[];
7333
+ MFAOptions?: MFAOptionType[] | undefined;
7334
7334
  /**
7335
7335
  * <p>The user's preferred MFA setting.</p>
7336
7336
  * @public
7337
7337
  */
7338
- PreferredMfaSetting?: string;
7338
+ PreferredMfaSetting?: string | undefined;
7339
7339
  /**
7340
7340
  * <p>The MFA options that are activated for the user. The possible values in this list are
7341
7341
  * <code>SMS_MFA</code>, <code>EMAIL_OTP</code>, and <code>SOFTWARE_TOKEN_MFA</code>.</p>
7342
7342
  * @public
7343
7343
  */
7344
- UserMFASettingList?: string[];
7344
+ UserMFASettingList?: string[] | undefined;
7345
7345
  }
7346
7346
  /**
7347
7347
  * <p>Represents the request to get user attribute verification.</p>
@@ -7394,7 +7394,7 @@ export interface GetUserAttributeVerificationCodeRequest {
7394
7394
  * </note>
7395
7395
  * @public
7396
7396
  */
7397
- ClientMetadata?: Record<string, string>;
7397
+ ClientMetadata?: Record<string, string> | undefined;
7398
7398
  }
7399
7399
  /**
7400
7400
  * <p>The verification code response returned by the server response to get the user
@@ -7407,7 +7407,7 @@ export interface GetUserAttributeVerificationCodeResponse {
7407
7407
  * user attribute verification code.</p>
7408
7408
  * @public
7409
7409
  */
7410
- CodeDeliveryDetails?: CodeDeliveryDetailsType;
7410
+ CodeDeliveryDetails?: CodeDeliveryDetailsType | undefined;
7411
7411
  }
7412
7412
  /**
7413
7413
  * @public
@@ -7433,13 +7433,13 @@ export interface EmailMfaConfigType {
7433
7433
  * Amazon Cognito sends messages in the default format.</p>
7434
7434
  * @public
7435
7435
  */
7436
- Message?: string;
7436
+ Message?: string | undefined;
7437
7437
  /**
7438
7438
  * <p>The subject of the email message that your user pool sends to users with an MFA
7439
7439
  * code.</p>
7440
7440
  * @public
7441
7441
  */
7442
- Subject?: string;
7442
+ Subject?: string | undefined;
7443
7443
  }
7444
7444
  /**
7445
7445
  * <p>Configures user pool SMS messages for multi-factor authentication (MFA). Sets the
@@ -7454,7 +7454,7 @@ export interface SmsMfaConfigType {
7454
7454
  * messages in the default format.</p>
7455
7455
  * @public
7456
7456
  */
7457
- SmsAuthenticationMessage?: string;
7457
+ SmsAuthenticationMessage?: string | undefined;
7458
7458
  /**
7459
7459
  * <p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an
7460
7460
  * SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To request Amazon SNS in
@@ -7462,7 +7462,7 @@ export interface SmsMfaConfigType {
7462
7462
  * you provide for your Amazon Web Services account.</p>
7463
7463
  * @public
7464
7464
  */
7465
- SmsConfiguration?: SmsConfigurationType;
7465
+ SmsConfiguration?: SmsConfigurationType | undefined;
7466
7466
  }
7467
7467
  /**
7468
7468
  * <p>Configures a user pool for time-based one-time password (TOTP) multi-factor
@@ -7474,7 +7474,7 @@ export interface SoftwareTokenMfaConfigType {
7474
7474
  * <p>Specifies whether software token MFA is activated.</p>
7475
7475
  * @public
7476
7476
  */
7477
- Enabled?: boolean;
7477
+ Enabled?: boolean | undefined;
7478
7478
  }
7479
7479
  /**
7480
7480
  * @public
@@ -7485,20 +7485,20 @@ export interface GetUserPoolMfaConfigResponse {
7485
7485
  * the SMS message sending configuration for Amazon SNS.</p>
7486
7486
  * @public
7487
7487
  */
7488
- SmsMfaConfiguration?: SmsMfaConfigType;
7488
+ SmsMfaConfiguration?: SmsMfaConfigType | undefined;
7489
7489
  /**
7490
7490
  * <p>Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes
7491
7491
  * TOTP enabled or disabled state.</p>
7492
7492
  * @public
7493
7493
  */
7494
- SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType;
7494
+ SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType | undefined;
7495
7495
  /**
7496
7496
  * <p>Shows user pool email message configuration for MFA. Includes the subject and body of
7497
7497
  * the email message template for MFA messages. To activate this setting, <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">
7498
7498
  * advanced security features</a> must be active in your user pool.</p>
7499
7499
  * @public
7500
7500
  */
7501
- EmailMfaConfiguration?: EmailMfaConfigType;
7501
+ EmailMfaConfiguration?: EmailMfaConfigType | undefined;
7502
7502
  /**
7503
7503
  * <p>The multi-factor authentication (MFA) configuration. Valid values include:</p>
7504
7504
  * <ul>
@@ -7518,7 +7518,7 @@ export interface GetUserPoolMfaConfigResponse {
7518
7518
  * </ul>
7519
7519
  * @public
7520
7520
  */
7521
- MfaConfiguration?: UserPoolMfaType;
7521
+ MfaConfiguration?: UserPoolMfaType | undefined;
7522
7522
  }
7523
7523
  /**
7524
7524
  * <p>Represents the request to sign out all devices.</p>
@@ -7625,7 +7625,7 @@ export interface InitiateAuthRequest {
7625
7625
  * <code>DEVICE_KEY</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>
7626
7626
  * @public
7627
7627
  */
7628
- AuthParameters?: Record<string, string>;
7628
+ AuthParameters?: Record<string, string> | undefined;
7629
7629
  /**
7630
7630
  * <p>A map of custom key-value pairs that you can provide as input for certain custom
7631
7631
  * workflows that this action triggers.</p>
@@ -7692,7 +7692,7 @@ export interface InitiateAuthRequest {
7692
7692
  * </note>
7693
7693
  * @public
7694
7694
  */
7695
- ClientMetadata?: Record<string, string>;
7695
+ ClientMetadata?: Record<string, string> | undefined;
7696
7696
  /**
7697
7697
  * <p>The app client ID.</p>
7698
7698
  * @public
@@ -7703,14 +7703,14 @@ export interface InitiateAuthRequest {
7703
7703
  * <code>InitiateAuth</code> calls.</p>
7704
7704
  * @public
7705
7705
  */
7706
- AnalyticsMetadata?: AnalyticsMetadataType;
7706
+ AnalyticsMetadata?: AnalyticsMetadataType | undefined;
7707
7707
  /**
7708
7708
  * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
7709
7709
  * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
7710
7710
  * when it makes API requests.</p>
7711
7711
  * @public
7712
7712
  */
7713
- UserContextData?: UserContextDataType;
7713
+ UserContextData?: UserContextDataType | undefined;
7714
7714
  }
7715
7715
  /**
7716
7716
  * <p>Initiates the authentication response.</p>
@@ -7795,7 +7795,7 @@ export interface InitiateAuthResponse {
7795
7795
  * </ul>
7796
7796
  * @public
7797
7797
  */
7798
- ChallengeName?: ChallengeNameType;
7798
+ ChallengeName?: ChallengeNameType | undefined;
7799
7799
  /**
7800
7800
  * <p>The session that should pass both ways in challenge-response calls to the service. If
7801
7801
  * the caller must pass another challenge, they return a session with other challenge
@@ -7803,7 +7803,7 @@ export interface InitiateAuthResponse {
7803
7803
  * <code>RespondToAuthChallenge</code> API call.</p>
7804
7804
  * @public
7805
7805
  */
7806
- Session?: string;
7806
+ Session?: string | undefined;
7807
7807
  /**
7808
7808
  * <p>The challenge parameters. These are returned in the <code>InitiateAuth</code> response
7809
7809
  * if you must pass another challenge. The responses in this parameter should be used to
@@ -7812,7 +7812,7 @@ export interface InitiateAuthResponse {
7812
7812
  * applicable).</p>
7813
7813
  * @public
7814
7814
  */
7815
- ChallengeParameters?: Record<string, string>;
7815
+ ChallengeParameters?: Record<string, string> | undefined;
7816
7816
  /**
7817
7817
  * <p>The result of the authentication response. This result is only returned if the caller
7818
7818
  * doesn't need to pass another challenge. If the caller does need to pass another
@@ -7820,7 +7820,7 @@ export interface InitiateAuthResponse {
7820
7820
  * <code>ChallengeParameters</code>, and <code>Session</code> are returned.</p>
7821
7821
  * @public
7822
7822
  */
7823
- AuthenticationResult?: AuthenticationResultType;
7823
+ AuthenticationResult?: AuthenticationResultType | undefined;
7824
7824
  }
7825
7825
  /**
7826
7826
  * <p>Represents the request to list the devices.</p>
@@ -7837,7 +7837,7 @@ export interface ListDevicesRequest {
7837
7837
  * <p>The limit of the device request.</p>
7838
7838
  * @public
7839
7839
  */
7840
- Limit?: number;
7840
+ Limit?: number | undefined;
7841
7841
  /**
7842
7842
  * <p>This API operation returns a limited number of results. The pagination token is
7843
7843
  * an identifier that you can present in an additional API request with the same parameters. When
@@ -7846,7 +7846,7 @@ export interface ListDevicesRequest {
7846
7846
  * through the full list of items.</p>
7847
7847
  * @public
7848
7848
  */
7849
- PaginationToken?: string;
7849
+ PaginationToken?: string | undefined;
7850
7850
  }
7851
7851
  /**
7852
7852
  * <p>Represents the response to list devices.</p>
@@ -7857,14 +7857,14 @@ export interface ListDevicesResponse {
7857
7857
  * <p>The devices returned in the list devices response.</p>
7858
7858
  * @public
7859
7859
  */
7860
- Devices?: DeviceType[];
7860
+ Devices?: DeviceType[] | undefined;
7861
7861
  /**
7862
7862
  * <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
7863
7863
  * you include a pagination token in your request, Amazon Cognito returns the next set of items in
7864
7864
  * the list. By use of this token, you can paginate through the full list of items.</p>
7865
7865
  * @public
7866
7866
  */
7867
- PaginationToken?: string;
7867
+ PaginationToken?: string | undefined;
7868
7868
  }
7869
7869
  /**
7870
7870
  * @public
@@ -7879,13 +7879,13 @@ export interface ListGroupsRequest {
7879
7879
  * <p>The limit of the request to list groups.</p>
7880
7880
  * @public
7881
7881
  */
7882
- Limit?: number;
7882
+ Limit?: number | undefined;
7883
7883
  /**
7884
7884
  * <p>An identifier that was returned from the previous call to this operation, which can be
7885
7885
  * used to return the next set of items in the list.</p>
7886
7886
  * @public
7887
7887
  */
7888
- NextToken?: string;
7888
+ NextToken?: string | undefined;
7889
7889
  }
7890
7890
  /**
7891
7891
  * @public
@@ -7895,13 +7895,13 @@ export interface ListGroupsResponse {
7895
7895
  * <p>The group objects for the groups.</p>
7896
7896
  * @public
7897
7897
  */
7898
- Groups?: GroupType[];
7898
+ Groups?: GroupType[] | undefined;
7899
7899
  /**
7900
7900
  * <p>An identifier that was returned from the previous call to this operation, which can be
7901
7901
  * used to return the next set of items in the list.</p>
7902
7902
  * @public
7903
7903
  */
7904
- NextToken?: string;
7904
+ NextToken?: string | undefined;
7905
7905
  }
7906
7906
  /**
7907
7907
  * @public
@@ -7916,12 +7916,12 @@ export interface ListIdentityProvidersRequest {
7916
7916
  * <p>The maximum number of IdPs to return.</p>
7917
7917
  * @public
7918
7918
  */
7919
- MaxResults?: number;
7919
+ MaxResults?: number | undefined;
7920
7920
  /**
7921
7921
  * <p>A pagination token.</p>
7922
7922
  * @public
7923
7923
  */
7924
- NextToken?: string;
7924
+ NextToken?: string | undefined;
7925
7925
  }
7926
7926
  /**
7927
7927
  * <p>A container for IdP details.</p>
@@ -7932,23 +7932,23 @@ export interface ProviderDescription {
7932
7932
  * <p>The IdP name.</p>
7933
7933
  * @public
7934
7934
  */
7935
- ProviderName?: string;
7935
+ ProviderName?: string | undefined;
7936
7936
  /**
7937
7937
  * <p>The IdP type.</p>
7938
7938
  * @public
7939
7939
  */
7940
- ProviderType?: IdentityProviderTypeType;
7940
+ ProviderType?: IdentityProviderTypeType | undefined;
7941
7941
  /**
7942
7942
  * <p>The date the provider was last modified.</p>
7943
7943
  * @public
7944
7944
  */
7945
- LastModifiedDate?: Date;
7945
+ LastModifiedDate?: Date | undefined;
7946
7946
  /**
7947
7947
  * <p>The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
7948
7948
  * human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
7949
7949
  * @public
7950
7950
  */
7951
- CreationDate?: Date;
7951
+ CreationDate?: Date | undefined;
7952
7952
  }
7953
7953
  /**
7954
7954
  * @public
@@ -7963,7 +7963,7 @@ export interface ListIdentityProvidersResponse {
7963
7963
  * <p>A pagination token.</p>
7964
7964
  * @public
7965
7965
  */
7966
- NextToken?: string;
7966
+ NextToken?: string | undefined;
7967
7967
  }
7968
7968
  /**
7969
7969
  * @public
@@ -7978,12 +7978,12 @@ export interface ListResourceServersRequest {
7978
7978
  * <p>The maximum number of resource servers to return.</p>
7979
7979
  * @public
7980
7980
  */
7981
- MaxResults?: number;
7981
+ MaxResults?: number | undefined;
7982
7982
  /**
7983
7983
  * <p>A pagination token.</p>
7984
7984
  * @public
7985
7985
  */
7986
- NextToken?: string;
7986
+ NextToken?: string | undefined;
7987
7987
  }
7988
7988
  /**
7989
7989
  * @public
@@ -7998,7 +7998,7 @@ export interface ListResourceServersResponse {
7998
7998
  * <p>A pagination token.</p>
7999
7999
  * @public
8000
8000
  */
8001
- NextToken?: string;
8001
+ NextToken?: string | undefined;
8002
8002
  }
8003
8003
  /**
8004
8004
  * @public
@@ -8018,7 +8018,7 @@ export interface ListTagsForResourceResponse {
8018
8018
  * <p>The tags that are assigned to the user pool.</p>
8019
8019
  * @public
8020
8020
  */
8021
- Tags?: Record<string, string>;
8021
+ Tags?: Record<string, string> | undefined;
8022
8022
  }
8023
8023
  /**
8024
8024
  * <p>Represents the request to list the user import jobs.</p>
@@ -8043,7 +8043,7 @@ export interface ListUserImportJobsRequest {
8043
8043
  * through the full list of items.</p>
8044
8044
  * @public
8045
8045
  */
8046
- PaginationToken?: string;
8046
+ PaginationToken?: string | undefined;
8047
8047
  }
8048
8048
  /**
8049
8049
  * <p>Represents the response from the server to the request to list the user import
@@ -8055,14 +8055,14 @@ export interface ListUserImportJobsResponse {
8055
8055
  * <p>The user import jobs.</p>
8056
8056
  * @public
8057
8057
  */
8058
- UserImportJobs?: UserImportJobType[];
8058
+ UserImportJobs?: UserImportJobType[] | undefined;
8059
8059
  /**
8060
8060
  * <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
8061
8061
  * you include a pagination token in your request, Amazon Cognito returns the next set of items in
8062
8062
  * the list. By use of this token, you can paginate through the full list of items.</p>
8063
8063
  * @public
8064
8064
  */
8065
- PaginationToken?: string;
8065
+ PaginationToken?: string | undefined;
8066
8066
  }
8067
8067
  /**
8068
8068
  * <p>Represents the request to list the user pool clients.</p>
@@ -8079,13 +8079,13 @@ export interface ListUserPoolClientsRequest {
8079
8079
  * pool clients.</p>
8080
8080
  * @public
8081
8081
  */
8082
- MaxResults?: number;
8082
+ MaxResults?: number | undefined;
8083
8083
  /**
8084
8084
  * <p>An identifier that was returned from the previous call to this operation, which can be
8085
8085
  * used to return the next set of items in the list.</p>
8086
8086
  * @public
8087
8087
  */
8088
- NextToken?: string;
8088
+ NextToken?: string | undefined;
8089
8089
  }
8090
8090
  /**
8091
8091
  * <p>The description of the user pool client.</p>
@@ -8096,18 +8096,18 @@ export interface UserPoolClientDescription {
8096
8096
  * <p>The ID of the client associated with the user pool.</p>
8097
8097
  * @public
8098
8098
  */
8099
- ClientId?: string;
8099
+ ClientId?: string | undefined;
8100
8100
  /**
8101
8101
  * <p>The user pool ID for the user pool where you want to describe the user pool
8102
8102
  * client.</p>
8103
8103
  * @public
8104
8104
  */
8105
- UserPoolId?: string;
8105
+ UserPoolId?: string | undefined;
8106
8106
  /**
8107
8107
  * <p>The client name from the user pool client description.</p>
8108
8108
  * @public
8109
8109
  */
8110
- ClientName?: string;
8110
+ ClientName?: string | undefined;
8111
8111
  }
8112
8112
  /**
8113
8113
  * <p>Represents the response from the server that lists user pool clients.</p>
@@ -8118,13 +8118,13 @@ export interface ListUserPoolClientsResponse {
8118
8118
  * <p>The user pool clients in the response that lists user pool clients.</p>
8119
8119
  * @public
8120
8120
  */
8121
- UserPoolClients?: UserPoolClientDescription[];
8121
+ UserPoolClients?: UserPoolClientDescription[] | undefined;
8122
8122
  /**
8123
8123
  * <p>An identifier that was returned from the previous call to this operation, which can be
8124
8124
  * used to return the next set of items in the list.</p>
8125
8125
  * @public
8126
8126
  */
8127
- NextToken?: string;
8127
+ NextToken?: string | undefined;
8128
8128
  }
8129
8129
  /**
8130
8130
  * <p>Represents the request to list user pools.</p>
@@ -8136,7 +8136,7 @@ export interface ListUserPoolsRequest {
8136
8136
  * used to return the next set of items in the list.</p>
8137
8137
  * @public
8138
8138
  */
8139
- NextToken?: string;
8139
+ NextToken?: string | undefined;
8140
8140
  /**
8141
8141
  * <p>The maximum number of results you want the request to return when listing the user
8142
8142
  * pools.</p>
@@ -8153,36 +8153,36 @@ export interface UserPoolDescriptionType {
8153
8153
  * <p>The ID in a user pool description.</p>
8154
8154
  * @public
8155
8155
  */
8156
- Id?: string;
8156
+ Id?: string | undefined;
8157
8157
  /**
8158
8158
  * <p>The name in a user pool description.</p>
8159
8159
  * @public
8160
8160
  */
8161
- Name?: string;
8161
+ Name?: string | undefined;
8162
8162
  /**
8163
8163
  * <p>The Lambda configuration information in a user pool description.</p>
8164
8164
  * @public
8165
8165
  */
8166
- LambdaConfig?: LambdaConfigType;
8166
+ LambdaConfig?: LambdaConfigType | undefined;
8167
8167
  /**
8168
8168
  * @deprecated
8169
8169
  *
8170
8170
  * <p>The user pool status in a user pool description.</p>
8171
8171
  * @public
8172
8172
  */
8173
- Status?: StatusType;
8173
+ Status?: StatusType | undefined;
8174
8174
  /**
8175
8175
  * <p>The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
8176
8176
  * human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
8177
8177
  * @public
8178
8178
  */
8179
- LastModifiedDate?: Date;
8179
+ LastModifiedDate?: Date | undefined;
8180
8180
  /**
8181
8181
  * <p>The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
8182
8182
  * human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
8183
8183
  * @public
8184
8184
  */
8185
- CreationDate?: Date;
8185
+ CreationDate?: Date | undefined;
8186
8186
  }
8187
8187
  /**
8188
8188
  * <p>Represents the response to list user pools.</p>
@@ -8193,13 +8193,13 @@ export interface ListUserPoolsResponse {
8193
8193
  * <p>The user pools from the response to list users.</p>
8194
8194
  * @public
8195
8195
  */
8196
- UserPools?: UserPoolDescriptionType[];
8196
+ UserPools?: UserPoolDescriptionType[] | undefined;
8197
8197
  /**
8198
8198
  * <p>An identifier that was returned from the previous call to this operation, which can be
8199
8199
  * used to return the next set of items in the list.</p>
8200
8200
  * @public
8201
8201
  */
8202
- NextToken?: string;
8202
+ NextToken?: string | undefined;
8203
8203
  }
8204
8204
  /**
8205
8205
  * <p>Represents the request to list users.</p>
@@ -8223,12 +8223,12 @@ export interface ListUsersRequest {
8223
8223
  * before an <code>AttributesToGet</code> parameter returns results.</p>
8224
8224
  * @public
8225
8225
  */
8226
- AttributesToGet?: string[];
8226
+ AttributesToGet?: string[] | undefined;
8227
8227
  /**
8228
8228
  * <p>Maximum number of users to be returned.</p>
8229
8229
  * @public
8230
8230
  */
8231
- Limit?: number;
8231
+ Limit?: number | undefined;
8232
8232
  /**
8233
8233
  * <p>This API operation returns a limited number of results. The pagination token is
8234
8234
  * an identifier that you can present in an additional API request with the same parameters. When
@@ -8237,7 +8237,7 @@ export interface ListUsersRequest {
8237
8237
  * through the full list of items.</p>
8238
8238
  * @public
8239
8239
  */
8240
- PaginationToken?: string;
8240
+ PaginationToken?: string | undefined;
8241
8241
  /**
8242
8242
  * <p>A filter string of the form "<i>AttributeName</i>
8243
8243
  * <i>Filter-Type</i> "<i>AttributeValue</i>"". Quotation marks
@@ -8332,7 +8332,7 @@ export interface ListUsersRequest {
8332
8332
  * Guide</i>.</p>
8333
8333
  * @public
8334
8334
  */
8335
- Filter?: string;
8335
+ Filter?: string | undefined;
8336
8336
  }
8337
8337
  /**
8338
8338
  * <p>The response from the request to list users.</p>
@@ -8351,14 +8351,14 @@ export interface ListUsersResponse {
8351
8351
  * </note>
8352
8352
  * @public
8353
8353
  */
8354
- Users?: UserType[];
8354
+ Users?: UserType[] | undefined;
8355
8355
  /**
8356
8356
  * <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
8357
8357
  * you include a pagination token in your request, Amazon Cognito returns the next set of items in
8358
8358
  * the list. By use of this token, you can paginate through the full list of items.</p>
8359
8359
  * @public
8360
8360
  */
8361
- PaginationToken?: string;
8361
+ PaginationToken?: string | undefined;
8362
8362
  }
8363
8363
  /**
8364
8364
  * @public
@@ -8378,13 +8378,13 @@ export interface ListUsersInGroupRequest {
8378
8378
  * <p>The maximum number of users that you want to retrieve before pagination.</p>
8379
8379
  * @public
8380
8380
  */
8381
- Limit?: number;
8381
+ Limit?: number | undefined;
8382
8382
  /**
8383
8383
  * <p>An identifier that was returned from the previous call to this operation, which can be
8384
8384
  * used to return the next set of items in the list.</p>
8385
8385
  * @public
8386
8386
  */
8387
- NextToken?: string;
8387
+ NextToken?: string | undefined;
8388
8388
  }
8389
8389
  /**
8390
8390
  * @public
@@ -8394,13 +8394,13 @@ export interface ListUsersInGroupResponse {
8394
8394
  * <p>A list of users in the group, and their attributes.</p>
8395
8395
  * @public
8396
8396
  */
8397
- Users?: UserType[];
8397
+ Users?: UserType[] | undefined;
8398
8398
  /**
8399
8399
  * <p>An identifier that you can use in a later request to return the next set of items in
8400
8400
  * the list.</p>
8401
8401
  * @public
8402
8402
  */
8403
- NextToken?: string;
8403
+ NextToken?: string | undefined;
8404
8404
  }
8405
8405
  /**
8406
8406
  * <p>Represents the request to resend the confirmation code.</p>
@@ -8417,14 +8417,14 @@ export interface ResendConfirmationCodeRequest {
8417
8417
  * user pool client and username plus the client ID in the message.</p>
8418
8418
  * @public
8419
8419
  */
8420
- SecretHash?: string;
8420
+ SecretHash?: string | undefined;
8421
8421
  /**
8422
8422
  * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
8423
8423
  * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
8424
8424
  * when it makes API requests.</p>
8425
8425
  * @public
8426
8426
  */
8427
- UserContextData?: UserContextDataType;
8427
+ UserContextData?: UserContextDataType | undefined;
8428
8428
  /**
8429
8429
  * <p>The username of the user that you want to query or modify. The value of this parameter
8430
8430
  * is typically your user's username, but it can be any of their alias attributes. If
@@ -8439,7 +8439,7 @@ export interface ResendConfirmationCodeRequest {
8439
8439
  * <code>ResendConfirmationCode</code> calls.</p>
8440
8440
  * @public
8441
8441
  */
8442
- AnalyticsMetadata?: AnalyticsMetadataType;
8442
+ AnalyticsMetadata?: AnalyticsMetadataType | undefined;
8443
8443
  /**
8444
8444
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
8445
8445
  * that this action triggers.</p>
@@ -8474,7 +8474,7 @@ export interface ResendConfirmationCodeRequest {
8474
8474
  * </note>
8475
8475
  * @public
8476
8476
  */
8477
- ClientMetadata?: Record<string, string>;
8477
+ ClientMetadata?: Record<string, string> | undefined;
8478
8478
  }
8479
8479
  /**
8480
8480
  * <p>The response from the server when Amazon Cognito makes the request to resend a confirmation
@@ -8487,7 +8487,7 @@ export interface ResendConfirmationCodeResponse {
8487
8487
  * the confirmation code.</p>
8488
8488
  * @public
8489
8489
  */
8490
- CodeDeliveryDetails?: CodeDeliveryDetailsType;
8490
+ CodeDeliveryDetails?: CodeDeliveryDetailsType | undefined;
8491
8491
  }
8492
8492
  /**
8493
8493
  * <p>The request to respond to an authentication challenge.</p>
@@ -8514,7 +8514,7 @@ export interface RespondToAuthChallengeRequest {
8514
8514
  * <code>RespondToAuthChallenge</code> API call.</p>
8515
8515
  * @public
8516
8516
  */
8517
- Session?: string;
8517
+ Session?: string | undefined;
8518
8518
  /**
8519
8519
  * <p>The responses to the challenge that you received in the previous request. Each
8520
8520
  * challenge has its own required response parameters. The following examples are partial
@@ -8625,20 +8625,20 @@ export interface RespondToAuthChallengeRequest {
8625
8625
  * <code>DEVICE_KEY</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>
8626
8626
  * @public
8627
8627
  */
8628
- ChallengeResponses?: Record<string, string>;
8628
+ ChallengeResponses?: Record<string, string> | undefined;
8629
8629
  /**
8630
8630
  * <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for
8631
8631
  * <code>RespondToAuthChallenge</code> calls.</p>
8632
8632
  * @public
8633
8633
  */
8634
- AnalyticsMetadata?: AnalyticsMetadataType;
8634
+ AnalyticsMetadata?: AnalyticsMetadataType | undefined;
8635
8635
  /**
8636
8636
  * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
8637
8637
  * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
8638
8638
  * when it makes API requests.</p>
8639
8639
  * @public
8640
8640
  */
8641
- UserContextData?: UserContextDataType;
8641
+ UserContextData?: UserContextDataType | undefined;
8642
8642
  /**
8643
8643
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
8644
8644
  * that this action triggers.</p>
@@ -8677,7 +8677,7 @@ export interface RespondToAuthChallengeRequest {
8677
8677
  * </note>
8678
8678
  * @public
8679
8679
  */
8680
- ClientMetadata?: Record<string, string>;
8680
+ ClientMetadata?: Record<string, string> | undefined;
8681
8681
  }
8682
8682
  /**
8683
8683
  * @internal