@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.
- package/dist-types/models/models_0.d.ts +480 -480
- package/dist-types/models/models_1.d.ts +89 -89
- package/dist-types/ts3.4/models/models_0.d.ts +488 -480
- package/dist-types/ts3.4/models/models_1.d.ts +93 -89
- package/package.json +35 -35
|
@@ -10,7 +10,7 @@ export interface RespondToAuthChallengeResponse {
|
|
|
10
10
|
* <p>The challenge name. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a>.</p>
|
|
11
11
|
* @public
|
|
12
12
|
*/
|
|
13
|
-
ChallengeName?: ChallengeNameType;
|
|
13
|
+
ChallengeName?: ChallengeNameType | undefined;
|
|
14
14
|
/**
|
|
15
15
|
* <p>The session that should be passed both ways in challenge-response calls to the
|
|
16
16
|
* service. If the caller must pass another challenge, they return a session with other
|
|
@@ -18,18 +18,18 @@ export interface RespondToAuthChallengeResponse {
|
|
|
18
18
|
* <code>RespondToAuthChallenge</code> API call.</p>
|
|
19
19
|
* @public
|
|
20
20
|
*/
|
|
21
|
-
Session?: string;
|
|
21
|
+
Session?: string | undefined;
|
|
22
22
|
/**
|
|
23
23
|
* <p>The challenge parameters. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a>.</p>
|
|
24
24
|
* @public
|
|
25
25
|
*/
|
|
26
|
-
ChallengeParameters?: Record<string, string
|
|
26
|
+
ChallengeParameters?: Record<string, string> | undefined;
|
|
27
27
|
/**
|
|
28
28
|
* <p>The result returned by the server in response to the request to respond to the
|
|
29
29
|
* authentication challenge.</p>
|
|
30
30
|
* @public
|
|
31
31
|
*/
|
|
32
|
-
AuthenticationResult?: AuthenticationResultType;
|
|
32
|
+
AuthenticationResult?: AuthenticationResultType | undefined;
|
|
33
33
|
}
|
|
34
34
|
/**
|
|
35
35
|
* @public
|
|
@@ -50,7 +50,7 @@ export interface RevokeTokenRequest {
|
|
|
50
50
|
* secret.</p>
|
|
51
51
|
* @public
|
|
52
52
|
*/
|
|
53
|
-
ClientSecret?: string;
|
|
53
|
+
ClientSecret?: string | undefined;
|
|
54
54
|
}
|
|
55
55
|
/**
|
|
56
56
|
* @public
|
|
@@ -119,7 +119,7 @@ export interface SetLogDeliveryConfigurationResponse {
|
|
|
119
119
|
* pool.</p>
|
|
120
120
|
* @public
|
|
121
121
|
*/
|
|
122
|
-
LogDeliveryConfiguration?: LogDeliveryConfigurationType;
|
|
122
|
+
LogDeliveryConfiguration?: LogDeliveryConfigurationType | undefined;
|
|
123
123
|
}
|
|
124
124
|
/**
|
|
125
125
|
* @public
|
|
@@ -139,22 +139,22 @@ export interface SetRiskConfigurationRequest {
|
|
|
139
139
|
* client is used instead.</p>
|
|
140
140
|
* @public
|
|
141
141
|
*/
|
|
142
|
-
ClientId?: string;
|
|
142
|
+
ClientId?: string | undefined;
|
|
143
143
|
/**
|
|
144
144
|
* <p>The compromised credentials risk configuration.</p>
|
|
145
145
|
* @public
|
|
146
146
|
*/
|
|
147
|
-
CompromisedCredentialsRiskConfiguration?: CompromisedCredentialsRiskConfigurationType;
|
|
147
|
+
CompromisedCredentialsRiskConfiguration?: CompromisedCredentialsRiskConfigurationType | undefined;
|
|
148
148
|
/**
|
|
149
149
|
* <p>The account takeover risk configuration.</p>
|
|
150
150
|
* @public
|
|
151
151
|
*/
|
|
152
|
-
AccountTakeoverRiskConfiguration?: AccountTakeoverRiskConfigurationType;
|
|
152
|
+
AccountTakeoverRiskConfiguration?: AccountTakeoverRiskConfigurationType | undefined;
|
|
153
153
|
/**
|
|
154
154
|
* <p>The configuration to override the risk decision.</p>
|
|
155
155
|
* @public
|
|
156
156
|
*/
|
|
157
|
-
RiskExceptionConfiguration?: RiskExceptionConfigurationType;
|
|
157
|
+
RiskExceptionConfiguration?: RiskExceptionConfigurationType | undefined;
|
|
158
158
|
}
|
|
159
159
|
/**
|
|
160
160
|
* @public
|
|
@@ -179,17 +179,17 @@ export interface SetUICustomizationRequest {
|
|
|
179
179
|
* <p>The client ID for the client app.</p>
|
|
180
180
|
* @public
|
|
181
181
|
*/
|
|
182
|
-
ClientId?: string;
|
|
182
|
+
ClientId?: string | undefined;
|
|
183
183
|
/**
|
|
184
184
|
* <p>The CSS values in the UI customization.</p>
|
|
185
185
|
* @public
|
|
186
186
|
*/
|
|
187
|
-
CSS?: string;
|
|
187
|
+
CSS?: string | undefined;
|
|
188
188
|
/**
|
|
189
189
|
* <p>The uploaded logo image for the UI customization.</p>
|
|
190
190
|
* @public
|
|
191
191
|
*/
|
|
192
|
-
ImageFile?: Uint8Array;
|
|
192
|
+
ImageFile?: Uint8Array | undefined;
|
|
193
193
|
}
|
|
194
194
|
/**
|
|
195
195
|
* @public
|
|
@@ -210,21 +210,21 @@ export interface SetUserMFAPreferenceRequest {
|
|
|
210
210
|
* the preferred MFA method when multiple methods are available.</p>
|
|
211
211
|
* @public
|
|
212
212
|
*/
|
|
213
|
-
SMSMfaSettings?: SMSMfaSettingsType;
|
|
213
|
+
SMSMfaSettings?: SMSMfaSettingsType | undefined;
|
|
214
214
|
/**
|
|
215
215
|
* <p>User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates
|
|
216
216
|
* TOTP MFA and sets it as the preferred MFA method when multiple methods are
|
|
217
217
|
* available.</p>
|
|
218
218
|
* @public
|
|
219
219
|
*/
|
|
220
|
-
SoftwareTokenMfaSettings?: SoftwareTokenMfaSettingsType;
|
|
220
|
+
SoftwareTokenMfaSettings?: SoftwareTokenMfaSettingsType | undefined;
|
|
221
221
|
/**
|
|
222
222
|
* <p>User preferences for email message MFA. Activates or deactivates email MFA and sets it
|
|
223
223
|
* 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">
|
|
224
224
|
* advanced security features</a> must be active in your user pool.</p>
|
|
225
225
|
* @public
|
|
226
226
|
*/
|
|
227
|
-
EmailMfaSettings?: EmailMfaSettingsType;
|
|
227
|
+
EmailMfaSettings?: EmailMfaSettingsType | undefined;
|
|
228
228
|
/**
|
|
229
229
|
* <p>A valid access token that Amazon Cognito issued to the user whose MFA preference you want to
|
|
230
230
|
* set.</p>
|
|
@@ -251,20 +251,20 @@ export interface SetUserPoolMfaConfigRequest {
|
|
|
251
251
|
* message sending configuration for Amazon SNS.</p>
|
|
252
252
|
* @public
|
|
253
253
|
*/
|
|
254
|
-
SmsMfaConfiguration?: SmsMfaConfigType;
|
|
254
|
+
SmsMfaConfiguration?: SmsMfaConfigType | undefined;
|
|
255
255
|
/**
|
|
256
256
|
* <p>Configures a user pool for time-based one-time password (TOTP) MFA. Enables or
|
|
257
257
|
* disables TOTP.</p>
|
|
258
258
|
* @public
|
|
259
259
|
*/
|
|
260
|
-
SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType;
|
|
260
|
+
SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType | undefined;
|
|
261
261
|
/**
|
|
262
262
|
* <p>Configures user pool email messages for MFA. Sets the subject and body of the email
|
|
263
263
|
* 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">
|
|
264
264
|
* advanced security features</a> must be active in your user pool.</p>
|
|
265
265
|
* @public
|
|
266
266
|
*/
|
|
267
|
-
EmailMfaConfiguration?: EmailMfaConfigType;
|
|
267
|
+
EmailMfaConfiguration?: EmailMfaConfigType | undefined;
|
|
268
268
|
/**
|
|
269
269
|
* <p>The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who
|
|
270
270
|
* have set up an MFA factor can sign in. To learn more, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html">Adding Multi-Factor
|
|
@@ -286,7 +286,7 @@ export interface SetUserPoolMfaConfigRequest {
|
|
|
286
286
|
* </ul>
|
|
287
287
|
* @public
|
|
288
288
|
*/
|
|
289
|
-
MfaConfiguration?: UserPoolMfaType;
|
|
289
|
+
MfaConfiguration?: UserPoolMfaType | undefined;
|
|
290
290
|
}
|
|
291
291
|
/**
|
|
292
292
|
* @public
|
|
@@ -297,20 +297,20 @@ export interface SetUserPoolMfaConfigResponse {
|
|
|
297
297
|
* the SMS message sending configuration for Amazon SNS.</p>
|
|
298
298
|
* @public
|
|
299
299
|
*/
|
|
300
|
-
SmsMfaConfiguration?: SmsMfaConfigType;
|
|
300
|
+
SmsMfaConfiguration?: SmsMfaConfigType | undefined;
|
|
301
301
|
/**
|
|
302
302
|
* <p>Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes
|
|
303
303
|
* TOTP enabled or disabled state.</p>
|
|
304
304
|
* @public
|
|
305
305
|
*/
|
|
306
|
-
SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType;
|
|
306
|
+
SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType | undefined;
|
|
307
307
|
/**
|
|
308
308
|
* <p>Shows user pool email message configuration for MFA. Includes the subject and body of
|
|
309
309
|
* 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">
|
|
310
310
|
* advanced security features</a> must be active in your user pool.</p>
|
|
311
311
|
* @public
|
|
312
312
|
*/
|
|
313
|
-
EmailMfaConfiguration?: EmailMfaConfigType;
|
|
313
|
+
EmailMfaConfiguration?: EmailMfaConfigType | undefined;
|
|
314
314
|
/**
|
|
315
315
|
* <p>The MFA configuration. Valid values include:</p>
|
|
316
316
|
* <ul>
|
|
@@ -330,7 +330,7 @@ export interface SetUserPoolMfaConfigResponse {
|
|
|
330
330
|
* </ul>
|
|
331
331
|
* @public
|
|
332
332
|
*/
|
|
333
|
-
MfaConfiguration?: UserPoolMfaType;
|
|
333
|
+
MfaConfiguration?: UserPoolMfaType | undefined;
|
|
334
334
|
}
|
|
335
335
|
/**
|
|
336
336
|
* <p>Represents the request to set user settings.</p>
|
|
@@ -371,7 +371,7 @@ export interface SignUpRequest {
|
|
|
371
371
|
* user pool client and username plus the client ID in the message.</p>
|
|
372
372
|
* @public
|
|
373
373
|
*/
|
|
374
|
-
SecretHash?: string;
|
|
374
|
+
SecretHash?: string | undefined;
|
|
375
375
|
/**
|
|
376
376
|
* <p>The username of the user that you want to sign up. The value of this parameter is
|
|
377
377
|
* typically a username, but can be any alias attribute in your user pool.</p>
|
|
@@ -389,7 +389,7 @@ export interface SignUpRequest {
|
|
|
389
389
|
* attribute name.</p>
|
|
390
390
|
* @public
|
|
391
391
|
*/
|
|
392
|
-
UserAttributes?: AttributeType[];
|
|
392
|
+
UserAttributes?: AttributeType[] | undefined;
|
|
393
393
|
/**
|
|
394
394
|
* <p>Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda
|
|
395
395
|
* trigger. This set of key-value pairs are for custom validation of information that you
|
|
@@ -402,20 +402,20 @@ export interface SignUpRequest {
|
|
|
402
402
|
* <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>
|
|
403
403
|
* @public
|
|
404
404
|
*/
|
|
405
|
-
ValidationData?: AttributeType[];
|
|
405
|
+
ValidationData?: AttributeType[] | undefined;
|
|
406
406
|
/**
|
|
407
407
|
* <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for
|
|
408
408
|
* <code>SignUp</code> calls.</p>
|
|
409
409
|
* @public
|
|
410
410
|
*/
|
|
411
|
-
AnalyticsMetadata?: AnalyticsMetadataType;
|
|
411
|
+
AnalyticsMetadata?: AnalyticsMetadataType | undefined;
|
|
412
412
|
/**
|
|
413
413
|
* <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
|
|
414
414
|
* security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
|
|
415
415
|
* when it makes API requests.</p>
|
|
416
416
|
* @public
|
|
417
417
|
*/
|
|
418
|
-
UserContextData?: UserContextDataType;
|
|
418
|
+
UserContextData?: UserContextDataType | undefined;
|
|
419
419
|
/**
|
|
420
420
|
* <p>A map of custom key-value pairs that you can provide as input for any custom workflows
|
|
421
421
|
* that this action triggers.</p>
|
|
@@ -451,7 +451,7 @@ export interface SignUpRequest {
|
|
|
451
451
|
* </note>
|
|
452
452
|
* @public
|
|
453
453
|
*/
|
|
454
|
-
ClientMetadata?: Record<string, string
|
|
454
|
+
ClientMetadata?: Record<string, string> | undefined;
|
|
455
455
|
}
|
|
456
456
|
/**
|
|
457
457
|
* <p>The response from the server for a registration request.</p>
|
|
@@ -469,7 +469,7 @@ export interface SignUpResponse {
|
|
|
469
469
|
* request.</p>
|
|
470
470
|
* @public
|
|
471
471
|
*/
|
|
472
|
-
CodeDeliveryDetails?: CodeDeliveryDetailsType;
|
|
472
|
+
CodeDeliveryDetails?: CodeDeliveryDetailsType | undefined;
|
|
473
473
|
/**
|
|
474
474
|
* <p>The 128-bit ID of the authenticated user. This isn't the same as
|
|
475
475
|
* <code>username</code>.</p>
|
|
@@ -503,7 +503,7 @@ export interface StartUserImportJobResponse {
|
|
|
503
503
|
* <p>The job object that represents the user import job.</p>
|
|
504
504
|
* @public
|
|
505
505
|
*/
|
|
506
|
-
UserImportJob?: UserImportJobType;
|
|
506
|
+
UserImportJob?: UserImportJobType | undefined;
|
|
507
507
|
}
|
|
508
508
|
/**
|
|
509
509
|
* <p>Represents the request to stop the user import job.</p>
|
|
@@ -531,7 +531,7 @@ export interface StopUserImportJobResponse {
|
|
|
531
531
|
* <p>The job object that represents the user import job.</p>
|
|
532
532
|
* @public
|
|
533
533
|
*/
|
|
534
|
-
UserImportJob?: UserImportJobType;
|
|
534
|
+
UserImportJob?: UserImportJobType | undefined;
|
|
535
535
|
}
|
|
536
536
|
/**
|
|
537
537
|
* @public
|
|
@@ -636,7 +636,7 @@ export interface UpdateDeviceStatusRequest {
|
|
|
636
636
|
* <p>The status of whether a device is remembered.</p>
|
|
637
637
|
* @public
|
|
638
638
|
*/
|
|
639
|
-
DeviceRememberedStatus?: DeviceRememberedStatusType;
|
|
639
|
+
DeviceRememberedStatus?: DeviceRememberedStatusType | undefined;
|
|
640
640
|
}
|
|
641
641
|
/**
|
|
642
642
|
* <p>The response to the request to update the device status.</p>
|
|
@@ -662,20 +662,20 @@ export interface UpdateGroupRequest {
|
|
|
662
662
|
* <p>A string containing the new description of the group.</p>
|
|
663
663
|
* @public
|
|
664
664
|
*/
|
|
665
|
-
Description?: string;
|
|
665
|
+
Description?: string | undefined;
|
|
666
666
|
/**
|
|
667
667
|
* <p>The new role Amazon Resource Name (ARN) for the group. This is used for setting the
|
|
668
668
|
* <code>cognito:roles</code> and <code>cognito:preferred_role</code> claims in the
|
|
669
669
|
* token.</p>
|
|
670
670
|
* @public
|
|
671
671
|
*/
|
|
672
|
-
RoleArn?: string;
|
|
672
|
+
RoleArn?: string | undefined;
|
|
673
673
|
/**
|
|
674
674
|
* <p>The new precedence value for the group. For more information about this parameter, see
|
|
675
675
|
* <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateGroup.html">CreateGroup</a>.</p>
|
|
676
676
|
* @public
|
|
677
677
|
*/
|
|
678
|
-
Precedence?: number;
|
|
678
|
+
Precedence?: number | undefined;
|
|
679
679
|
}
|
|
680
680
|
/**
|
|
681
681
|
* @public
|
|
@@ -685,7 +685,7 @@ export interface UpdateGroupResponse {
|
|
|
685
685
|
* <p>The group object for the group.</p>
|
|
686
686
|
* @public
|
|
687
687
|
*/
|
|
688
|
-
Group?: GroupType;
|
|
688
|
+
Group?: GroupType | undefined;
|
|
689
689
|
}
|
|
690
690
|
/**
|
|
691
691
|
* @public
|
|
@@ -823,17 +823,17 @@ export interface UpdateIdentityProviderRequest {
|
|
|
823
823
|
* </dl>
|
|
824
824
|
* @public
|
|
825
825
|
*/
|
|
826
|
-
ProviderDetails?: Record<string, string
|
|
826
|
+
ProviderDetails?: Record<string, string> | undefined;
|
|
827
827
|
/**
|
|
828
828
|
* <p>The IdP attribute mapping to be changed.</p>
|
|
829
829
|
* @public
|
|
830
830
|
*/
|
|
831
|
-
AttributeMapping?: Record<string, string
|
|
831
|
+
AttributeMapping?: Record<string, string> | undefined;
|
|
832
832
|
/**
|
|
833
833
|
* <p>A list of IdP identifiers.</p>
|
|
834
834
|
* @public
|
|
835
835
|
*/
|
|
836
|
-
IdpIdentifiers?: string[];
|
|
836
|
+
IdpIdentifiers?: string[] | undefined;
|
|
837
837
|
}
|
|
838
838
|
/**
|
|
839
839
|
* @public
|
|
@@ -873,7 +873,7 @@ export interface UpdateResourceServerRequest {
|
|
|
873
873
|
* <p>The scope values to be set for the resource server.</p>
|
|
874
874
|
* @public
|
|
875
875
|
*/
|
|
876
|
-
Scopes?: ResourceServerScopeType[];
|
|
876
|
+
Scopes?: ResourceServerScopeType[] | undefined;
|
|
877
877
|
}
|
|
878
878
|
/**
|
|
879
879
|
* @public
|
|
@@ -942,7 +942,7 @@ export interface UpdateUserAttributesRequest {
|
|
|
942
942
|
* </note>
|
|
943
943
|
* @public
|
|
944
944
|
*/
|
|
945
|
-
ClientMetadata?: Record<string, string
|
|
945
|
+
ClientMetadata?: Record<string, string> | undefined;
|
|
946
946
|
}
|
|
947
947
|
/**
|
|
948
948
|
* <p>Represents the response from the server for the request to update user
|
|
@@ -955,7 +955,7 @@ export interface UpdateUserAttributesResponse {
|
|
|
955
955
|
* attributes.</p>
|
|
956
956
|
* @public
|
|
957
957
|
*/
|
|
958
|
-
CodeDeliveryDetailsList?: CodeDeliveryDetailsType[];
|
|
958
|
+
CodeDeliveryDetailsList?: CodeDeliveryDetailsType[] | undefined;
|
|
959
959
|
}
|
|
960
960
|
/**
|
|
961
961
|
* <p>Represents the request to update the user pool.</p>
|
|
@@ -971,7 +971,7 @@ export interface UpdateUserPoolRequest {
|
|
|
971
971
|
* <p>A container with the policies you want to update in a user pool.</p>
|
|
972
972
|
* @public
|
|
973
973
|
*/
|
|
974
|
-
Policies?: UserPoolPolicyType;
|
|
974
|
+
Policies?: UserPoolPolicyType | undefined;
|
|
975
975
|
/**
|
|
976
976
|
* <p>When active, <code>DeletionProtection</code> prevents accidental deletion of your user
|
|
977
977
|
* pool. Before you can delete a user pool that you have protected against deletion, you
|
|
@@ -982,43 +982,43 @@ export interface UpdateUserPoolRequest {
|
|
|
982
982
|
* <code>UpdateUserPool</code> API request.</p>
|
|
983
983
|
* @public
|
|
984
984
|
*/
|
|
985
|
-
DeletionProtection?: DeletionProtectionType;
|
|
985
|
+
DeletionProtection?: DeletionProtectionType | undefined;
|
|
986
986
|
/**
|
|
987
987
|
* <p>The Lambda configuration information from the request to update the user pool.</p>
|
|
988
988
|
* @public
|
|
989
989
|
*/
|
|
990
|
-
LambdaConfig?: LambdaConfigType;
|
|
990
|
+
LambdaConfig?: LambdaConfigType | undefined;
|
|
991
991
|
/**
|
|
992
992
|
* <p>The attributes that are automatically verified when Amazon Cognito requests to update user
|
|
993
993
|
* pools.</p>
|
|
994
994
|
* @public
|
|
995
995
|
*/
|
|
996
|
-
AutoVerifiedAttributes?: VerifiedAttributeType[];
|
|
996
|
+
AutoVerifiedAttributes?: VerifiedAttributeType[] | undefined;
|
|
997
997
|
/**
|
|
998
998
|
* <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>
|
|
999
999
|
* @public
|
|
1000
1000
|
*/
|
|
1001
|
-
SmsVerificationMessage?: string;
|
|
1001
|
+
SmsVerificationMessage?: string | undefined;
|
|
1002
1002
|
/**
|
|
1003
1003
|
* <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>
|
|
1004
1004
|
* @public
|
|
1005
1005
|
*/
|
|
1006
|
-
EmailVerificationMessage?: string;
|
|
1006
|
+
EmailVerificationMessage?: string | undefined;
|
|
1007
1007
|
/**
|
|
1008
1008
|
* <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>
|
|
1009
1009
|
* @public
|
|
1010
1010
|
*/
|
|
1011
|
-
EmailVerificationSubject?: string;
|
|
1011
|
+
EmailVerificationSubject?: string | undefined;
|
|
1012
1012
|
/**
|
|
1013
1013
|
* <p>The template for verification messages.</p>
|
|
1014
1014
|
* @public
|
|
1015
1015
|
*/
|
|
1016
|
-
VerificationMessageTemplate?: VerificationMessageTemplateType;
|
|
1016
|
+
VerificationMessageTemplate?: VerificationMessageTemplateType | undefined;
|
|
1017
1017
|
/**
|
|
1018
1018
|
* <p>The contents of the SMS authentication message.</p>
|
|
1019
1019
|
* @public
|
|
1020
1020
|
*/
|
|
1021
|
-
SmsAuthenticationMessage?: string;
|
|
1021
|
+
SmsAuthenticationMessage?: string | undefined;
|
|
1022
1022
|
/**
|
|
1023
1023
|
* <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>,
|
|
1024
1024
|
* 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
|
|
@@ -1026,7 +1026,7 @@ export interface UpdateUserPoolRequest {
|
|
|
1026
1026
|
* Verifying updates to email addresses and phone numbers</a>.</p>
|
|
1027
1027
|
* @public
|
|
1028
1028
|
*/
|
|
1029
|
-
UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType;
|
|
1029
|
+
UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType | undefined;
|
|
1030
1030
|
/**
|
|
1031
1031
|
* <p>Possible values include:</p>
|
|
1032
1032
|
* <ul>
|
|
@@ -1050,7 +1050,7 @@ export interface UpdateUserPoolRequest {
|
|
|
1050
1050
|
* </ul>
|
|
1051
1051
|
* @public
|
|
1052
1052
|
*/
|
|
1053
|
-
MfaConfiguration?: UserPoolMfaType;
|
|
1053
|
+
MfaConfiguration?: UserPoolMfaType | undefined;
|
|
1054
1054
|
/**
|
|
1055
1055
|
* <p>The device-remembering configuration for a user pool. A null value indicates that you
|
|
1056
1056
|
* have deactivated device remembering in your user pool.</p>
|
|
@@ -1060,14 +1060,14 @@ export interface UpdateUserPoolRequest {
|
|
|
1060
1060
|
* </note>
|
|
1061
1061
|
* @public
|
|
1062
1062
|
*/
|
|
1063
|
-
DeviceConfiguration?: DeviceConfigurationType;
|
|
1063
|
+
DeviceConfiguration?: DeviceConfigurationType | undefined;
|
|
1064
1064
|
/**
|
|
1065
1065
|
* <p>The email configuration of your user pool. The email configuration type sets your
|
|
1066
1066
|
* preferred sending method, Amazon Web Services Region, and sender for email invitation and verification
|
|
1067
1067
|
* messages from your user pool.</p>
|
|
1068
1068
|
* @public
|
|
1069
1069
|
*/
|
|
1070
|
-
EmailConfiguration?: EmailConfigurationType;
|
|
1070
|
+
EmailConfiguration?: EmailConfigurationType | undefined;
|
|
1071
1071
|
/**
|
|
1072
1072
|
* <p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an
|
|
1073
1073
|
* SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages
|
|
@@ -1075,19 +1075,19 @@ export interface UpdateUserPoolRequest {
|
|
|
1075
1075
|
* (IAM) role in your Amazon Web Services account.</p>
|
|
1076
1076
|
* @public
|
|
1077
1077
|
*/
|
|
1078
|
-
SmsConfiguration?: SmsConfigurationType;
|
|
1078
|
+
SmsConfiguration?: SmsConfigurationType | undefined;
|
|
1079
1079
|
/**
|
|
1080
1080
|
* <p>The tag keys and values to assign to the user pool. A tag is a label that you can use
|
|
1081
1081
|
* to categorize and manage user pools in different ways, such as by purpose, owner,
|
|
1082
1082
|
* environment, or other criteria.</p>
|
|
1083
1083
|
* @public
|
|
1084
1084
|
*/
|
|
1085
|
-
UserPoolTags?: Record<string, string
|
|
1085
|
+
UserPoolTags?: Record<string, string> | undefined;
|
|
1086
1086
|
/**
|
|
1087
1087
|
* <p>The configuration for <code>AdminCreateUser</code> requests.</p>
|
|
1088
1088
|
* @public
|
|
1089
1089
|
*/
|
|
1090
|
-
AdminCreateUserConfig?: AdminCreateUserConfigType;
|
|
1090
|
+
AdminCreateUserConfig?: AdminCreateUserConfigType | undefined;
|
|
1091
1091
|
/**
|
|
1092
1092
|
* <p>User pool add-ons. Contains settings for activation of advanced security features. To
|
|
1093
1093
|
* log user security information but take no action, set to <code>AUDIT</code>. To
|
|
@@ -1096,7 +1096,7 @@ export interface UpdateUserPoolRequest {
|
|
|
1096
1096
|
* <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>
|
|
1097
1097
|
* @public
|
|
1098
1098
|
*/
|
|
1099
|
-
UserPoolAddOns?: UserPoolAddOnsType;
|
|
1099
|
+
UserPoolAddOns?: UserPoolAddOnsType | undefined;
|
|
1100
1100
|
/**
|
|
1101
1101
|
* <p>The available verified method a user can use to recover their password when they call
|
|
1102
1102
|
* <code>ForgotPassword</code>. You can use this setting to define a preferred method
|
|
@@ -1106,7 +1106,7 @@ export interface UpdateUserPoolRequest {
|
|
|
1106
1106
|
* behavior to determine the recovery method where SMS is preferred through email.</p>
|
|
1107
1107
|
* @public
|
|
1108
1108
|
*/
|
|
1109
|
-
AccountRecoverySetting?: AccountRecoverySettingType;
|
|
1109
|
+
AccountRecoverySetting?: AccountRecoverySettingType | undefined;
|
|
1110
1110
|
}
|
|
1111
1111
|
/**
|
|
1112
1112
|
* <p>Represents the response from the server when you make a request to update the user
|
|
@@ -1135,7 +1135,7 @@ export interface UpdateUserPoolClientRequest {
|
|
|
1135
1135
|
* <p>The client name from the update user pool client request.</p>
|
|
1136
1136
|
* @public
|
|
1137
1137
|
*/
|
|
1138
|
-
ClientName?: string;
|
|
1138
|
+
ClientName?: string | undefined;
|
|
1139
1139
|
/**
|
|
1140
1140
|
* <p>The refresh token time limit. After this limit expires, your user can't use
|
|
1141
1141
|
* their refresh token. To specify the time unit for <code>RefreshTokenValidity</code> as
|
|
@@ -1152,7 +1152,7 @@ export interface UpdateUserPoolClientRequest {
|
|
|
1152
1152
|
* tokens are valid for 30 days.</p>
|
|
1153
1153
|
* @public
|
|
1154
1154
|
*/
|
|
1155
|
-
RefreshTokenValidity?: number;
|
|
1155
|
+
RefreshTokenValidity?: number | undefined;
|
|
1156
1156
|
/**
|
|
1157
1157
|
* <p>The access token time limit. After this limit expires, your user can't use
|
|
1158
1158
|
* their access token. To specify the time unit for <code>AccessTokenValidity</code> as
|
|
@@ -1167,7 +1167,7 @@ export interface UpdateUserPoolClientRequest {
|
|
|
1167
1167
|
* tokens are valid for one hour.</p>
|
|
1168
1168
|
* @public
|
|
1169
1169
|
*/
|
|
1170
|
-
AccessTokenValidity?: number;
|
|
1170
|
+
AccessTokenValidity?: number | undefined;
|
|
1171
1171
|
/**
|
|
1172
1172
|
* <p>The ID token time limit. After this limit expires, your user can't use
|
|
1173
1173
|
* their ID token. To specify the time unit for <code>IdTokenValidity</code> as
|
|
@@ -1182,14 +1182,14 @@ export interface UpdateUserPoolClientRequest {
|
|
|
1182
1182
|
* tokens are valid for one hour.</p>
|
|
1183
1183
|
* @public
|
|
1184
1184
|
*/
|
|
1185
|
-
IdTokenValidity?: number;
|
|
1185
|
+
IdTokenValidity?: number | undefined;
|
|
1186
1186
|
/**
|
|
1187
1187
|
* <p>The time units you use when you set the duration of ID, access, and refresh tokens.
|
|
1188
1188
|
* The default unit for RefreshToken is days, and the default for ID and access tokens is
|
|
1189
1189
|
* hours.</p>
|
|
1190
1190
|
* @public
|
|
1191
1191
|
*/
|
|
1192
|
-
TokenValidityUnits?: TokenValidityUnitsType;
|
|
1192
|
+
TokenValidityUnits?: TokenValidityUnitsType | undefined;
|
|
1193
1193
|
/**
|
|
1194
1194
|
* <p>The list of user attributes that you want your app client to have read access to.
|
|
1195
1195
|
* After your user authenticates in your app, their access token authorizes them to read
|
|
@@ -1206,7 +1206,7 @@ export interface UpdateUserPoolClientRequest {
|
|
|
1206
1206
|
* custom set of read attributes.</p>
|
|
1207
1207
|
* @public
|
|
1208
1208
|
*/
|
|
1209
|
-
ReadAttributes?: string[];
|
|
1209
|
+
ReadAttributes?: string[] | undefined;
|
|
1210
1210
|
/**
|
|
1211
1211
|
* <p>The list of user attributes that you want your app client to have write access to.
|
|
1212
1212
|
* After your user authenticates in your app, their access token authorizes them to set or
|
|
@@ -1228,7 +1228,7 @@ export interface UpdateUserPoolClientRequest {
|
|
|
1228
1228
|
* pool</a>.</p>
|
|
1229
1229
|
* @public
|
|
1230
1230
|
*/
|
|
1231
|
-
WriteAttributes?: string[];
|
|
1231
|
+
WriteAttributes?: string[] | undefined;
|
|
1232
1232
|
/**
|
|
1233
1233
|
* <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
|
|
1234
1234
|
* your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and
|
|
@@ -1272,7 +1272,7 @@ export interface UpdateUserPoolClientRequest {
|
|
|
1272
1272
|
* like <code>ALLOW_USER_SRP_AUTH</code>.</p>
|
|
1273
1273
|
* @public
|
|
1274
1274
|
*/
|
|
1275
|
-
ExplicitAuthFlows?: ExplicitAuthFlowsType[];
|
|
1275
|
+
ExplicitAuthFlows?: ExplicitAuthFlowsType[] | undefined;
|
|
1276
1276
|
/**
|
|
1277
1277
|
* <p>A list of provider names for the IdPs that this client supports. The following are
|
|
1278
1278
|
* supported: <code>COGNITO</code>, <code>Facebook</code>, <code>Google</code>,
|
|
@@ -1280,7 +1280,7 @@ export interface UpdateUserPoolClientRequest {
|
|
|
1280
1280
|
* own SAML and OIDC providers.</p>
|
|
1281
1281
|
* @public
|
|
1282
1282
|
*/
|
|
1283
|
-
SupportedIdentityProviders?: string[];
|
|
1283
|
+
SupportedIdentityProviders?: string[] | undefined;
|
|
1284
1284
|
/**
|
|
1285
1285
|
* <p>A list of allowed redirect (callback) URLs for the IdPs.</p>
|
|
1286
1286
|
* <p>A redirect URI must:</p>
|
|
@@ -1302,12 +1302,12 @@ export interface UpdateUserPoolClientRequest {
|
|
|
1302
1302
|
* <p>App callback URLs such as <code>myapp://example</code> are also supported.</p>
|
|
1303
1303
|
* @public
|
|
1304
1304
|
*/
|
|
1305
|
-
CallbackURLs?: string[];
|
|
1305
|
+
CallbackURLs?: string[] | undefined;
|
|
1306
1306
|
/**
|
|
1307
1307
|
* <p>A list of allowed logout URLs for the IdPs.</p>
|
|
1308
1308
|
* @public
|
|
1309
1309
|
*/
|
|
1310
|
-
LogoutURLs?: string[];
|
|
1310
|
+
LogoutURLs?: string[] | undefined;
|
|
1311
1311
|
/**
|
|
1312
1312
|
* <p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p>
|
|
1313
1313
|
* <p>A redirect URI must:</p>
|
|
@@ -1329,7 +1329,7 @@ export interface UpdateUserPoolClientRequest {
|
|
|
1329
1329
|
* <p>App callback URLs such as <code>myapp://example</code> are also supported.</p>
|
|
1330
1330
|
* @public
|
|
1331
1331
|
*/
|
|
1332
|
-
DefaultRedirectURI?: string;
|
|
1332
|
+
DefaultRedirectURI?: string | undefined;
|
|
1333
1333
|
/**
|
|
1334
1334
|
* <p>The allowed OAuth flows.</p>
|
|
1335
1335
|
* <dl>
|
|
@@ -1353,7 +1353,7 @@ export interface UpdateUserPoolClientRequest {
|
|
|
1353
1353
|
* </dl>
|
|
1354
1354
|
* @public
|
|
1355
1355
|
*/
|
|
1356
|
-
AllowedOAuthFlows?: OAuthFlowType[];
|
|
1356
|
+
AllowedOAuthFlows?: OAuthFlowType[] | undefined;
|
|
1357
1357
|
/**
|
|
1358
1358
|
* <p>The allowed OAuth scopes. Possible values provided by OAuth are <code>phone</code>,
|
|
1359
1359
|
* <code>email</code>, <code>openid</code>, and <code>profile</code>. Possible values
|
|
@@ -1361,7 +1361,7 @@ export interface UpdateUserPoolClientRequest {
|
|
|
1361
1361
|
* in Resource Servers are also supported.</p>
|
|
1362
1362
|
* @public
|
|
1363
1363
|
*/
|
|
1364
|
-
AllowedOAuthScopes?: string[];
|
|
1364
|
+
AllowedOAuthScopes?: string[] | undefined;
|
|
1365
1365
|
/**
|
|
1366
1366
|
* <p>Set to <code>true</code> to use OAuth 2.0 features in your user pool app client.</p>
|
|
1367
1367
|
* <p>
|
|
@@ -1392,7 +1392,7 @@ export interface UpdateUserPoolClientRequest {
|
|
|
1392
1392
|
* to <code>false</code>.</p>
|
|
1393
1393
|
* @public
|
|
1394
1394
|
*/
|
|
1395
|
-
AllowedOAuthFlowsUserPoolClient?: boolean;
|
|
1395
|
+
AllowedOAuthFlowsUserPoolClient?: boolean | undefined;
|
|
1396
1396
|
/**
|
|
1397
1397
|
* <p>The Amazon Pinpoint analytics configuration necessary to collect metrics for this user
|
|
1398
1398
|
* pool.</p>
|
|
@@ -1403,7 +1403,7 @@ export interface UpdateUserPoolClientRequest {
|
|
|
1403
1403
|
* </note>
|
|
1404
1404
|
* @public
|
|
1405
1405
|
*/
|
|
1406
|
-
AnalyticsConfiguration?: AnalyticsConfigurationType;
|
|
1406
|
+
AnalyticsConfiguration?: AnalyticsConfigurationType | undefined;
|
|
1407
1407
|
/**
|
|
1408
1408
|
* <p>Errors and responses that you want Amazon Cognito APIs to return during authentication, account
|
|
1409
1409
|
* confirmation, and password recovery when the user doesn't exist in the user pool. When
|
|
@@ -1428,13 +1428,13 @@ export interface UpdateUserPoolClientRequest {
|
|
|
1428
1428
|
* <p>Defaults to <code>LEGACY</code> when you don't provide a value.</p>
|
|
1429
1429
|
* @public
|
|
1430
1430
|
*/
|
|
1431
|
-
PreventUserExistenceErrors?: PreventUserExistenceErrorTypes;
|
|
1431
|
+
PreventUserExistenceErrors?: PreventUserExistenceErrorTypes | undefined;
|
|
1432
1432
|
/**
|
|
1433
1433
|
* <p>Activates or deactivates token revocation. For more information about revoking tokens,
|
|
1434
1434
|
* see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
|
|
1435
1435
|
* @public
|
|
1436
1436
|
*/
|
|
1437
|
-
EnableTokenRevocation?: boolean;
|
|
1437
|
+
EnableTokenRevocation?: boolean | undefined;
|
|
1438
1438
|
/**
|
|
1439
1439
|
* <p>Activates the propagation of additional user context data. For more information about
|
|
1440
1440
|
* 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
|
|
@@ -1444,13 +1444,13 @@ export interface UpdateUserPoolClientRequest {
|
|
|
1444
1444
|
* client secret.</p>
|
|
1445
1445
|
* @public
|
|
1446
1446
|
*/
|
|
1447
|
-
EnablePropagateAdditionalUserContextData?: boolean;
|
|
1447
|
+
EnablePropagateAdditionalUserContextData?: boolean | undefined;
|
|
1448
1448
|
/**
|
|
1449
1449
|
* <p>Amazon Cognito creates a session token for each API request in an authentication flow. <code>AuthSessionValidity</code> is the duration,
|
|
1450
1450
|
* in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.</p>
|
|
1451
1451
|
* @public
|
|
1452
1452
|
*/
|
|
1453
|
-
AuthSessionValidity?: number;
|
|
1453
|
+
AuthSessionValidity?: number | undefined;
|
|
1454
1454
|
}
|
|
1455
1455
|
/**
|
|
1456
1456
|
* <p>Represents the response from the server to the request to update the user pool
|
|
@@ -1463,7 +1463,7 @@ export interface UpdateUserPoolClientResponse {
|
|
|
1463
1463
|
* update the user pool client.</p>
|
|
1464
1464
|
* @public
|
|
1465
1465
|
*/
|
|
1466
|
-
UserPoolClient?: UserPoolClientType;
|
|
1466
|
+
UserPoolClient?: UserPoolClientType | undefined;
|
|
1467
1467
|
}
|
|
1468
1468
|
/**
|
|
1469
1469
|
* <p>The UpdateUserPoolDomain request input.</p>
|
|
@@ -1502,7 +1502,7 @@ export interface UpdateUserPoolDomainResponse {
|
|
|
1502
1502
|
* pool.</p>
|
|
1503
1503
|
* @public
|
|
1504
1504
|
*/
|
|
1505
|
-
CloudFrontDomain?: string;
|
|
1505
|
+
CloudFrontDomain?: string | undefined;
|
|
1506
1506
|
}
|
|
1507
1507
|
/**
|
|
1508
1508
|
* <p>This exception is thrown when there is a code mismatch and the service fails to
|
|
@@ -1526,13 +1526,13 @@ export interface VerifySoftwareTokenRequest {
|
|
|
1526
1526
|
* verify.</p>
|
|
1527
1527
|
* @public
|
|
1528
1528
|
*/
|
|
1529
|
-
AccessToken?: string;
|
|
1529
|
+
AccessToken?: string | undefined;
|
|
1530
1530
|
/**
|
|
1531
1531
|
* <p>The session that should be passed both ways in challenge-response calls to the
|
|
1532
1532
|
* service.</p>
|
|
1533
1533
|
* @public
|
|
1534
1534
|
*/
|
|
1535
|
-
Session?: string;
|
|
1535
|
+
Session?: string | undefined;
|
|
1536
1536
|
/**
|
|
1537
1537
|
* <p>The one- time password computed using the secret code returned by <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AssociateSoftwareToken.html">AssociateSoftwareToken</a>.</p>
|
|
1538
1538
|
* @public
|
|
@@ -1542,7 +1542,7 @@ export interface VerifySoftwareTokenRequest {
|
|
|
1542
1542
|
* <p>The friendly device name.</p>
|
|
1543
1543
|
* @public
|
|
1544
1544
|
*/
|
|
1545
|
-
FriendlyDeviceName?: string;
|
|
1545
|
+
FriendlyDeviceName?: string | undefined;
|
|
1546
1546
|
}
|
|
1547
1547
|
/**
|
|
1548
1548
|
* @public
|
|
@@ -1564,13 +1564,13 @@ export interface VerifySoftwareTokenResponse {
|
|
|
1564
1564
|
* <p>The status of the verify software token.</p>
|
|
1565
1565
|
* @public
|
|
1566
1566
|
*/
|
|
1567
|
-
Status?: VerifySoftwareTokenResponseType;
|
|
1567
|
+
Status?: VerifySoftwareTokenResponseType | undefined;
|
|
1568
1568
|
/**
|
|
1569
1569
|
* <p>The session that should be passed both ways in challenge-response calls to the
|
|
1570
1570
|
* service.</p>
|
|
1571
1571
|
* @public
|
|
1572
1572
|
*/
|
|
1573
|
-
Session?: string;
|
|
1573
|
+
Session?: string | undefined;
|
|
1574
1574
|
}
|
|
1575
1575
|
/**
|
|
1576
1576
|
* <p>Represents the request to verify user attributes.</p>
|