@aws-sdk/client-cognito-identity-provider 3.378.0 → 3.382.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7,44 +7,53 @@ import { AccountRecoverySettingType, AdminCreateUserConfigType, AnalyticsConfigu
7
7
  */
8
8
  export interface SignUpRequest {
9
9
  /**
10
+ * @public
10
11
  * <p>The ID of the client associated with the user pool.</p>
11
12
  */
12
13
  ClientId: string | undefined;
13
14
  /**
15
+ * @public
14
16
  * <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a
15
17
  * user pool client and username plus the client ID in the message.</p>
16
18
  */
17
19
  SecretHash?: string;
18
20
  /**
21
+ * @public
19
22
  * <p>The user name of the user you want to register.</p>
20
23
  */
21
24
  Username: string | undefined;
22
25
  /**
26
+ * @public
23
27
  * <p>The password of the user you want to register.</p>
24
28
  */
25
29
  Password: string | undefined;
26
30
  /**
31
+ * @public
27
32
  * <p>An array of name-value pairs representing user attributes.</p>
28
33
  * <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the
29
34
  * attribute name.</p>
30
35
  */
31
36
  UserAttributes?: AttributeType[];
32
37
  /**
38
+ * @public
33
39
  * <p>The validation data in the request to register a user.</p>
34
40
  */
35
41
  ValidationData?: AttributeType[];
36
42
  /**
43
+ * @public
37
44
  * <p>The Amazon Pinpoint analytics metadata that contributes to your metrics for
38
45
  * <code>SignUp</code> calls.</p>
39
46
  */
40
47
  AnalyticsMetadata?: AnalyticsMetadataType;
41
48
  /**
49
+ * @public
42
50
  * <p>Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced
43
51
  * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
44
52
  * when it makes API requests.</p>
45
53
  */
46
54
  UserContextData?: UserContextDataType;
47
55
  /**
56
+ * @public
48
57
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
49
58
  * that this action triggers.</p>
50
59
  * <p>You create custom workflows by assigning Lambda functions to user pool triggers.
@@ -86,16 +95,19 @@ export interface SignUpRequest {
86
95
  */
87
96
  export interface SignUpResponse {
88
97
  /**
98
+ * @public
89
99
  * <p>A response from the server indicating that a user registration has been
90
100
  * confirmed.</p>
91
101
  */
92
102
  UserConfirmed: boolean | undefined;
93
103
  /**
104
+ * @public
94
105
  * <p>The code delivery details returned by the server response to the user registration
95
106
  * request.</p>
96
107
  */
97
108
  CodeDeliveryDetails?: CodeDeliveryDetailsType;
98
109
  /**
110
+ * @public
99
111
  * <p>The UUID of the authenticated user. This isn't the same as
100
112
  * <code>username</code>.</p>
101
113
  */
@@ -107,10 +119,12 @@ export interface SignUpResponse {
107
119
  */
108
120
  export interface StartUserImportJobRequest {
109
121
  /**
122
+ * @public
110
123
  * <p>The user pool ID for the user pool that the users are being imported into.</p>
111
124
  */
112
125
  UserPoolId: string | undefined;
113
126
  /**
127
+ * @public
114
128
  * <p>The job ID for the user import job.</p>
115
129
  */
116
130
  JobId: string | undefined;
@@ -122,6 +136,7 @@ export interface StartUserImportJobRequest {
122
136
  */
123
137
  export interface StartUserImportJobResponse {
124
138
  /**
139
+ * @public
125
140
  * <p>The job object that represents the user import job.</p>
126
141
  */
127
142
  UserImportJob?: UserImportJobType;
@@ -132,10 +147,12 @@ export interface StartUserImportJobResponse {
132
147
  */
133
148
  export interface StopUserImportJobRequest {
134
149
  /**
150
+ * @public
135
151
  * <p>The user pool ID for the user pool that the users are being imported into.</p>
136
152
  */
137
153
  UserPoolId: string | undefined;
138
154
  /**
155
+ * @public
139
156
  * <p>The job ID for the user import job.</p>
140
157
  */
141
158
  JobId: string | undefined;
@@ -147,6 +164,7 @@ export interface StopUserImportJobRequest {
147
164
  */
148
165
  export interface StopUserImportJobResponse {
149
166
  /**
167
+ * @public
150
168
  * <p>The job object that represents the user import job.</p>
151
169
  */
152
170
  UserImportJob?: UserImportJobType;
@@ -156,10 +174,12 @@ export interface StopUserImportJobResponse {
156
174
  */
157
175
  export interface TagResourceRequest {
158
176
  /**
177
+ * @public
159
178
  * <p>The Amazon Resource Name (ARN) of the user pool to assign the tags to.</p>
160
179
  */
161
180
  ResourceArn: string | undefined;
162
181
  /**
182
+ * @public
163
183
  * <p>The tags to assign to the user pool.</p>
164
184
  */
165
185
  Tags: Record<string, string> | undefined;
@@ -174,10 +194,12 @@ export interface TagResourceResponse {
174
194
  */
175
195
  export interface UntagResourceRequest {
176
196
  /**
197
+ * @public
177
198
  * <p>The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.</p>
178
199
  */
179
200
  ResourceArn: string | undefined;
180
201
  /**
202
+ * @public
181
203
  * <p>The keys of the tags to remove from the user pool.</p>
182
204
  */
183
205
  TagKeys: string[] | undefined;
@@ -192,22 +214,27 @@ export interface UntagResourceResponse {
192
214
  */
193
215
  export interface UpdateAuthEventFeedbackRequest {
194
216
  /**
217
+ * @public
195
218
  * <p>The user pool ID.</p>
196
219
  */
197
220
  UserPoolId: string | undefined;
198
221
  /**
222
+ * @public
199
223
  * <p>The user pool username.</p>
200
224
  */
201
225
  Username: string | undefined;
202
226
  /**
227
+ * @public
203
228
  * <p>The event ID.</p>
204
229
  */
205
230
  EventId: string | undefined;
206
231
  /**
232
+ * @public
207
233
  * <p>The feedback token.</p>
208
234
  */
209
235
  FeedbackToken: string | undefined;
210
236
  /**
237
+ * @public
211
238
  * <p>The authentication event feedback value.</p>
212
239
  */
213
240
  FeedbackValue: FeedbackValueType | string | undefined;
@@ -223,15 +250,18 @@ export interface UpdateAuthEventFeedbackResponse {
223
250
  */
224
251
  export interface UpdateDeviceStatusRequest {
225
252
  /**
253
+ * @public
226
254
  * <p>A valid access token that Amazon Cognito issued to the user whose device status you want to
227
255
  * update.</p>
228
256
  */
229
257
  AccessToken: string | undefined;
230
258
  /**
259
+ * @public
231
260
  * <p>The device key.</p>
232
261
  */
233
262
  DeviceKey: string | undefined;
234
263
  /**
264
+ * @public
235
265
  * <p>The status of whether a device is remembered.</p>
236
266
  */
237
267
  DeviceRememberedStatus?: DeviceRememberedStatusType | string;
@@ -247,24 +277,29 @@ export interface UpdateDeviceStatusResponse {
247
277
  */
248
278
  export interface UpdateGroupRequest {
249
279
  /**
280
+ * @public
250
281
  * <p>The name of the group.</p>
251
282
  */
252
283
  GroupName: string | undefined;
253
284
  /**
285
+ * @public
254
286
  * <p>The user pool ID for the user pool.</p>
255
287
  */
256
288
  UserPoolId: string | undefined;
257
289
  /**
290
+ * @public
258
291
  * <p>A string containing the new description of the group.</p>
259
292
  */
260
293
  Description?: string;
261
294
  /**
295
+ * @public
262
296
  * <p>The new role Amazon Resource Name (ARN) for the group. This is used for setting the
263
297
  * <code>cognito:roles</code> and <code>cognito:preferred_role</code> claims in the
264
298
  * token.</p>
265
299
  */
266
300
  RoleArn?: string;
267
301
  /**
302
+ * @public
268
303
  * <p>The new precedence value for the group. For more information about this parameter, see
269
304
  * <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateGroup.html">CreateGroup</a>.</p>
270
305
  */
@@ -275,6 +310,7 @@ export interface UpdateGroupRequest {
275
310
  */
276
311
  export interface UpdateGroupResponse {
277
312
  /**
313
+ * @public
278
314
  * <p>The group object for the group.</p>
279
315
  */
280
316
  Group?: GroupType;
@@ -284,23 +320,28 @@ export interface UpdateGroupResponse {
284
320
  */
285
321
  export interface UpdateIdentityProviderRequest {
286
322
  /**
323
+ * @public
287
324
  * <p>The user pool ID.</p>
288
325
  */
289
326
  UserPoolId: string | undefined;
290
327
  /**
328
+ * @public
291
329
  * <p>The IdP name.</p>
292
330
  */
293
331
  ProviderName: string | undefined;
294
332
  /**
333
+ * @public
295
334
  * <p>The IdP details to be updated, such as <code>MetadataURL</code> and
296
335
  * <code>MetadataFile</code>.</p>
297
336
  */
298
337
  ProviderDetails?: Record<string, string>;
299
338
  /**
339
+ * @public
300
340
  * <p>The IdP attribute mapping to be changed.</p>
301
341
  */
302
342
  AttributeMapping?: Record<string, string>;
303
343
  /**
344
+ * @public
304
345
  * <p>A list of IdP identifiers.</p>
305
346
  */
306
347
  IdpIdentifiers?: string[];
@@ -310,6 +351,7 @@ export interface UpdateIdentityProviderRequest {
310
351
  */
311
352
  export interface UpdateIdentityProviderResponse {
312
353
  /**
354
+ * @public
313
355
  * <p>The identity provider details.</p>
314
356
  */
315
357
  IdentityProvider: IdentityProviderType | undefined;
@@ -319,18 +361,22 @@ export interface UpdateIdentityProviderResponse {
319
361
  */
320
362
  export interface UpdateResourceServerRequest {
321
363
  /**
364
+ * @public
322
365
  * <p>The user pool ID for the user pool.</p>
323
366
  */
324
367
  UserPoolId: string | undefined;
325
368
  /**
369
+ * @public
326
370
  * <p>The identifier for the resource server.</p>
327
371
  */
328
372
  Identifier: string | undefined;
329
373
  /**
374
+ * @public
330
375
  * <p>The name of the resource server.</p>
331
376
  */
332
377
  Name: string | undefined;
333
378
  /**
379
+ * @public
334
380
  * <p>The scope values to be set for the resource server.</p>
335
381
  */
336
382
  Scopes?: ResourceServerScopeType[];
@@ -340,6 +386,7 @@ export interface UpdateResourceServerRequest {
340
386
  */
341
387
  export interface UpdateResourceServerResponse {
342
388
  /**
389
+ * @public
343
390
  * <p>The resource server.</p>
344
391
  */
345
392
  ResourceServer: ResourceServerType | undefined;
@@ -350,6 +397,7 @@ export interface UpdateResourceServerResponse {
350
397
  */
351
398
  export interface UpdateUserAttributesRequest {
352
399
  /**
400
+ * @public
353
401
  * <p>An array of name-value pairs representing user attributes.</p>
354
402
  * <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the
355
403
  * attribute name.</p>
@@ -361,11 +409,13 @@ export interface UpdateUserAttributesRequest {
361
409
  */
362
410
  UserAttributes: AttributeType[] | undefined;
363
411
  /**
412
+ * @public
364
413
  * <p>A valid access token that Amazon Cognito issued to the user whose user attributes you want to
365
414
  * update.</p>
366
415
  */
367
416
  AccessToken: string | undefined;
368
417
  /**
418
+ * @public
369
419
  * <p>A map of custom key-value pairs that you can provide as input for any custom workflows
370
420
  * that this action initiates. </p>
371
421
  * <p>You create custom workflows by assigning Lambda functions to user pool triggers. When
@@ -407,6 +457,7 @@ export interface UpdateUserAttributesRequest {
407
457
  */
408
458
  export interface UpdateUserAttributesResponse {
409
459
  /**
460
+ * @public
410
461
  * <p>The code delivery details list from the server for the request to update user
411
462
  * attributes.</p>
412
463
  */
@@ -418,14 +469,17 @@ export interface UpdateUserAttributesResponse {
418
469
  */
419
470
  export interface UpdateUserPoolRequest {
420
471
  /**
472
+ * @public
421
473
  * <p>The user pool ID for the user pool you want to update.</p>
422
474
  */
423
475
  UserPoolId: string | undefined;
424
476
  /**
477
+ * @public
425
478
  * <p>A container with the policies you want to update in a user pool.</p>
426
479
  */
427
480
  Policies?: UserPoolPolicyType;
428
481
  /**
482
+ * @public
429
483
  * <p>When active, <code>DeletionProtection</code> prevents accidental deletion of your user
430
484
  * pool. Before you can delete a user pool that you have protected against deletion, you
431
485
  * must deactivate this feature.</p>
@@ -436,35 +490,43 @@ export interface UpdateUserPoolRequest {
436
490
  */
437
491
  DeletionProtection?: DeletionProtectionType | string;
438
492
  /**
493
+ * @public
439
494
  * <p>The Lambda configuration information from the request to update the user pool.</p>
440
495
  */
441
496
  LambdaConfig?: LambdaConfigType;
442
497
  /**
498
+ * @public
443
499
  * <p>The attributes that are automatically verified when Amazon Cognito requests to update user
444
500
  * pools.</p>
445
501
  */
446
502
  AutoVerifiedAttributes?: (VerifiedAttributeType | string)[];
447
503
  /**
504
+ * @public
448
505
  * <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>
449
506
  */
450
507
  SmsVerificationMessage?: string;
451
508
  /**
509
+ * @public
452
510
  * <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>
453
511
  */
454
512
  EmailVerificationMessage?: string;
455
513
  /**
514
+ * @public
456
515
  * <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>
457
516
  */
458
517
  EmailVerificationSubject?: string;
459
518
  /**
519
+ * @public
460
520
  * <p>The template for verification messages.</p>
461
521
  */
462
522
  VerificationMessageTemplate?: VerificationMessageTemplateType;
463
523
  /**
524
+ * @public
464
525
  * <p>The contents of the SMS authentication message.</p>
465
526
  */
466
527
  SmsAuthenticationMessage?: string;
467
528
  /**
529
+ * @public
468
530
  * <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>,
469
531
  * 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
470
532
  * more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates">
@@ -472,6 +534,7 @@ export interface UpdateUserPoolRequest {
472
534
  */
473
535
  UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType;
474
536
  /**
537
+ * @public
475
538
  * <p>Possible values include:</p>
476
539
  * <ul>
477
540
  * <li>
@@ -495,6 +558,7 @@ export interface UpdateUserPoolRequest {
495
558
  */
496
559
  MfaConfiguration?: UserPoolMfaType | string;
497
560
  /**
561
+ * @public
498
562
  * <p>The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.</p>
499
563
  * <note>
500
564
  * <p>When you provide a value for any <code>DeviceConfiguration</code> field, you activate the Amazon Cognito device-remembering feature.</p>
@@ -502,12 +566,14 @@ export interface UpdateUserPoolRequest {
502
566
  */
503
567
  DeviceConfiguration?: DeviceConfigurationType;
504
568
  /**
569
+ * @public
505
570
  * <p>The email configuration of your user pool. The email configuration type sets your
506
571
  * preferred sending method, Amazon Web Services Region, and sender for email invitation and verification
507
572
  * messages from your user pool.</p>
508
573
  */
509
574
  EmailConfiguration?: EmailConfigurationType;
510
575
  /**
576
+ * @public
511
577
  * <p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an
512
578
  * SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages
513
579
  * with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management
@@ -515,21 +581,25 @@ export interface UpdateUserPoolRequest {
515
581
  */
516
582
  SmsConfiguration?: SmsConfigurationType;
517
583
  /**
584
+ * @public
518
585
  * <p>The tag keys and values to assign to the user pool. A tag is a label that you can use
519
586
  * to categorize and manage user pools in different ways, such as by purpose, owner,
520
587
  * environment, or other criteria.</p>
521
588
  */
522
589
  UserPoolTags?: Record<string, string>;
523
590
  /**
591
+ * @public
524
592
  * <p>The configuration for <code>AdminCreateUser</code> requests.</p>
525
593
  */
526
594
  AdminCreateUserConfig?: AdminCreateUserConfigType;
527
595
  /**
596
+ * @public
528
597
  * <p>Enables advanced security risk detection. Set the key
529
598
  * <code>AdvancedSecurityMode</code> to the value "AUDIT".</p>
530
599
  */
531
600
  UserPoolAddOns?: UserPoolAddOnsType;
532
601
  /**
602
+ * @public
533
603
  * <p>The available verified method a user can use to recover their password when they call
534
604
  * <code>ForgotPassword</code>. You can use this setting to define a preferred method
535
605
  * when a user has more than one method available. With this setting, SMS doesn't qualify
@@ -552,19 +622,23 @@ export interface UpdateUserPoolResponse {
552
622
  */
553
623
  export interface UpdateUserPoolClientRequest {
554
624
  /**
625
+ * @public
555
626
  * <p>The user pool ID for the user pool where you want to update the user pool
556
627
  * client.</p>
557
628
  */
558
629
  UserPoolId: string | undefined;
559
630
  /**
631
+ * @public
560
632
  * <p>The ID of the client associated with the user pool.</p>
561
633
  */
562
634
  ClientId: string | undefined;
563
635
  /**
636
+ * @public
564
637
  * <p>The client name from the update user pool client request.</p>
565
638
  */
566
639
  ClientName?: string;
567
640
  /**
641
+ * @public
568
642
  * <p>The refresh token time limit. After this limit expires, your user can't use
569
643
  * their refresh token. To specify the time unit for <code>RefreshTokenValidity</code> as
570
644
  * <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>,
@@ -581,6 +655,7 @@ export interface UpdateUserPoolClientRequest {
581
655
  */
582
656
  RefreshTokenValidity?: number;
583
657
  /**
658
+ * @public
584
659
  * <p>The access token time limit. After this limit expires, your user can't use
585
660
  * their access token. To specify the time unit for <code>AccessTokenValidity</code> as
586
661
  * <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>,
@@ -595,6 +670,7 @@ export interface UpdateUserPoolClientRequest {
595
670
  */
596
671
  AccessTokenValidity?: number;
597
672
  /**
673
+ * @public
598
674
  * <p>The ID token time limit. After this limit expires, your user can't use
599
675
  * their ID token. To specify the time unit for <code>IdTokenValidity</code> as
600
676
  * <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>,
@@ -609,19 +685,23 @@ export interface UpdateUserPoolClientRequest {
609
685
  */
610
686
  IdTokenValidity?: number;
611
687
  /**
688
+ * @public
612
689
  * <p>The units in which the validity times are represented. The default unit for
613
690
  * RefreshToken is days, and the default for ID and access tokens is hours.</p>
614
691
  */
615
692
  TokenValidityUnits?: TokenValidityUnitsType;
616
693
  /**
694
+ * @public
617
695
  * <p>The read-only attributes of the user pool.</p>
618
696
  */
619
697
  ReadAttributes?: string[];
620
698
  /**
699
+ * @public
621
700
  * <p>The writeable attributes of the user pool.</p>
622
701
  */
623
702
  WriteAttributes?: string[];
624
703
  /**
704
+ * @public
625
705
  * <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
626
706
  * your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and
627
707
  * password, or a custom authentication process that you define with Lambda functions.</p>
@@ -665,12 +745,14 @@ export interface UpdateUserPoolClientRequest {
665
745
  */
666
746
  ExplicitAuthFlows?: (ExplicitAuthFlowsType | string)[];
667
747
  /**
748
+ * @public
668
749
  * <p>A list of provider names for the IdPs that this client supports. The following are
669
750
  * supported: <code>COGNITO</code>, <code>Facebook</code>, <code>Google</code>, <code>SignInWithApple</code>,
670
751
  * <code>LoginWithAmazon</code>, and the names of your own SAML and OIDC providers.</p>
671
752
  */
672
753
  SupportedIdentityProviders?: string[];
673
754
  /**
755
+ * @public
674
756
  * <p>A list of allowed redirect (callback) URLs for the IdPs.</p>
675
757
  * <p>A redirect URI must:</p>
676
758
  * <ul>
@@ -692,10 +774,12 @@ export interface UpdateUserPoolClientRequest {
692
774
  */
693
775
  CallbackURLs?: string[];
694
776
  /**
777
+ * @public
695
778
  * <p>A list of allowed logout URLs for the IdPs.</p>
696
779
  */
697
780
  LogoutURLs?: string[];
698
781
  /**
782
+ * @public
699
783
  * <p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p>
700
784
  * <p>A redirect URI must:</p>
701
785
  * <ul>
@@ -717,6 +801,7 @@ export interface UpdateUserPoolClientRequest {
717
801
  */
718
802
  DefaultRedirectURI?: string;
719
803
  /**
804
+ * @public
720
805
  * <p>The allowed OAuth flows.</p>
721
806
  * <dl>
722
807
  * <dt>code</dt>
@@ -740,6 +825,7 @@ export interface UpdateUserPoolClientRequest {
740
825
  */
741
826
  AllowedOAuthFlows?: (OAuthFlowType | string)[];
742
827
  /**
828
+ * @public
743
829
  * <p>The allowed OAuth scopes. Possible values provided by OAuth are <code>phone</code>,
744
830
  * <code>email</code>, <code>openid</code>, and <code>profile</code>. Possible values
745
831
  * provided by Amazon Web Services are <code>aws.cognito.signin.user.admin</code>. Custom scopes created
@@ -747,11 +833,13 @@ export interface UpdateUserPoolClientRequest {
747
833
  */
748
834
  AllowedOAuthScopes?: string[];
749
835
  /**
836
+ * @public
750
837
  * <p>Set to true if the client is allowed to follow the OAuth protocol when interacting
751
838
  * with Amazon Cognito user pools.</p>
752
839
  */
753
840
  AllowedOAuthFlowsUserPoolClient?: boolean;
754
841
  /**
842
+ * @public
755
843
  * <p>The Amazon Pinpoint analytics configuration necessary to collect metrics for this user
756
844
  * pool.</p>
757
845
  * <note>
@@ -762,6 +850,7 @@ export interface UpdateUserPoolClientRequest {
762
850
  */
763
851
  AnalyticsConfiguration?: AnalyticsConfigurationType;
764
852
  /**
853
+ * @public
765
854
  * <p>Errors and responses that you want Amazon Cognito APIs to return during authentication, account
766
855
  * confirmation, and password recovery when the user doesn't exist in the user pool. When
767
856
  * set to <code>ENABLED</code> and the user doesn't exist, authentication returns an error
@@ -785,11 +874,13 @@ export interface UpdateUserPoolClientRequest {
785
874
  */
786
875
  PreventUserExistenceErrors?: PreventUserExistenceErrorTypes | string;
787
876
  /**
877
+ * @public
788
878
  * <p>Activates or deactivates token revocation. For more information about revoking tokens,
789
879
  * see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
790
880
  */
791
881
  EnableTokenRevocation?: boolean;
792
882
  /**
883
+ * @public
793
884
  * <p>Activates the propagation of additional user context data. For more information about
794
885
  * 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
795
886
  * parameter, you can't send device fingerprint information, including source IP address,
@@ -799,6 +890,7 @@ export interface UpdateUserPoolClientRequest {
799
890
  */
800
891
  EnablePropagateAdditionalUserContextData?: boolean;
801
892
  /**
893
+ * @public
802
894
  * <p>Amazon Cognito creates a session token for each API request in an authentication flow. <code>AuthSessionValidity</code> is the duration,
803
895
  * in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.</p>
804
896
  */
@@ -811,6 +903,7 @@ export interface UpdateUserPoolClientRequest {
811
903
  */
812
904
  export interface UpdateUserPoolClientResponse {
813
905
  /**
906
+ * @public
814
907
  * <p>The user pool client value from the response from the server when you request to
815
908
  * update the user pool client.</p>
816
909
  */
@@ -822,6 +915,7 @@ export interface UpdateUserPoolClientResponse {
822
915
  */
823
916
  export interface UpdateUserPoolDomainRequest {
824
917
  /**
918
+ * @public
825
919
  * <p>The domain name for the custom domain that hosts the sign-up and sign-in pages for
826
920
  * your application. One example might be <code>auth.example.com</code>. </p>
827
921
  * <p>This string can include only lowercase letters, numbers, and hyphens. Don't use a
@@ -829,11 +923,13 @@ export interface UpdateUserPoolDomainRequest {
829
923
  */
830
924
  Domain: string | undefined;
831
925
  /**
926
+ * @public
832
927
  * <p>The ID of the user pool that is associated with the custom domain whose certificate
833
928
  * you're updating.</p>
834
929
  */
835
930
  UserPoolId: string | undefined;
836
931
  /**
932
+ * @public
837
933
  * <p>The configuration for a custom domain that hosts the sign-up and sign-in pages for
838
934
  * your application. Use this object to specify an SSL certificate that is managed by
839
935
  * ACM.</p>
@@ -846,6 +942,7 @@ export interface UpdateUserPoolDomainRequest {
846
942
  */
847
943
  export interface UpdateUserPoolDomainResponse {
848
944
  /**
945
+ * @public
849
946
  * <p>The Amazon CloudFront endpoint that Amazon Cognito set up when you added the custom domain to your user
850
947
  * pool.</p>
851
948
  */
@@ -869,20 +966,24 @@ export declare class EnableSoftwareTokenMFAException extends __BaseException {
869
966
  */
870
967
  export interface VerifySoftwareTokenRequest {
871
968
  /**
969
+ * @public
872
970
  * <p>A valid access token that Amazon Cognito issued to the user whose software token you want to
873
971
  * verify.</p>
874
972
  */
875
973
  AccessToken?: string;
876
974
  /**
975
+ * @public
877
976
  * <p>The session that should be passed both ways in challenge-response calls to the
878
977
  * service.</p>
879
978
  */
880
979
  Session?: string;
881
980
  /**
981
+ * @public
882
982
  * <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>
883
983
  */
884
984
  UserCode: string | undefined;
885
985
  /**
986
+ * @public
886
987
  * <p>The friendly device name.</p>
887
988
  */
888
989
  FriendlyDeviceName?: string;
@@ -904,10 +1005,12 @@ export type VerifySoftwareTokenResponseType = (typeof VerifySoftwareTokenRespons
904
1005
  */
905
1006
  export interface VerifySoftwareTokenResponse {
906
1007
  /**
1008
+ * @public
907
1009
  * <p>The status of the verify software token.</p>
908
1010
  */
909
1011
  Status?: VerifySoftwareTokenResponseType | string;
910
1012
  /**
1013
+ * @public
911
1014
  * <p>The session that should be passed both ways in challenge-response calls to the
912
1015
  * service.</p>
913
1016
  */
@@ -919,15 +1022,18 @@ export interface VerifySoftwareTokenResponse {
919
1022
  */
920
1023
  export interface VerifyUserAttributeRequest {
921
1024
  /**
1025
+ * @public
922
1026
  * <p>A valid access token that Amazon Cognito issued to the user whose user attributes you want to
923
1027
  * verify.</p>
924
1028
  */
925
1029
  AccessToken: string | undefined;
926
1030
  /**
1031
+ * @public
927
1032
  * <p>The attribute name in the request to verify user attributes.</p>
928
1033
  */
929
1034
  AttributeName: string | undefined;
930
1035
  /**
1036
+ * @public
931
1037
  * <p>The verification code in the request to verify user attributes.</p>
932
1038
  */
933
1039
  Code: string | undefined;
@@ -1,5 +1,6 @@
1
1
  export * from "./CognitoIdentityProviderClient";
2
2
  export * from "./CognitoIdentityProvider";
3
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
3
4
  export * from "./commands";
4
5
  export * from "./pagination";
5
6
  export * from "./models";