@aws-sdk/client-frauddetector 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.
Files changed (5) hide show
  1. package/dist-types/endpoint/EndpointParameters.d.ts +3 -0
  2. package/dist-types/index.d.ts +1 -0
  3. package/dist-types/models/models_0.d.ts +621 -0
  4. package/dist-types/ts3.4/index.d.ts +1 -0
  5. package/package.json +7 -7
package/dist-types/models/models_0.d.ts CHANGED
@@ -21,12 +21,14 @@ export declare class AccessDeniedException extends __BaseException {
21
21
  */
22
22
  export interface AggregatedLogOddsMetric {
23
23
  /**
24
+ * @public
24
25
  * <p>
25
26
  * The names of all the variables.
26
27
  * </p>
27
28
  */
28
29
  variableNames: string[] | undefined;
29
30
  /**
31
+ * @public
30
32
  * <p>
31
33
  * The relative importance of the variables in the list to the other event variable.
32
34
  * </p>
@@ -43,18 +45,21 @@ export interface AggregatedLogOddsMetric {
43
45
  */
44
46
  export interface AggregatedVariablesImpactExplanation {
45
47
  /**
48
+ * @public
46
49
  * <p>
47
50
  * The names of all the event variables that were used to derive the aggregated variables.
48
51
  * </p>
49
52
  */
50
53
  eventVariableNames?: string[];
51
54
  /**
55
+ * @public
52
56
  * <p>
53
57
  * The relative impact of the aggregated variables in terms of magnitude on the prediction scores.
54
58
  * </p>
55
59
  */
56
60
  relativeImpact?: string;
57
61
  /**
62
+ * @public
58
63
  * <p>
59
64
  * The raw, uninterpreted value represented as log-odds of the fraud. These values are usually between -10 to +10, but range from -infinity to +infinity.</p>
60
65
  * <ul>
@@ -77,6 +82,7 @@ export interface AggregatedVariablesImpactExplanation {
77
82
  */
78
83
  export interface AggregatedVariablesImportanceMetrics {
79
84
  /**
85
+ * @public
80
86
  * <p>
81
87
  * List of variables' metrics.
82
88
  * </p>
@@ -91,36 +97,42 @@ export interface AggregatedVariablesImportanceMetrics {
91
97
  */
92
98
  export interface AllowDenyList {
93
99
  /**
100
+ * @public
94
101
  * <p>
95
102
  * The name of the list.
96
103
  * </p>
97
104
  */
98
105
  name: string | undefined;
99
106
  /**
107
+ * @public
100
108
  * <p>
101
109
  * The description of the list.
102
110
  * </p>
103
111
  */
104
112
  description?: string;
105
113
  /**
114
+ * @public
106
115
  * <p>
107
116
  * The variable type of the list.
108
117
  * </p>
109
118
  */
110
119
  variableType?: string;
111
120
  /**
121
+ * @public
112
122
  * <p>
113
123
  * The time the list was created.
114
124
  * </p>
115
125
  */
116
126
  createdTime?: string;
117
127
  /**
128
+ * @public
118
129
  * <p>
119
130
  * The time the list was last updated.
120
131
  * </p>
121
132
  */
122
133
  updatedTime?: string;
123
134
  /**
135
+ * @public
124
136
  * <p>
125
137
  * The ARN of the list.
126
138
  * </p>
@@ -151,6 +163,7 @@ export type AsyncJobStatus = (typeof AsyncJobStatus)[keyof typeof AsyncJobStatus
151
163
  */
152
164
  export interface ATIMetricDataPoint {
153
165
  /**
166
+ * @public
154
167
  * <p>
155
168
  * The challenge rate. This indicates the percentage of login events that the model recommends to challenge such as
156
169
  * one-time password, multi-factor authentication, and investigations.
@@ -158,6 +171,7 @@ export interface ATIMetricDataPoint {
158
171
  */
159
172
  cr?: number;
160
173
  /**
174
+ * @public
161
175
  * <p>
162
176
  * The anomaly discovery rate. This metric quantifies the percentage of anomalies that can be detected by the model at the selected score threshold.
163
177
  * A lower score threshold increases the percentage of anomalies captured by the model, but would also require challenging a larger percentage of
@@ -166,6 +180,7 @@ export interface ATIMetricDataPoint {
166
180
  */
167
181
  adr?: number;
168
182
  /**
183
+ * @public
169
184
  * <p>
170
185
  * The model's threshold that specifies an acceptable fraud capture rate. For example, a threshold of 500 means any model score 500 or above is
171
186
  * labeled as fraud.
@@ -173,6 +188,7 @@ export interface ATIMetricDataPoint {
173
188
  */
174
189
  threshold?: number;
175
190
  /**
191
+ * @public
176
192
  * <p>
177
193
  * The account takeover discovery rate. This metric quantifies the percentage of account compromise events that can be detected by the model at the selected score threshold.
178
194
  * This metric is only available if 50 or more entities with at-least one labeled account takeover event is present in the ingested dataset.
@@ -188,6 +204,7 @@ export interface ATIMetricDataPoint {
188
204
  */
189
205
  export interface ATIModelPerformance {
190
206
  /**
207
+ * @public
191
208
  * <p>
192
209
  * The anomaly separation index (ASI) score. This metric summarizes the overall ability of the model to separate anomalous activities from the normal behavior. Depending on the business, a
193
210
  * large fraction of these anomalous activities can be malicious and correspond to the account takeover attacks. A model with no separability power will have the lowest possible
@@ -204,12 +221,14 @@ export interface ATIModelPerformance {
204
221
  */
205
222
  export interface ATITrainingMetricsValue {
206
223
  /**
224
+ * @public
207
225
  * <p>
208
226
  * The model's performance metrics data points.
209
227
  * </p>
210
228
  */
211
229
  metricDataPoints?: ATIMetricDataPoint[];
212
230
  /**
231
+ * @public
213
232
  * <p>
214
233
  * The model's overall performance scores.
215
234
  * </p>
@@ -222,10 +241,12 @@ export interface ATITrainingMetricsValue {
222
241
  */
223
242
  export interface Tag {
224
243
  /**
244
+ * @public
225
245
  * <p>A tag key.</p>
226
246
  */
227
247
  key: string | undefined;
228
248
  /**
249
+ * @public
229
250
  * <p>A value assigned to a tag key.</p>
230
251
  */
231
252
  value: string | undefined;
@@ -236,26 +257,32 @@ export interface Tag {
236
257
  */
237
258
  export interface VariableEntry {
238
259
  /**
260
+ * @public
239
261
  * <p>The name of the variable.</p>
240
262
  */
241
263
  name?: string;
242
264
  /**
265
+ * @public
243
266
  * <p>The data type of the variable.</p>
244
267
  */
245
268
  dataType?: string;
246
269
  /**
270
+ * @public
247
271
  * <p>The data source of the variable.</p>
248
272
  */
249
273
  dataSource?: string;
250
274
  /**
275
+ * @public
251
276
  * <p>The default value of the variable.</p>
252
277
  */
253
278
  defaultValue?: string;
254
279
  /**
280
+ * @public
255
281
  * <p>The description of the variable.</p>
256
282
  */
257
283
  description?: string;
258
284
  /**
285
+ * @public
259
286
  * <p>The type of the variable. For more information see <a href="https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types">Variable types</a>.</p>
260
287
  * <p>Valid Values: <code>AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT </code>
261
288
  * </p>
@@ -267,10 +294,12 @@ export interface VariableEntry {
267
294
  */
268
295
  export interface BatchCreateVariableRequest {
269
296
  /**
297
+ * @public
270
298
  * <p>The list of variables for the batch create variable request.</p>
271
299
  */
272
300
  variableEntries: VariableEntry[] | undefined;
273
301
  /**
302
+ * @public
274
303
  * <p>A collection of key and value pairs.</p>
275
304
  */
276
305
  tags?: Tag[];
@@ -281,14 +310,17 @@ export interface BatchCreateVariableRequest {
281
310
  */
282
311
  export interface BatchCreateVariableError {
283
312
  /**
313
+ * @public
284
314
  * <p>The name.</p>
285
315
  */
286
316
  name?: string;
287
317
  /**
318
+ * @public
288
319
  * <p>The error code. </p>
289
320
  */
290
321
  code?: number;
291
322
  /**
323
+ * @public
292
324
  * <p>The error message.</p>
293
325
  */
294
326
  message?: string;
@@ -298,6 +330,7 @@ export interface BatchCreateVariableError {
298
330
  */
299
331
  export interface BatchCreateVariableResult {
300
332
  /**
333
+ * @public
301
334
  * <p>Provides the errors for the <code>BatchCreateVariable</code> request.</p>
302
335
  */
303
336
  errors?: BatchCreateVariableError[];
@@ -343,6 +376,7 @@ export declare class ValidationException extends __BaseException {
343
376
  */
344
377
  export interface BatchGetVariableRequest {
345
378
  /**
379
+ * @public
346
380
  * <p>The list of variable names to get.</p>
347
381
  */
348
382
  names: string[] | undefined;
@@ -353,14 +387,17 @@ export interface BatchGetVariableRequest {
353
387
  */
354
388
  export interface BatchGetVariableError {
355
389
  /**
390
+ * @public
356
391
  * <p>The error name. </p>
357
392
  */
358
393
  name?: string;
359
394
  /**
395
+ * @public
360
396
  * <p>The error code. </p>
361
397
  */
362
398
  code?: number;
363
399
  /**
400
+ * @public
364
401
  * <p>The error message.</p>
365
402
  */
366
403
  message?: string;
@@ -399,40 +436,49 @@ export type DataType = (typeof DataType)[keyof typeof DataType];
399
436
  */
400
437
  export interface Variable {
401
438
  /**
439
+ * @public
402
440
  * <p>The name of the variable.</p>
403
441
  */
404
442
  name?: string;
405
443
  /**
444
+ * @public
406
445
  * <p>The data type of the variable. For more information see <a href="https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types">Variable types</a>.</p>
407
446
  */
408
447
  dataType?: DataType | string;
409
448
  /**
449
+ * @public
410
450
  * <p>The data source of the variable.</p>
411
451
  */
412
452
  dataSource?: DataSource | string;
413
453
  /**
454
+ * @public
414
455
  * <p>The default value of the variable.</p>
415
456
  */
416
457
  defaultValue?: string;
417
458
  /**
459
+ * @public
418
460
  * <p>The description of the variable. </p>
419
461
  */
420
462
  description?: string;
421
463
  /**
464
+ * @public
422
465
  * <p>The variable type of the variable.</p>
423
466
  * <p>Valid Values: <code>AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT </code>
424
467
  * </p>
425
468
  */
426
469
  variableType?: string;
427
470
  /**
471
+ * @public
428
472
  * <p>The time when variable was last updated.</p>
429
473
  */
430
474
  lastUpdatedTime?: string;
431
475
  /**
476
+ * @public
432
477
  * <p>The time when the variable was created.</p>
433
478
  */
434
479
  createdTime?: string;
435
480
  /**
481
+ * @public
436
482
  * <p>The ARN of the variable.</p>
437
483
  */
438
484
  arn?: string;
@@ -442,10 +488,12 @@ export interface Variable {
442
488
  */
443
489
  export interface BatchGetVariableResult {
444
490
  /**
491
+ * @public
445
492
  * <p>The returned variables.</p>
446
493
  */
447
494
  variables?: Variable[];
448
495
  /**
496
+ * @public
449
497
  * <p>The errors from the request.</p>
450
498
  */
451
499
  errors?: BatchGetVariableError[];
@@ -455,6 +503,7 @@ export interface BatchGetVariableResult {
455
503
  */
456
504
  export interface CancelBatchImportJobRequest {
457
505
  /**
506
+ * @public
458
507
  * <p> The ID of an in-progress batch import job to cancel. </p>
459
508
  * <p>Amazon Fraud Detector will throw an error if the batch import job is in <code>FAILED</code>, <code>CANCELED</code>, or <code>COMPLETED</code> state.</p>
460
509
  */
@@ -482,6 +531,7 @@ export declare class ResourceNotFoundException extends __BaseException {
482
531
  */
483
532
  export interface CancelBatchPredictionJobRequest {
484
533
  /**
534
+ * @public
485
535
  * <p>The ID of the batch prediction job to cancel.</p>
486
536
  */
487
537
  jobId: string | undefined;
@@ -496,22 +546,27 @@ export interface CancelBatchPredictionJobResult {
496
546
  */
497
547
  export interface CreateBatchImportJobRequest {
498
548
  /**
549
+ * @public
499
550
  * <p>The ID of the batch import job. The ID cannot be of a past job, unless the job exists in <code>CREATE_FAILED</code> state.</p>
500
551
  */
501
552
  jobId: string | undefined;
502
553
  /**
554
+ * @public
503
555
  * <p>The URI that points to the Amazon S3 location of your data file.</p>
504
556
  */
505
557
  inputPath: string | undefined;
506
558
  /**
559
+ * @public
507
560
  * <p>The URI that points to the Amazon S3 location for storing your results. </p>
508
561
  */
509
562
  outputPath: string | undefined;
510
563
  /**
564
+ * @public
511
565
  * <p>The name of the event type.</p>
512
566
  */
513
567
  eventTypeName: string | undefined;
514
568
  /**
569
+ * @public
515
570
  * <p>The ARN of the IAM role created for Amazon S3 bucket that holds your data file.</p>
516
571
  * <p>The IAM role must have read permissions to your input S3 bucket and write permissions to your output S3 bucket.
517
572
  * For more information about bucket permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-policies-s3.html">User policy examples</a> in the
@@ -519,6 +574,7 @@ export interface CreateBatchImportJobRequest {
519
574
  */
520
575
  iamRoleArn: string | undefined;
521
576
  /**
577
+ * @public
522
578
  * <p>A collection of key-value pairs associated with this request. </p>
523
579
  */
524
580
  tags?: Tag[];
@@ -533,30 +589,37 @@ export interface CreateBatchImportJobResult {
533
589
  */
534
590
  export interface CreateBatchPredictionJobRequest {
535
591
  /**
592
+ * @public
536
593
  * <p>The ID of the batch prediction job.</p>
537
594
  */
538
595
  jobId: string | undefined;
539
596
  /**
597
+ * @public
540
598
  * <p>The Amazon S3 location of your training file.</p>
541
599
  */
542
600
  inputPath: string | undefined;
543
601
  /**
602
+ * @public
544
603
  * <p>The Amazon S3 location of your output file.</p>
545
604
  */
546
605
  outputPath: string | undefined;
547
606
  /**
607
+ * @public
548
608
  * <p>The name of the event type.</p>
549
609
  */
550
610
  eventTypeName: string | undefined;
551
611
  /**
612
+ * @public
552
613
  * <p>The name of the detector.</p>
553
614
  */
554
615
  detectorName: string | undefined;
555
616
  /**
617
+ * @public
556
618
  * <p>The detector version.</p>
557
619
  */
558
620
  detectorVersion?: string;
559
621
  /**
622
+ * @public
560
623
  * <p>The ARN of the IAM role to use for this job request.</p>
561
624
  * <p>The IAM Role must have read permissions to your input S3 bucket and write permissions to your output S3 bucket.
562
625
  * For more information about bucket permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-policies-s3.html">User policy examples</a> in the
@@ -564,6 +627,7 @@ export interface CreateBatchPredictionJobRequest {
564
627
  */
565
628
  iamRoleArn: string | undefined;
566
629
  /**
630
+ * @public
567
631
  * <p>A collection of key and value pairs.</p>
568
632
  */
569
633
  tags?: Tag[];
@@ -592,18 +656,22 @@ export type ModelTypeEnum = (typeof ModelTypeEnum)[keyof typeof ModelTypeEnum];
592
656
  */
593
657
  export interface ModelVersion {
594
658
  /**
659
+ * @public
595
660
  * <p>The model ID.</p>
596
661
  */
597
662
  modelId: string | undefined;
598
663
  /**
664
+ * @public
599
665
  * <p>The model type.</p>
600
666
  */
601
667
  modelType: ModelTypeEnum | string | undefined;
602
668
  /**
669
+ * @public
603
670
  * <p>The model version number.</p>
604
671
  */
605
672
  modelVersionNumber: string | undefined;
606
673
  /**
674
+ * @public
607
675
  * <p>The model version ARN.</p>
608
676
  */
609
677
  arn?: string;
@@ -626,14 +694,17 @@ export type RuleExecutionMode = (typeof RuleExecutionMode)[keyof typeof RuleExec
626
694
  */
627
695
  export interface Rule {
628
696
  /**
697
+ * @public
629
698
  * <p>The detector for which the rule is associated.</p>
630
699
  */
631
700
  detectorId: string | undefined;
632
701
  /**
702
+ * @public
633
703
  * <p>The rule ID.</p>
634
704
  */
635
705
  ruleId: string | undefined;
636
706
  /**
707
+ * @public
637
708
  * <p>The rule version.</p>
638
709
  */
639
710
  ruleVersion: string | undefined;
@@ -643,26 +714,32 @@ export interface Rule {
643
714
  */
644
715
  export interface CreateDetectorVersionRequest {
645
716
  /**
717
+ * @public
646
718
  * <p>The ID of the detector under which you want to create a new version.</p>
647
719
  */
648
720
  detectorId: string | undefined;
649
721
  /**
722
+ * @public
650
723
  * <p>The description of the detector version.</p>
651
724
  */
652
725
  description?: string;
653
726
  /**
727
+ * @public
654
728
  * <p>The Amazon Sagemaker model endpoints to include in the detector version.</p>
655
729
  */
656
730
  externalModelEndpoints?: string[];
657
731
  /**
732
+ * @public
658
733
  * <p>The rules to include in the detector version.</p>
659
734
  */
660
735
  rules: Rule[] | undefined;
661
736
  /**
737
+ * @public
662
738
  * <p>The model versions to include in the detector version.</p>
663
739
  */
664
740
  modelVersions?: ModelVersion[];
665
741
  /**
742
+ * @public
666
743
  * <p>The rule execution mode for the rules included in the detector version.</p>
667
744
  * <p>You can define and edit the rule mode at the detector version level, when it is in draft status.</p>
668
745
  * <p>If you specify <code>FIRST_MATCHED</code>, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.</p>
@@ -671,6 +748,7 @@ export interface CreateDetectorVersionRequest {
671
748
  */
672
749
  ruleExecutionMode?: RuleExecutionMode | string;
673
750
  /**
751
+ * @public
674
752
  * <p>A collection of key and value pairs.</p>
675
753
  */
676
754
  tags?: Tag[];
@@ -693,14 +771,17 @@ export type DetectorVersionStatus = (typeof DetectorVersionStatus)[keyof typeof
693
771
  */
694
772
  export interface CreateDetectorVersionResult {
695
773
  /**
774
+ * @public
696
775
  * <p>The ID for the created version's parent detector.</p>
697
776
  */
698
777
  detectorId?: string;
699
778
  /**
779
+ * @public
700
780
  * <p>The ID for the created detector. </p>
701
781
  */
702
782
  detectorVersionId?: string;
703
783
  /**
784
+ * @public
704
785
  * <p>The status of the detector version.</p>
705
786
  */
706
787
  status?: DetectorVersionStatus | string;
@@ -710,18 +791,21 @@ export interface CreateDetectorVersionResult {
710
791
  */
711
792
  export interface CreateListRequest {
712
793
  /**
794
+ * @public
713
795
  * <p>
714
796
  * The name of the list.
715
797
  * </p>
716
798
  */
717
799
  name: string | undefined;
718
800
  /**
801
+ * @public
719
802
  * <p>
720
803
  * The names of the elements, if providing. You can also create an empty list and add elements later using the <a href="https://docs.aws.amazon.com/frauddetector/latest/api/API_Updatelist.html">UpdateList</a> API.
721
804
  * </p>
722
805
  */
723
806
  elements?: string[];
724
807
  /**
808
+ * @public
725
809
  * <p>
726
810
  * The variable type of the list. You can only assign the variable type with String data type. For more information, see
727
811
  * <a href="https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types">Variable types</a>.
@@ -729,12 +813,14 @@ export interface CreateListRequest {
729
813
  */
730
814
  variableType?: string;
731
815
  /**
816
+ * @public
732
817
  * <p>
733
818
  * The description of the list.
734
819
  * </p>
735
820
  */
736
821
  description?: string;
737
822
  /**
823
+ * @public
738
824
  * <p>
739
825
  * A collection of the key and value pairs.
740
826
  * </p>
@@ -751,22 +837,27 @@ export interface CreateListResult {
751
837
  */
752
838
  export interface CreateModelRequest {
753
839
  /**
840
+ * @public
754
841
  * <p>The model ID.</p>
755
842
  */
756
843
  modelId: string | undefined;
757
844
  /**
845
+ * @public
758
846
  * <p>The model type. </p>
759
847
  */
760
848
  modelType: ModelTypeEnum | string | undefined;
761
849
  /**
850
+ * @public
762
851
  * <p>The model description. </p>
763
852
  */
764
853
  description?: string;
765
854
  /**
855
+ * @public
766
856
  * <p>The name of the event type.</p>
767
857
  */
768
858
  eventTypeName: string | undefined;
769
859
  /**
860
+ * @public
770
861
  * <p>A collection of key and value pairs.</p>
771
862
  */
772
863
  tags?: Tag[];
@@ -782,10 +873,12 @@ export interface CreateModelResult {
782
873
  */
783
874
  export interface ExternalEventsDetail {
784
875
  /**
876
+ * @public
785
877
  * <p>The Amazon S3 bucket location for the data.</p>
786
878
  */
787
879
  dataLocation: string | undefined;
788
880
  /**
881
+ * @public
789
882
  * <p>The ARN of the role that provides Amazon Fraud Detector access to the data location.</p>
790
883
  */
791
884
  dataAccessRoleArn: string | undefined;
@@ -796,10 +889,12 @@ export interface ExternalEventsDetail {
796
889
  */
797
890
  export interface IngestedEventsTimeWindow {
798
891
  /**
892
+ * @public
799
893
  * <p>Timestamp of the first ingensted event.</p>
800
894
  */
801
895
  startTime: string | undefined;
802
896
  /**
897
+ * @public
803
898
  * <p>Timestamp of the final ingested event.</p>
804
899
  */
805
900
  endTime: string | undefined;
@@ -810,6 +905,7 @@ export interface IngestedEventsTimeWindow {
810
905
  */
811
906
  export interface IngestedEventsDetail {
812
907
  /**
908
+ * @public
813
909
  * <p>The start and stop time of the ingested events.</p>
814
910
  */
815
911
  ingestedEventsTimeWindow: IngestedEventsTimeWindow | undefined;
@@ -834,11 +930,13 @@ export type UnlabeledEventsTreatment = (typeof UnlabeledEventsTreatment)[keyof t
834
930
  */
835
931
  export interface LabelSchema {
836
932
  /**
933
+ * @public
837
934
  * <p>The label mapper maps the Amazon Fraud Detector supported model classification labels (<code>FRAUD</code>, <code>LEGIT</code>) to the appropriate event type labels. For example, if "<code>FRAUD</code>" and "<code>LEGIT</code>" are Amazon Fraud Detector supported labels, this mapper could be: <code>\{"FRAUD" => ["0"]</code>, <code>"LEGIT" => ["1"]\}</code> or <code>\{"FRAUD" => ["false"]</code>, <code>"LEGIT" => ["true"]\}</code> or <code>\{"FRAUD" => ["fraud", "abuse"]</code>, <code>"LEGIT" => ["legit", "safe"]\}</code>. The value part of the mapper is a list, because you may have multiple label variants from your event type for a single Amazon Fraud Detector label.
838
935
  * </p>
839
936
  */
840
937
  labelMapper?: Record<string, string[]>;
841
938
  /**
939
+ * @public
842
940
  * <p>The action to take for unlabeled events.</p>
843
941
  * <ul>
844
942
  * <li>
@@ -864,10 +962,12 @@ export interface LabelSchema {
864
962
  */
865
963
  export interface TrainingDataSchema {
866
964
  /**
965
+ * @public
867
966
  * <p>The training data schema variables.</p>
868
967
  */
869
968
  modelVariables: string[] | undefined;
870
969
  /**
970
+ * @public
871
971
  * <p>The label schema.</p>
872
972
  */
873
973
  labelSchema?: LabelSchema;
@@ -889,30 +989,37 @@ export type TrainingDataSourceEnum = (typeof TrainingDataSourceEnum)[keyof typeo
889
989
  */
890
990
  export interface CreateModelVersionRequest {
891
991
  /**
992
+ * @public
892
993
  * <p>The model ID. </p>
893
994
  */
894
995
  modelId: string | undefined;
895
996
  /**
997
+ * @public
896
998
  * <p>The model type.</p>
897
999
  */
898
1000
  modelType: ModelTypeEnum | string | undefined;
899
1001
  /**
1002
+ * @public
900
1003
  * <p>The training data source location in Amazon S3. </p>
901
1004
  */
902
1005
  trainingDataSource: TrainingDataSourceEnum | string | undefined;
903
1006
  /**
1007
+ * @public
904
1008
  * <p>The training data schema.</p>
905
1009
  */
906
1010
  trainingDataSchema: TrainingDataSchema | undefined;
907
1011
  /**
1012
+ * @public
908
1013
  * <p>Details of the external events data used for model version training. Required if <code>trainingDataSource</code> is <code>EXTERNAL_EVENTS</code>.</p>
909
1014
  */
910
1015
  externalEventsDetail?: ExternalEventsDetail;
911
1016
  /**
1017
+ * @public
912
1018
  * <p>Details of the ingested events data used for model version training. Required if <code>trainingDataSource</code> is <code>INGESTED_EVENTS</code>.</p>
913
1019
  */
914
1020
  ingestedEventsDetail?: IngestedEventsDetail;
915
1021
  /**
1022
+ * @public
916
1023
  * <p>A collection of key and value pairs.</p>
917
1024
  */
918
1025
  tags?: Tag[];
@@ -922,18 +1029,22 @@ export interface CreateModelVersionRequest {
922
1029
  */
923
1030
  export interface CreateModelVersionResult {
924
1031
  /**
1032
+ * @public
925
1033
  * <p>The model ID.</p>
926
1034
  */
927
1035
  modelId?: string;
928
1036
  /**
1037
+ * @public
929
1038
  * <p>The model type.</p>
930
1039
  */
931
1040
  modelType?: ModelTypeEnum | string;
932
1041
  /**
1042
+ * @public
933
1043
  * <p>The model version number of the model version created.</p>
934
1044
  */
935
1045
  modelVersionNumber?: string;
936
1046
  /**
1047
+ * @public
937
1048
  * <p>The model version status. </p>
938
1049
  */
939
1050
  status?: string;
@@ -954,30 +1065,37 @@ export type Language = (typeof Language)[keyof typeof Language];
954
1065
  */
955
1066
  export interface CreateRuleRequest {
956
1067
  /**
1068
+ * @public
957
1069
  * <p>The rule ID.</p>
958
1070
  */
959
1071
  ruleId: string | undefined;
960
1072
  /**
1073
+ * @public
961
1074
  * <p>The detector ID for the rule's parent detector.</p>
962
1075
  */
963
1076
  detectorId: string | undefined;
964
1077
  /**
1078
+ * @public
965
1079
  * <p>The rule description.</p>
966
1080
  */
967
1081
  description?: string;
968
1082
  /**
1083
+ * @public
969
1084
  * <p>The rule expression.</p>
970
1085
  */
971
1086
  expression: string | undefined;
972
1087
  /**
1088
+ * @public
973
1089
  * <p>The language of the rule.</p>
974
1090
  */
975
1091
  language: Language | string | undefined;
976
1092
  /**
1093
+ * @public
977
1094
  * <p>The outcome or outcomes returned when the rule expression matches.</p>
978
1095
  */
979
1096
  outcomes: string[] | undefined;
980
1097
  /**
1098
+ * @public
981
1099
  * <p>A collection of key and value pairs.</p>
982
1100
  */
983
1101
  tags?: Tag[];
@@ -987,6 +1105,7 @@ export interface CreateRuleRequest {
987
1105
  */
988
1106
  export interface CreateRuleResult {
989
1107
  /**
1108
+ * @public
990
1109
  * <p>The created rule.</p>
991
1110
  */
992
1111
  rule?: Rule;
@@ -996,26 +1115,32 @@ export interface CreateRuleResult {
996
1115
  */
997
1116
  export interface CreateVariableRequest {
998
1117
  /**
1118
+ * @public
999
1119
  * <p>The name of the variable.</p>
1000
1120
  */
1001
1121
  name: string | undefined;
1002
1122
  /**
1123
+ * @public
1003
1124
  * <p>The data type of the variable.</p>
1004
1125
  */
1005
1126
  dataType: DataType | string | undefined;
1006
1127
  /**
1128
+ * @public
1007
1129
  * <p>The source of the data.</p>
1008
1130
  */
1009
1131
  dataSource: DataSource | string | undefined;
1010
1132
  /**
1133
+ * @public
1011
1134
  * <p>The default value for the variable when no value is received.</p>
1012
1135
  */
1013
1136
  defaultValue: string | undefined;
1014
1137
  /**
1138
+ * @public
1015
1139
  * <p>The description.</p>
1016
1140
  */
1017
1141
  description?: string;
1018
1142
  /**
1143
+ * @public
1019
1144
  * <p>The variable type. For more information see <a href="https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types">Variable types</a>.
1020
1145
  * </p>
1021
1146
  * <p>Valid Values: <code>AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT</code>
@@ -1023,6 +1148,7 @@ export interface CreateVariableRequest {
1023
1148
  */
1024
1149
  variableType?: string;
1025
1150
  /**
1151
+ * @public
1026
1152
  * <p>A collection of key and value pairs.</p>
1027
1153
  */
1028
1154
  tags?: Tag[];
@@ -1037,6 +1163,7 @@ export interface CreateVariableResult {
1037
1163
  */
1038
1164
  export interface DeleteBatchImportJobRequest {
1039
1165
  /**
1166
+ * @public
1040
1167
  * <p>The ID of the batch import job to delete. </p>
1041
1168
  */
1042
1169
  jobId: string | undefined;
@@ -1051,6 +1178,7 @@ export interface DeleteBatchImportJobResult {
1051
1178
  */
1052
1179
  export interface DeleteBatchPredictionJobRequest {
1053
1180
  /**
1181
+ * @public
1054
1182
  * <p>The ID of the batch prediction job to delete.</p>
1055
1183
  */
1056
1184
  jobId: string | undefined;
@@ -1077,6 +1205,7 @@ export declare class ConflictException extends __BaseException {
1077
1205
  */
1078
1206
  export interface DeleteDetectorRequest {
1079
1207
  /**
1208
+ * @public
1080
1209
  * <p>The ID of the detector to delete.</p>
1081
1210
  */
1082
1211
  detectorId: string | undefined;
@@ -1091,10 +1220,12 @@ export interface DeleteDetectorResult {
1091
1220
  */
1092
1221
  export interface DeleteDetectorVersionRequest {
1093
1222
  /**
1223
+ * @public
1094
1224
  * <p>The ID of the parent detector for the detector version to delete.</p>
1095
1225
  */
1096
1226
  detectorId: string | undefined;
1097
1227
  /**
1228
+ * @public
1098
1229
  * <p>The ID of the detector version to delete.</p>
1099
1230
  */
1100
1231
  detectorVersionId: string | undefined;
@@ -1109,6 +1240,7 @@ export interface DeleteDetectorVersionResult {
1109
1240
  */
1110
1241
  export interface DeleteEntityTypeRequest {
1111
1242
  /**
1243
+ * @public
1112
1244
  * <p>The name of the entity type to delete.</p>
1113
1245
  */
1114
1246
  name: string | undefined;
@@ -1123,14 +1255,17 @@ export interface DeleteEntityTypeResult {
1123
1255
  */
1124
1256
  export interface DeleteEventRequest {
1125
1257
  /**
1258
+ * @public
1126
1259
  * <p>The ID of the event to delete.</p>
1127
1260
  */
1128
1261
  eventId: string | undefined;
1129
1262
  /**
1263
+ * @public
1130
1264
  * <p>The name of the event type.</p>
1131
1265
  */
1132
1266
  eventTypeName: string | undefined;
1133
1267
  /**
1268
+ * @public
1134
1269
  * <p>Specifies whether or not to delete any predictions associated with the event. If set to <code>True</code>, </p>
1135
1270
  */
1136
1271
  deleteAuditHistory?: boolean;
@@ -1145,6 +1280,7 @@ export interface DeleteEventResult {
1145
1280
  */
1146
1281
  export interface DeleteEventsByEventTypeRequest {
1147
1282
  /**
1283
+ * @public
1148
1284
  * <p>The name of the event type.</p>
1149
1285
  */
1150
1286
  eventTypeName: string | undefined;
@@ -1154,10 +1290,12 @@ export interface DeleteEventsByEventTypeRequest {
1154
1290
  */
1155
1291
  export interface DeleteEventsByEventTypeResult {
1156
1292
  /**
1293
+ * @public
1157
1294
  * <p>Name of event type for which to delete the events.</p>
1158
1295
  */
1159
1296
  eventTypeName?: string;
1160
1297
  /**
1298
+ * @public
1161
1299
  * <p>The status of the delete request.</p>
1162
1300
  */
1163
1301
  eventsDeletionStatus?: string;
@@ -1167,6 +1305,7 @@ export interface DeleteEventsByEventTypeResult {
1167
1305
  */
1168
1306
  export interface DeleteEventTypeRequest {
1169
1307
  /**
1308
+ * @public
1170
1309
  * <p>The name of the event type to delete.</p>
1171
1310
  */
1172
1311
  name: string | undefined;
@@ -1181,6 +1320,7 @@ export interface DeleteEventTypeResult {
1181
1320
  */
1182
1321
  export interface DeleteExternalModelRequest {
1183
1322
  /**
1323
+ * @public
1184
1324
  * <p>The endpoint of the Amazon Sagemaker model to delete.</p>
1185
1325
  */
1186
1326
  modelEndpoint: string | undefined;
@@ -1195,6 +1335,7 @@ export interface DeleteExternalModelResult {
1195
1335
  */
1196
1336
  export interface DeleteLabelRequest {
1197
1337
  /**
1338
+ * @public
1198
1339
  * <p>The name of the label to delete.</p>
1199
1340
  */
1200
1341
  name: string | undefined;
@@ -1209,6 +1350,7 @@ export interface DeleteLabelResult {
1209
1350
  */
1210
1351
  export interface DeleteListRequest {
1211
1352
  /**
1353
+ * @public
1212
1354
  * <p>
1213
1355
  * The name of the list to delete.
1214
1356
  * </p>
@@ -1225,10 +1367,12 @@ export interface DeleteListResult {
1225
1367
  */
1226
1368
  export interface DeleteModelRequest {
1227
1369
  /**
1370
+ * @public
1228
1371
  * <p>The model ID of the model to delete.</p>
1229
1372
  */
1230
1373
  modelId: string | undefined;
1231
1374
  /**
1375
+ * @public
1232
1376
  * <p>The model type of the model to delete.</p>
1233
1377
  */
1234
1378
  modelType: ModelTypeEnum | string | undefined;
@@ -1243,14 +1387,17 @@ export interface DeleteModelResult {
1243
1387
  */
1244
1388
  export interface DeleteModelVersionRequest {
1245
1389
  /**
1390
+ * @public
1246
1391
  * <p>The model ID of the model version to delete.</p>
1247
1392
  */
1248
1393
  modelId: string | undefined;
1249
1394
  /**
1395
+ * @public
1250
1396
  * <p>The model type of the model version to delete.</p>
1251
1397
  */
1252
1398
  modelType: ModelTypeEnum | string | undefined;
1253
1399
  /**
1400
+ * @public
1254
1401
  * <p>The model version number of the model version to delete.</p>
1255
1402
  */
1256
1403
  modelVersionNumber: string | undefined;
@@ -1265,6 +1412,7 @@ export interface DeleteModelVersionResult {
1265
1412
  */
1266
1413
  export interface DeleteOutcomeRequest {
1267
1414
  /**
1415
+ * @public
1268
1416
  * <p>The name of the outcome to delete.</p>
1269
1417
  */
1270
1418
  name: string | undefined;
@@ -1279,6 +1427,7 @@ export interface DeleteOutcomeResult {
1279
1427
  */
1280
1428
  export interface DeleteRuleRequest {
1281
1429
  /**
1430
+ * @public
1282
1431
  * <p>A rule.</p>
1283
1432
  */
1284
1433
  rule: Rule | undefined;
@@ -1293,6 +1442,7 @@ export interface DeleteRuleResult {
1293
1442
  */
1294
1443
  export interface DeleteVariableRequest {
1295
1444
  /**
1445
+ * @public
1296
1446
  * <p>The name of the variable to delete.</p>
1297
1447
  */
1298
1448
  name: string | undefined;
@@ -1307,14 +1457,17 @@ export interface DeleteVariableResult {
1307
1457
  */
1308
1458
  export interface DescribeDetectorRequest {
1309
1459
  /**
1460
+ * @public
1310
1461
  * <p>The detector ID.</p>
1311
1462
  */
1312
1463
  detectorId: string | undefined;
1313
1464
  /**
1465
+ * @public
1314
1466
  * <p>The next token from the previous response.</p>
1315
1467
  */
1316
1468
  nextToken?: string;
1317
1469
  /**
1470
+ * @public
1318
1471
  * <p>The maximum number of results to return for the request.</p>
1319
1472
  */
1320
1473
  maxResults?: number;
@@ -1325,18 +1478,22 @@ export interface DescribeDetectorRequest {
1325
1478
  */
1326
1479
  export interface DetectorVersionSummary {
1327
1480
  /**
1481
+ * @public
1328
1482
  * <p>The detector version ID. </p>
1329
1483
  */
1330
1484
  detectorVersionId?: string;
1331
1485
  /**
1486
+ * @public
1332
1487
  * <p>The detector version status. </p>
1333
1488
  */
1334
1489
  status?: DetectorVersionStatus | string;
1335
1490
  /**
1491
+ * @public
1336
1492
  * <p>The detector version description. </p>
1337
1493
  */
1338
1494
  description?: string;
1339
1495
  /**
1496
+ * @public
1340
1497
  * <p>Timestamp of when the detector version was last updated.</p>
1341
1498
  */
1342
1499
  lastUpdatedTime?: string;
@@ -1346,18 +1503,22 @@ export interface DetectorVersionSummary {
1346
1503
  */
1347
1504
  export interface DescribeDetectorResult {
1348
1505
  /**
1506
+ * @public
1349
1507
  * <p>The detector ID.</p>
1350
1508
  */
1351
1509
  detectorId?: string;
1352
1510
  /**
1511
+ * @public
1353
1512
  * <p>The status and description for each detector version.</p>
1354
1513
  */
1355
1514
  detectorVersionSummaries?: DetectorVersionSummary[];
1356
1515
  /**
1516
+ * @public
1357
1517
  * <p>The next token to be used for subsequent requests.</p>
1358
1518
  */
1359
1519
  nextToken?: string;
1360
1520
  /**
1521
+ * @public
1361
1522
  * <p>The detector ARN.</p>
1362
1523
  */
1363
1524
  arn?: string;
@@ -1367,22 +1528,27 @@ export interface DescribeDetectorResult {
1367
1528
  */
1368
1529
  export interface DescribeModelVersionsRequest {
1369
1530
  /**
1531
+ * @public
1370
1532
  * <p>The model ID.</p>
1371
1533
  */
1372
1534
  modelId?: string;
1373
1535
  /**
1536
+ * @public
1374
1537
  * <p>The model version number.</p>
1375
1538
  */
1376
1539
  modelVersionNumber?: string;
1377
1540
  /**
1541
+ * @public
1378
1542
  * <p>The model type.</p>
1379
1543
  */
1380
1544
  modelType?: ModelTypeEnum | string;
1381
1545
  /**
1546
+ * @public
1382
1547
  * <p>The next token from the previous results.</p>
1383
1548
  */
1384
1549
  nextToken?: string;
1385
1550
  /**
1551
+ * @public
1386
1552
  * <p>The maximum number of results to return.</p>
1387
1553
  */
1388
1554
  maxResults?: number;
@@ -1393,22 +1559,27 @@ export interface DescribeModelVersionsRequest {
1393
1559
  */
1394
1560
  export interface FieldValidationMessage {
1395
1561
  /**
1562
+ * @public
1396
1563
  * <p>The field name.</p>
1397
1564
  */
1398
1565
  fieldName?: string;
1399
1566
  /**
1567
+ * @public
1400
1568
  * <p>The message ID.</p>
1401
1569
  */
1402
1570
  identifier?: string;
1403
1571
  /**
1572
+ * @public
1404
1573
  * <p>The message title.</p>
1405
1574
  */
1406
1575
  title?: string;
1407
1576
  /**
1577
+ * @public
1408
1578
  * <p>The message content.</p>
1409
1579
  */
1410
1580
  content?: string;
1411
1581
  /**
1582
+ * @public
1412
1583
  * <p>The message type.</p>
1413
1584
  */
1414
1585
  type?: string;
@@ -1419,14 +1590,17 @@ export interface FieldValidationMessage {
1419
1590
  */
1420
1591
  export interface FileValidationMessage {
1421
1592
  /**
1593
+ * @public
1422
1594
  * <p>The message title.</p>
1423
1595
  */
1424
1596
  title?: string;
1425
1597
  /**
1598
+ * @public
1426
1599
  * <p>The message content.</p>
1427
1600
  */
1428
1601
  content?: string;
1429
1602
  /**
1603
+ * @public
1430
1604
  * <p>The message type.</p>
1431
1605
  */
1432
1606
  type?: string;
@@ -1437,10 +1611,12 @@ export interface FileValidationMessage {
1437
1611
  */
1438
1612
  export interface DataValidationMetrics {
1439
1613
  /**
1614
+ * @public
1440
1615
  * <p>The file-specific model training data validation messages.</p>
1441
1616
  */
1442
1617
  fileLevelMessages?: FileValidationMessage[];
1443
1618
  /**
1619
+ * @public
1444
1620
  * <p>The field-specific model training validation messages.</p>
1445
1621
  */
1446
1622
  fieldLevelMessages?: FieldValidationMessage[];
@@ -1451,18 +1627,22 @@ export interface DataValidationMetrics {
1451
1627
  */
1452
1628
  export interface MetricDataPoint {
1453
1629
  /**
1630
+ * @public
1454
1631
  * <p>The false positive rate. This is the percentage of total legitimate events that are incorrectly predicted as fraud.</p>
1455
1632
  */
1456
1633
  fpr?: number;
1457
1634
  /**
1635
+ * @public
1458
1636
  * <p>The percentage of fraud events correctly predicted as fraudulent as compared to all events predicted as fraudulent.</p>
1459
1637
  */
1460
1638
  precision?: number;
1461
1639
  /**
1640
+ * @public
1462
1641
  * <p>The true positive rate. This is the percentage of total fraud the model detects. Also known as capture rate.</p>
1463
1642
  */
1464
1643
  tpr?: number;
1465
1644
  /**
1645
+ * @public
1466
1646
  * <p>The model threshold that specifies an acceptable fraud capture rate. For example, a threshold of 500 means any model score 500 or above is labeled as fraud.</p>
1467
1647
  */
1468
1648
  threshold?: number;
@@ -1473,10 +1653,12 @@ export interface MetricDataPoint {
1473
1653
  */
1474
1654
  export interface TrainingMetrics {
1475
1655
  /**
1656
+ * @public
1476
1657
  * <p>The area under the curve. This summarizes true positive rate (TPR) and false positive rate (FPR) across all possible model score thresholds. A model with no predictive power has an AUC of 0.5, whereas a perfect model has a score of 1.0.</p>
1477
1658
  */
1478
1659
  auc?: number;
1479
1660
  /**
1661
+ * @public
1480
1662
  * <p>The data points details.</p>
1481
1663
  */
1482
1664
  metricDataPoints?: MetricDataPoint[];
@@ -1487,14 +1669,17 @@ export interface TrainingMetrics {
1487
1669
  */
1488
1670
  export interface LogOddsMetric {
1489
1671
  /**
1672
+ * @public
1490
1673
  * <p>The name of the variable.</p>
1491
1674
  */
1492
1675
  variableName: string | undefined;
1493
1676
  /**
1677
+ * @public
1494
1678
  * <p>The type of variable.</p>
1495
1679
  */
1496
1680
  variableType: string | undefined;
1497
1681
  /**
1682
+ * @public
1498
1683
  * <p>The relative importance of the variable. For more information, see <a href="https://docs.aws.amazon.com/frauddetector/latest/ug/model-variable-importance.html">Model variable importance</a>.</p>
1499
1684
  */
1500
1685
  variableImportance: number | undefined;
@@ -1505,6 +1690,7 @@ export interface LogOddsMetric {
1505
1690
  */
1506
1691
  export interface VariableImportanceMetrics {
1507
1692
  /**
1693
+ * @public
1508
1694
  * <p>List of variable metrics.</p>
1509
1695
  */
1510
1696
  logOddsMetrics?: LogOddsMetric[];
@@ -1515,14 +1701,17 @@ export interface VariableImportanceMetrics {
1515
1701
  */
1516
1702
  export interface TrainingResult {
1517
1703
  /**
1704
+ * @public
1518
1705
  * <p>The validation metrics.</p>
1519
1706
  */
1520
1707
  dataValidationMetrics?: DataValidationMetrics;
1521
1708
  /**
1709
+ * @public
1522
1710
  * <p>The training metric details.</p>
1523
1711
  */
1524
1712
  trainingMetrics?: TrainingMetrics;
1525
1713
  /**
1714
+ * @public
1526
1715
  * <p>The variable importance metrics.</p>
1527
1716
  */
1528
1717
  variableImportanceMetrics?: VariableImportanceMetrics;
@@ -1535,24 +1724,28 @@ export interface TrainingResult {
1535
1724
  */
1536
1725
  export interface OFIMetricDataPoint {
1537
1726
  /**
1727
+ * @public
1538
1728
  * <p>
1539
1729
  * The false positive rate. This is the percentage of total legitimate events that are incorrectly predicted as fraud.
1540
1730
  * </p>
1541
1731
  */
1542
1732
  fpr?: number;
1543
1733
  /**
1734
+ * @public
1544
1735
  * <p>
1545
1736
  * The percentage of fraud events correctly predicted as fraudulent as compared to all events predicted as fraudulent.
1546
1737
  * </p>
1547
1738
  */
1548
1739
  precision?: number;
1549
1740
  /**
1741
+ * @public
1550
1742
  * <p>
1551
1743
  * The true positive rate. This is the percentage of total fraud the model detects. Also known as capture rate.
1552
1744
  * </p>
1553
1745
  */
1554
1746
  tpr?: number;
1555
1747
  /**
1748
+ * @public
1556
1749
  * <p>
1557
1750
  * The model threshold that specifies an acceptable fraud capture rate. For example, a threshold of 500 means any model score 500 or above is labeled as fraud.
1558
1751
  * </p>
@@ -1568,12 +1761,14 @@ export interface OFIMetricDataPoint {
1568
1761
  */
1569
1762
  export interface UncertaintyRange {
1570
1763
  /**
1764
+ * @public
1571
1765
  * <p>
1572
1766
  * The lower bound value of the area under curve (auc).
1573
1767
  * </p>
1574
1768
  */
1575
1769
  lowerBoundValue: number | undefined;
1576
1770
  /**
1771
+ * @public
1577
1772
  * <p>
1578
1773
  * The upper bound value of the area under curve (auc).
1579
1774
  * </p>
@@ -1588,12 +1783,14 @@ export interface UncertaintyRange {
1588
1783
  */
1589
1784
  export interface OFIModelPerformance {
1590
1785
  /**
1786
+ * @public
1591
1787
  * <p>
1592
1788
  * The area under the curve (auc). This summarizes the total positive rate (tpr) and false positive rate (FPR) across all possible model score thresholds.
1593
1789
  * </p>
1594
1790
  */
1595
1791
  auc?: number;
1596
1792
  /**
1793
+ * @public
1597
1794
  * <p>
1598
1795
  * Indicates the range of area under curve (auc) expected from the OFI model. A range greater than 0.1 indicates higher model uncertainity.
1599
1796
  * </p>
@@ -1608,12 +1805,14 @@ export interface OFIModelPerformance {
1608
1805
  */
1609
1806
  export interface OFITrainingMetricsValue {
1610
1807
  /**
1808
+ * @public
1611
1809
  * <p>
1612
1810
  * The model's performance metrics data points.
1613
1811
  * </p>
1614
1812
  */
1615
1813
  metricDataPoints?: OFIMetricDataPoint[];
1616
1814
  /**
1815
+ * @public
1617
1816
  * <p>
1618
1817
  * The model's overall performance score.
1619
1818
  * </p>
@@ -1628,24 +1827,28 @@ export interface OFITrainingMetricsValue {
1628
1827
  */
1629
1828
  export interface TFIMetricDataPoint {
1630
1829
  /**
1830
+ * @public
1631
1831
  * <p>
1632
1832
  * The false positive rate. This is the percentage of total legitimate events that are incorrectly predicted as fraud.
1633
1833
  * </p>
1634
1834
  */
1635
1835
  fpr?: number;
1636
1836
  /**
1837
+ * @public
1637
1838
  * <p>
1638
1839
  * The percentage of fraud events correctly predicted as fraudulent as compared to all events predicted as fraudulent.
1639
1840
  * </p>
1640
1841
  */
1641
1842
  precision?: number;
1642
1843
  /**
1844
+ * @public
1643
1845
  * <p>
1644
1846
  * The true positive rate. This is the percentage of total fraud the model detects. Also known as capture rate.
1645
1847
  * </p>
1646
1848
  */
1647
1849
  tpr?: number;
1648
1850
  /**
1851
+ * @public
1649
1852
  * <p>
1650
1853
  * The model threshold that specifies an acceptable fraud capture rate. For example, a threshold of 500 means any
1651
1854
  * model score 500 or above is labeled as fraud.
@@ -1661,12 +1864,14 @@ export interface TFIMetricDataPoint {
1661
1864
  */
1662
1865
  export interface TFIModelPerformance {
1663
1866
  /**
1867
+ * @public
1664
1868
  * <p>
1665
1869
  * The area under the curve (auc). This summarizes the total positive rate (tpr) and false positive rate (FPR) across all possible model score thresholds.
1666
1870
  * </p>
1667
1871
  */
1668
1872
  auc?: number;
1669
1873
  /**
1874
+ * @public
1670
1875
  * <p>
1671
1876
  * Indicates the range of area under curve (auc) expected from the TFI model. A range greater than 0.1 indicates higher model uncertainity.
1672
1877
  * </p>
@@ -1681,12 +1886,14 @@ export interface TFIModelPerformance {
1681
1886
  */
1682
1887
  export interface TFITrainingMetricsValue {
1683
1888
  /**
1889
+ * @public
1684
1890
  * <p>
1685
1891
  * The model's performance metrics data points.
1686
1892
  * </p>
1687
1893
  */
1688
1894
  metricDataPoints?: TFIMetricDataPoint[];
1689
1895
  /**
1896
+ * @public
1690
1897
  * <p>
1691
1898
  * The model performance score.
1692
1899
  * </p>
@@ -1701,18 +1908,21 @@ export interface TFITrainingMetricsValue {
1701
1908
  */
1702
1909
  export interface TrainingMetricsV2 {
1703
1910
  /**
1911
+ * @public
1704
1912
  * <p>
1705
1913
  * The Online Fraud Insights (OFI) model training metric details.
1706
1914
  * </p>
1707
1915
  */
1708
1916
  ofi?: OFITrainingMetricsValue;
1709
1917
  /**
1918
+ * @public
1710
1919
  * <p>
1711
1920
  * The Transaction Fraud Insights (TFI) model training metric details.
1712
1921
  * </p>
1713
1922
  */
1714
1923
  tfi?: TFITrainingMetricsValue;
1715
1924
  /**
1925
+ * @public
1716
1926
  * <p>
1717
1927
  * The Account Takeover Insights (ATI) model training metric details.
1718
1928
  * </p>
@@ -1727,20 +1937,24 @@ export interface TrainingMetricsV2 {
1727
1937
  */
1728
1938
  export interface TrainingResultV2 {
1729
1939
  /**
1940
+ * @public
1730
1941
  * <p>The model training data validation metrics.</p>
1731
1942
  */
1732
1943
  dataValidationMetrics?: DataValidationMetrics;
1733
1944
  /**
1945
+ * @public
1734
1946
  * <p>
1735
1947
  * The training metric details.
1736
1948
  * </p>
1737
1949
  */
1738
1950
  trainingMetricsV2?: TrainingMetricsV2;
1739
1951
  /**
1952
+ * @public
1740
1953
  * <p>The variable importance metrics details.</p>
1741
1954
  */
1742
1955
  variableImportanceMetrics?: VariableImportanceMetrics;
1743
1956
  /**
1957
+ * @public
1744
1958
  * <p>
1745
1959
  * The variable importance metrics of the aggregated variables.
1746
1960
  * </p>
@@ -1756,54 +1970,67 @@ export interface TrainingResultV2 {
1756
1970
  */
1757
1971
  export interface ModelVersionDetail {
1758
1972
  /**
1973
+ * @public
1759
1974
  * <p>The model ID.</p>
1760
1975
  */
1761
1976
  modelId?: string;
1762
1977
  /**
1978
+ * @public
1763
1979
  * <p>The model type.</p>
1764
1980
  */
1765
1981
  modelType?: ModelTypeEnum | string;
1766
1982
  /**
1983
+ * @public
1767
1984
  * <p>The model version number.</p>
1768
1985
  */
1769
1986
  modelVersionNumber?: string;
1770
1987
  /**
1988
+ * @public
1771
1989
  * <p>The status of the model version.</p>
1772
1990
  */
1773
1991
  status?: string;
1774
1992
  /**
1993
+ * @public
1775
1994
  * <p>The model version training data source.</p>
1776
1995
  */
1777
1996
  trainingDataSource?: TrainingDataSourceEnum | string;
1778
1997
  /**
1998
+ * @public
1779
1999
  * <p>The training data schema.</p>
1780
2000
  */
1781
2001
  trainingDataSchema?: TrainingDataSchema;
1782
2002
  /**
2003
+ * @public
1783
2004
  * <p>The external events data details. This will be populated if the <code>trainingDataSource</code> for the model version is specified as <code>EXTERNAL_EVENTS</code>.</p>
1784
2005
  */
1785
2006
  externalEventsDetail?: ExternalEventsDetail;
1786
2007
  /**
2008
+ * @public
1787
2009
  * <p>The ingested events data details. This will be populated if the <code>trainingDataSource</code> for the model version is specified as <code>INGESTED_EVENTS</code>.</p>
1788
2010
  */
1789
2011
  ingestedEventsDetail?: IngestedEventsDetail;
1790
2012
  /**
2013
+ * @public
1791
2014
  * <p>The training results.</p>
1792
2015
  */
1793
2016
  trainingResult?: TrainingResult;
1794
2017
  /**
2018
+ * @public
1795
2019
  * <p>The timestamp when the model was last updated.</p>
1796
2020
  */
1797
2021
  lastUpdatedTime?: string;
1798
2022
  /**
2023
+ * @public
1799
2024
  * <p>The timestamp when the model was created.</p>
1800
2025
  */
1801
2026
  createdTime?: string;
1802
2027
  /**
2028
+ * @public
1803
2029
  * <p>The model version ARN.</p>
1804
2030
  */
1805
2031
  arn?: string;
1806
2032
  /**
2033
+ * @public
1807
2034
  * <p>
1808
2035
  * The training result details. The details include the relative importance of the variables.
1809
2036
  * </p>
@@ -1815,10 +2042,12 @@ export interface ModelVersionDetail {
1815
2042
  */
1816
2043
  export interface DescribeModelVersionsResult {
1817
2044
  /**
2045
+ * @public
1818
2046
  * <p>The model version details.</p>
1819
2047
  */
1820
2048
  modelVersionDetails?: ModelVersionDetail[];
1821
2049
  /**
2050
+ * @public
1822
2051
  * <p>The next token.</p>
1823
2052
  */
1824
2053
  nextToken?: string;
@@ -1828,14 +2057,17 @@ export interface DescribeModelVersionsResult {
1828
2057
  */
1829
2058
  export interface GetBatchImportJobsRequest {
1830
2059
  /**
2060
+ * @public
1831
2061
  * <p>The ID of the batch import job to get.</p>
1832
2062
  */
1833
2063
  jobId?: string;
1834
2064
  /**
2065
+ * @public
1835
2066
  * <p>The maximum number of objects to return for request.</p>
1836
2067
  */
1837
2068
  maxResults?: number;
1838
2069
  /**
2070
+ * @public
1839
2071
  * <p>The next token from the previous request.</p>
1840
2072
  */
1841
2073
  nextToken?: string;
@@ -1846,54 +2078,67 @@ export interface GetBatchImportJobsRequest {
1846
2078
  */
1847
2079
  export interface BatchImport {
1848
2080
  /**
2081
+ * @public
1849
2082
  * <p>The ID of the batch import job. </p>
1850
2083
  */
1851
2084
  jobId?: string;
1852
2085
  /**
2086
+ * @public
1853
2087
  * <p>The status of the batch import job.</p>
1854
2088
  */
1855
2089
  status?: AsyncJobStatus | string;
1856
2090
  /**
2091
+ * @public
1857
2092
  * <p>The reason batch import job failed.</p>
1858
2093
  */
1859
2094
  failureReason?: string;
1860
2095
  /**
2096
+ * @public
1861
2097
  * <p>Timestamp of when the batch import job started.</p>
1862
2098
  */
1863
2099
  startTime?: string;
1864
2100
  /**
2101
+ * @public
1865
2102
  * <p>Timestamp of when batch import job completed.</p>
1866
2103
  */
1867
2104
  completionTime?: string;
1868
2105
  /**
2106
+ * @public
1869
2107
  * <p>The Amazon S3 location of your data file for batch import.</p>
1870
2108
  */
1871
2109
  inputPath?: string;
1872
2110
  /**
2111
+ * @public
1873
2112
  * <p>The Amazon S3 location of your output file.</p>
1874
2113
  */
1875
2114
  outputPath?: string;
1876
2115
  /**
2116
+ * @public
1877
2117
  * <p>The name of the event type.</p>
1878
2118
  */
1879
2119
  eventTypeName?: string;
1880
2120
  /**
2121
+ * @public
1881
2122
  * <p>The ARN of the IAM role to use for this job request.</p>
1882
2123
  */
1883
2124
  iamRoleArn?: string;
1884
2125
  /**
2126
+ * @public
1885
2127
  * <p>The ARN of the batch import job.</p>
1886
2128
  */
1887
2129
  arn?: string;
1888
2130
  /**
2131
+ * @public
1889
2132
  * <p>The number of records processed by batch import job.</p>
1890
2133
  */
1891
2134
  processedRecordsCount?: number;
1892
2135
  /**
2136
+ * @public
1893
2137
  * <p>The number of records that failed to import. </p>
1894
2138
  */
1895
2139
  failedRecordsCount?: number;
1896
2140
  /**
2141
+ * @public
1897
2142
  * <p>The total number of records in the batch import job.</p>
1898
2143
  */
1899
2144
  totalRecordsCount?: number;
@@ -1903,10 +2148,12 @@ export interface BatchImport {
1903
2148
  */
1904
2149
  export interface GetBatchImportJobsResult {
1905
2150
  /**
2151
+ * @public
1906
2152
  * <p>An array containing the details of each batch import job.</p>
1907
2153
  */
1908
2154
  batchImports?: BatchImport[];
1909
2155
  /**
2156
+ * @public
1910
2157
  * <p>The next token for the subsequent resquest.</p>
1911
2158
  */
1912
2159
  nextToken?: string;
@@ -1916,14 +2163,17 @@ export interface GetBatchImportJobsResult {
1916
2163
  */
1917
2164
  export interface GetBatchPredictionJobsRequest {
1918
2165
  /**
2166
+ * @public
1919
2167
  * <p>The batch prediction job for which to get the details.</p>
1920
2168
  */
1921
2169
  jobId?: string;
1922
2170
  /**
2171
+ * @public
1923
2172
  * <p>The maximum number of objects to return for the request.</p>
1924
2173
  */
1925
2174
  maxResults?: number;
1926
2175
  /**
2176
+ * @public
1927
2177
  * <p>The next token from the previous request.</p>
1928
2178
  */
1929
2179
  nextToken?: string;
@@ -1934,62 +2184,77 @@ export interface GetBatchPredictionJobsRequest {
1934
2184
  */
1935
2185
  export interface BatchPrediction {
1936
2186
  /**
2187
+ * @public
1937
2188
  * <p>The job ID for the batch prediction.</p>
1938
2189
  */
1939
2190
  jobId?: string;
1940
2191
  /**
2192
+ * @public
1941
2193
  * <p>The batch prediction status.</p>
1942
2194
  */
1943
2195
  status?: AsyncJobStatus | string;
1944
2196
  /**
2197
+ * @public
1945
2198
  * <p>The reason a batch prediction job failed.</p>
1946
2199
  */
1947
2200
  failureReason?: string;
1948
2201
  /**
2202
+ * @public
1949
2203
  * <p>Timestamp of when the batch prediction job started.</p>
1950
2204
  */
1951
2205
  startTime?: string;
1952
2206
  /**
2207
+ * @public
1953
2208
  * <p>Timestamp of when the batch prediction job completed.</p>
1954
2209
  */
1955
2210
  completionTime?: string;
1956
2211
  /**
2212
+ * @public
1957
2213
  * <p>Timestamp of most recent heartbeat indicating the batch prediction job was making progress.</p>
1958
2214
  */
1959
2215
  lastHeartbeatTime?: string;
1960
2216
  /**
2217
+ * @public
1961
2218
  * <p>The Amazon S3 location of your training file.</p>
1962
2219
  */
1963
2220
  inputPath?: string;
1964
2221
  /**
2222
+ * @public
1965
2223
  * <p>The Amazon S3 location of your output file.</p>
1966
2224
  */
1967
2225
  outputPath?: string;
1968
2226
  /**
2227
+ * @public
1969
2228
  * <p>The name of the event type.</p>
1970
2229
  */
1971
2230
  eventTypeName?: string;
1972
2231
  /**
2232
+ * @public
1973
2233
  * <p>The name of the detector.</p>
1974
2234
  */
1975
2235
  detectorName?: string;
1976
2236
  /**
2237
+ * @public
1977
2238
  * <p>The detector version. </p>
1978
2239
  */
1979
2240
  detectorVersion?: string;
1980
2241
  /**
2242
+ * @public
1981
2243
  * <p>The ARN of the IAM role to use for this job request.</p>
1982
2244
  */
1983
2245
  iamRoleArn?: string;
1984
2246
  /**
2247
+ * @public
1985
2248
  * <p>The ARN of batch prediction job.</p>
1986
2249
  */
1987
2250
  arn?: string;
1988
2251
  /**
2252
+ * @public
1989
2253
  * <p>The number of records processed by the batch prediction job.</p>
1990
2254
  */
1991
2255
  processedRecordsCount?: number;
1992
2256
  /**
2257
+ * @public
1993
2258
  * <p>The total number of records in the batch prediction job.</p>
1994
2259
  */
1995
2260
  totalRecordsCount?: number;
@@ -1999,10 +2264,12 @@ export interface BatchPrediction {
1999
2264
  */
2000
2265
  export interface GetBatchPredictionJobsResult {
2001
2266
  /**
2267
+ * @public
2002
2268
  * <p>An array containing the details of each batch prediction job.</p>
2003
2269
  */
2004
2270
  batchPredictions?: BatchPrediction[];
2005
2271
  /**
2272
+ * @public
2006
2273
  * <p>The next token for the subsequent request.</p>
2007
2274
  */
2008
2275
  nextToken?: string;
@@ -2012,6 +2279,7 @@ export interface GetBatchPredictionJobsResult {
2012
2279
  */
2013
2280
  export interface GetDeleteEventsByEventTypeStatusRequest {
2014
2281
  /**
2282
+ * @public
2015
2283
  * <p>Name of event type for which to get the deletion status.</p>
2016
2284
  */
2017
2285
  eventTypeName: string | undefined;
@@ -2021,10 +2289,12 @@ export interface GetDeleteEventsByEventTypeStatusRequest {
2021
2289
  */
2022
2290
  export interface GetDeleteEventsByEventTypeStatusResult {
2023
2291
  /**
2292
+ * @public
2024
2293
  * <p>The event type name.</p>
2025
2294
  */
2026
2295
  eventTypeName?: string;
2027
2296
  /**
2297
+ * @public
2028
2298
  * <p>The deletion status.</p>
2029
2299
  */
2030
2300
  eventsDeletionStatus?: AsyncJobStatus | string;
@@ -2034,14 +2304,17 @@ export interface GetDeleteEventsByEventTypeStatusResult {
2034
2304
  */
2035
2305
  export interface GetDetectorsRequest {
2036
2306
  /**
2307
+ * @public
2037
2308
  * <p>The detector ID.</p>
2038
2309
  */
2039
2310
  detectorId?: string;
2040
2311
  /**
2312
+ * @public
2041
2313
  * <p>The next token for the subsequent request.</p>
2042
2314
  */
2043
2315
  nextToken?: string;
2044
2316
  /**
2317
+ * @public
2045
2318
  * <p>The maximum number of objects to return for the request.</p>
2046
2319
  */
2047
2320
  maxResults?: number;
@@ -2052,26 +2325,32 @@ export interface GetDetectorsRequest {
2052
2325
  */
2053
2326
  export interface Detector {
2054
2327
  /**
2328
+ * @public
2055
2329
  * <p>The detector ID.</p>
2056
2330
  */
2057
2331
  detectorId?: string;
2058
2332
  /**
2333
+ * @public
2059
2334
  * <p>The detector description.</p>
2060
2335
  */
2061
2336
  description?: string;
2062
2337
  /**
2338
+ * @public
2063
2339
  * <p>The name of the event type.</p>
2064
2340
  */
2065
2341
  eventTypeName?: string;
2066
2342
  /**
2343
+ * @public
2067
2344
  * <p>Timestamp of when the detector was last updated.</p>
2068
2345
  */
2069
2346
  lastUpdatedTime?: string;
2070
2347
  /**
2348
+ * @public
2071
2349
  * <p>Timestamp of when the detector was created.</p>
2072
2350
  */
2073
2351
  createdTime?: string;
2074
2352
  /**
2353
+ * @public
2075
2354
  * <p>The detector ARN.</p>
2076
2355
  */
2077
2356
  arn?: string;
@@ -2081,10 +2360,12 @@ export interface Detector {
2081
2360
  */
2082
2361
  export interface GetDetectorsResult {
2083
2362
  /**
2363
+ * @public
2084
2364
  * <p>The detectors.</p>
2085
2365
  */
2086
2366
  detectors?: Detector[];
2087
2367
  /**
2368
+ * @public
2088
2369
  * <p>The next page token.</p>
2089
2370
  */
2090
2371
  nextToken?: string;
@@ -2094,10 +2375,12 @@ export interface GetDetectorsResult {
2094
2375
  */
2095
2376
  export interface GetDetectorVersionRequest {
2096
2377
  /**
2378
+ * @public
2097
2379
  * <p>The detector ID.</p>
2098
2380
  */
2099
2381
  detectorId: string | undefined;
2100
2382
  /**
2383
+ * @public
2101
2384
  * <p>The detector version ID.</p>
2102
2385
  */
2103
2386
  detectorVersionId: string | undefined;
@@ -2107,43 +2390,53 @@ export interface GetDetectorVersionRequest {
2107
2390
  */
2108
2391
  export interface GetDetectorVersionResult {
2109
2392
  /**
2393
+ * @public
2110
2394
  * <p>The detector ID.</p>
2111
2395
  */
2112
2396
  detectorId?: string;
2113
2397
  /**
2398
+ * @public
2114
2399
  * <p>The detector version ID.</p>
2115
2400
  */
2116
2401
  detectorVersionId?: string;
2117
2402
  /**
2403
+ * @public
2118
2404
  * <p>The detector version description.</p>
2119
2405
  */
2120
2406
  description?: string;
2121
2407
  /**
2408
+ * @public
2122
2409
  * <p>The Amazon SageMaker model endpoints included in the detector version.</p>
2123
2410
  */
2124
2411
  externalModelEndpoints?: string[];
2125
2412
  /**
2413
+ * @public
2126
2414
  * <p>The model versions included in the detector version. </p>
2127
2415
  */
2128
2416
  modelVersions?: ModelVersion[];
2129
2417
  /**
2418
+ * @public
2130
2419
  * <p>The rules included in the detector version.</p>
2131
2420
  */
2132
2421
  rules?: Rule[];
2133
2422
  /**
2423
+ * @public
2134
2424
  * <p>The status of the detector version.</p>
2135
2425
  */
2136
2426
  status?: DetectorVersionStatus | string;
2137
2427
  /**
2428
+ * @public
2138
2429
  * <p>The timestamp when the detector version was last updated.
2139
2430
  * </p>
2140
2431
  */
2141
2432
  lastUpdatedTime?: string;
2142
2433
  /**
2434
+ * @public
2143
2435
  * <p>The timestamp when the detector version was created. </p>
2144
2436
  */
2145
2437
  createdTime?: string;
2146
2438
  /**
2439
+ * @public
2147
2440
  * <p>The execution mode of the rule in the dectector</p>
2148
2441
  * <p>
2149
2442
  * <code>FIRST_MATCHED</code> indicates that Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.</p>
@@ -2152,6 +2445,7 @@ export interface GetDetectorVersionResult {
2152
2445
  */
2153
2446
  ruleExecutionMode?: RuleExecutionMode | string;
2154
2447
  /**
2448
+ * @public
2155
2449
  * <p>The detector version ARN.</p>
2156
2450
  */
2157
2451
  arn?: string;
@@ -2161,14 +2455,17 @@ export interface GetDetectorVersionResult {
2161
2455
  */
2162
2456
  export interface GetEntityTypesRequest {
2163
2457
  /**
2458
+ * @public
2164
2459
  * <p>The name.</p>
2165
2460
  */
2166
2461
  name?: string;
2167
2462
  /**
2463
+ * @public
2168
2464
  * <p>The next token for the subsequent request.</p>
2169
2465
  */
2170
2466
  nextToken?: string;
2171
2467
  /**
2468
+ * @public
2172
2469
  * <p>The maximum number of objects to return for the request.</p>
2173
2470
  */
2174
2471
  maxResults?: number;
@@ -2179,22 +2476,27 @@ export interface GetEntityTypesRequest {
2179
2476
  */
2180
2477
  export interface EntityType {
2181
2478
  /**
2479
+ * @public
2182
2480
  * <p>The entity type name.</p>
2183
2481
  */
2184
2482
  name?: string;
2185
2483
  /**
2484
+ * @public
2186
2485
  * <p>The entity type description.</p>
2187
2486
  */
2188
2487
  description?: string;
2189
2488
  /**
2489
+ * @public
2190
2490
  * <p>Timestamp of when the entity type was last updated.</p>
2191
2491
  */
2192
2492
  lastUpdatedTime?: string;
2193
2493
  /**
2494
+ * @public
2194
2495
  * <p>Timestamp of when the entity type was created.</p>
2195
2496
  */
2196
2497
  createdTime?: string;
2197
2498
  /**
2499
+ * @public
2198
2500
  * <p>The entity type ARN.</p>
2199
2501
  */
2200
2502
  arn?: string;
@@ -2204,10 +2506,12 @@ export interface EntityType {
2204
2506
  */
2205
2507
  export interface GetEntityTypesResult {
2206
2508
  /**
2509
+ * @public
2207
2510
  * <p>An array of entity types.</p>
2208
2511
  */
2209
2512
  entityTypes?: EntityType[];
2210
2513
  /**
2514
+ * @public
2211
2515
  * <p>The next page token.</p>
2212
2516
  */
2213
2517
  nextToken?: string;
@@ -2217,10 +2521,12 @@ export interface GetEntityTypesResult {
2217
2521
  */
2218
2522
  export interface GetEventRequest {
2219
2523
  /**
2524
+ * @public
2220
2525
  * <p>The ID of the event to retrieve.</p>
2221
2526
  */
2222
2527
  eventId: string | undefined;
2223
2528
  /**
2529
+ * @public
2224
2530
  * <p>The event type of the event to retrieve.</p>
2225
2531
  */
2226
2532
  eventTypeName: string | undefined;
@@ -2231,10 +2537,12 @@ export interface GetEventRequest {
2231
2537
  */
2232
2538
  export interface Entity {
2233
2539
  /**
2540
+ * @public
2234
2541
  * <p>The entity type.</p>
2235
2542
  */
2236
2543
  entityType: string | undefined;
2237
2544
  /**
2545
+ * @public
2238
2546
  * <p>The entity ID. If you do not know the <code>entityId</code>, you can pass <code>unknown</code>, which is areserved string literal.</p>
2239
2547
  */
2240
2548
  entityId: string | undefined;
@@ -2245,30 +2553,37 @@ export interface Entity {
2245
2553
  */
2246
2554
  export interface Event {
2247
2555
  /**
2556
+ * @public
2248
2557
  * <p>The event ID.</p>
2249
2558
  */
2250
2559
  eventId?: string;
2251
2560
  /**
2561
+ * @public
2252
2562
  * <p>The event type.</p>
2253
2563
  */
2254
2564
  eventTypeName?: string;
2255
2565
  /**
2566
+ * @public
2256
2567
  * <p>The timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.</p>
2257
2568
  */
2258
2569
  eventTimestamp?: string;
2259
2570
  /**
2571
+ * @public
2260
2572
  * <p>Names of the event type's variables you defined in Amazon Fraud Detector to represent data elements and their corresponding values for the event you are sending for evaluation.</p>
2261
2573
  */
2262
2574
  eventVariables?: Record<string, string>;
2263
2575
  /**
2576
+ * @public
2264
2577
  * <p>The label associated with the event.</p>
2265
2578
  */
2266
2579
  currentLabel?: string;
2267
2580
  /**
2581
+ * @public
2268
2582
  * <p>The timestamp associated with the label to update. The timestamp must be specified using ISO 8601 standard in UTC.</p>
2269
2583
  */
2270
2584
  labelTimestamp?: string;
2271
2585
  /**
2586
+ * @public
2272
2587
  * <p>The event entities.</p>
2273
2588
  */
2274
2589
  entities?: Entity[];
@@ -2278,6 +2593,7 @@ export interface Event {
2278
2593
  */
2279
2594
  export interface GetEventResult {
2280
2595
  /**
2596
+ * @public
2281
2597
  * <p>The details of the event.</p>
2282
2598
  */
2283
2599
  event?: Event;
@@ -2288,10 +2604,12 @@ export interface GetEventResult {
2288
2604
  */
2289
2605
  export interface ModelEndpointDataBlob {
2290
2606
  /**
2607
+ * @public
2291
2608
  * <p>The byte buffer of the Amazon SageMaker model endpoint input data blob.</p>
2292
2609
  */
2293
2610
  byteBuffer?: Uint8Array;
2294
2611
  /**
2612
+ * @public
2295
2613
  * <p>The content type of the Amazon SageMaker model endpoint input data blob. </p>
2296
2614
  */
2297
2615
  contentType?: string;
@@ -2301,30 +2619,37 @@ export interface ModelEndpointDataBlob {
2301
2619
  */
2302
2620
  export interface GetEventPredictionRequest {
2303
2621
  /**
2622
+ * @public
2304
2623
  * <p>The detector ID.</p>
2305
2624
  */
2306
2625
  detectorId: string | undefined;
2307
2626
  /**
2627
+ * @public
2308
2628
  * <p>The detector version ID.</p>
2309
2629
  */
2310
2630
  detectorVersionId?: string;
2311
2631
  /**
2632
+ * @public
2312
2633
  * <p>The unique ID used to identify the event.</p>
2313
2634
  */
2314
2635
  eventId: string | undefined;
2315
2636
  /**
2637
+ * @public
2316
2638
  * <p>The event type associated with the detector specified for the prediction.</p>
2317
2639
  */
2318
2640
  eventTypeName: string | undefined;
2319
2641
  /**
2642
+ * @public
2320
2643
  * <p>The entity type (associated with the detector's event type) and specific entity ID representing who performed the event. If an entity id is not available, use "UNKNOWN."</p>
2321
2644
  */
2322
2645
  entities: Entity[] | undefined;
2323
2646
  /**
2647
+ * @public
2324
2648
  * <p>Timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.</p>
2325
2649
  */
2326
2650
  eventTimestamp: string | undefined;
2327
2651
  /**
2652
+ * @public
2328
2653
  * <p>Names of the event type's variables you defined in Amazon Fraud Detector to represent data elements and
2329
2654
  * their corresponding values for the event you are sending for evaluation.</p>
2330
2655
  * <important>
@@ -2344,6 +2669,7 @@ export interface GetEventPredictionRequest {
2344
2669
  */
2345
2670
  eventVariables: Record<string, string> | undefined;
2346
2671
  /**
2672
+ * @public
2347
2673
  * <p>The Amazon SageMaker model endpoint input data blobs.</p>
2348
2674
  */
2349
2675
  externalModelEndpointDataBlobs?: Record<string, ModelEndpointDataBlob>;
@@ -2365,10 +2691,12 @@ export type ModelSource = (typeof ModelSource)[keyof typeof ModelSource];
2365
2691
  */
2366
2692
  export interface ExternalModelSummary {
2367
2693
  /**
2694
+ * @public
2368
2695
  * <p>The endpoint of the Amazon SageMaker model.</p>
2369
2696
  */
2370
2697
  modelEndpoint?: string;
2371
2698
  /**
2699
+ * @public
2372
2700
  * <p>The source of the model.</p>
2373
2701
  */
2374
2702
  modelSource?: ModelSource | string;
@@ -2379,10 +2707,12 @@ export interface ExternalModelSummary {
2379
2707
  */
2380
2708
  export interface ExternalModelOutputs {
2381
2709
  /**
2710
+ * @public
2382
2711
  * <p>The Amazon SageMaker model.</p>
2383
2712
  */
2384
2713
  externalModel?: ExternalModelSummary;
2385
2714
  /**
2715
+ * @public
2386
2716
  * <p>The fraud prediction scores from Amazon SageMaker model.</p>
2387
2717
  */
2388
2718
  outputs?: Record<string, string>;
@@ -2393,10 +2723,12 @@ export interface ExternalModelOutputs {
2393
2723
  */
2394
2724
  export interface ModelScores {
2395
2725
  /**
2726
+ * @public
2396
2727
  * <p>The model version.</p>
2397
2728
  */
2398
2729
  modelVersion?: ModelVersion;
2399
2730
  /**
2731
+ * @public
2400
2732
  * <p>The model's fraud prediction scores.</p>
2401
2733
  */
2402
2734
  scores?: Record<string, number>;
@@ -2407,10 +2739,12 @@ export interface ModelScores {
2407
2739
  */
2408
2740
  export interface RuleResult {
2409
2741
  /**
2742
+ * @public
2410
2743
  * <p>The rule ID that was matched, based on the rule execution mode.</p>
2411
2744
  */
2412
2745
  ruleId?: string;
2413
2746
  /**
2747
+ * @public
2414
2748
  * <p>The outcomes of the matched rule, based on the rule execution mode.</p>
2415
2749
  */
2416
2750
  outcomes?: string[];
@@ -2420,14 +2754,17 @@ export interface RuleResult {
2420
2754
  */
2421
2755
  export interface GetEventPredictionResult {
2422
2756
  /**
2757
+ * @public
2423
2758
  * <p>The model scores. Amazon Fraud Detector generates model scores between 0 and 1000, where 0 is low fraud risk and 1000 is high fraud risk. Model scores are directly related to the false positive rate (FPR). For example, a score of 600 corresponds to an estimated 10% false positive rate whereas a score of 900 corresponds to an estimated 2% false positive rate.</p>
2424
2759
  */
2425
2760
  modelScores?: ModelScores[];
2426
2761
  /**
2762
+ * @public
2427
2763
  * <p>The results from the rules.</p>
2428
2764
  */
2429
2765
  ruleResults?: RuleResult[];
2430
2766
  /**
2767
+ * @public
2431
2768
  * <p>The model scores for Amazon SageMaker models.</p>
2432
2769
  */
2433
2770
  externalModelOutputs?: ExternalModelOutputs[];
@@ -2449,30 +2786,35 @@ export declare class ResourceUnavailableException extends __BaseException {
2449
2786
  */
2450
2787
  export interface GetEventPredictionMetadataRequest {
2451
2788
  /**
2789
+ * @public
2452
2790
  * <p>
2453
2791
  * The event ID.
2454
2792
  * </p>
2455
2793
  */
2456
2794
  eventId: string | undefined;
2457
2795
  /**
2796
+ * @public
2458
2797
  * <p>
2459
2798
  * The event type associated with the detector specified for the prediction.
2460
2799
  * </p>
2461
2800
  */
2462
2801
  eventTypeName: string | undefined;
2463
2802
  /**
2803
+ * @public
2464
2804
  * <p>
2465
2805
  * The detector ID.
2466
2806
  * </p>
2467
2807
  */
2468
2808
  detectorId: string | undefined;
2469
2809
  /**
2810
+ * @public
2470
2811
  * <p>
2471
2812
  * The detector version ID.
2472
2813
  * </p>
2473
2814
  */
2474
2815
  detectorVersionId: string | undefined;
2475
2816
  /**
2817
+ * @public
2476
2818
  * <p>
2477
2819
  * The timestamp that defines when the prediction was generated. The timestamp must be specified using ISO 8601 standard in UTC.</p>
2478
2820
  * <p>We recommend calling <a href="https://docs.aws.amazon.com/frauddetector/latest/api/API_ListEventPredictions.html">ListEventPredictions</a>
@@ -2488,24 +2830,28 @@ export interface GetEventPredictionMetadataRequest {
2488
2830
  */
2489
2831
  export interface EvaluatedExternalModel {
2490
2832
  /**
2833
+ * @public
2491
2834
  * <p>
2492
2835
  * The endpoint of the external (Amazon Sagemaker) model.
2493
2836
  * </p>
2494
2837
  */
2495
2838
  modelEndpoint?: string;
2496
2839
  /**
2840
+ * @public
2497
2841
  * <p>
2498
2842
  * Indicates whether event variables were used to generate predictions.
2499
2843
  * </p>
2500
2844
  */
2501
2845
  useEventVariables?: boolean;
2502
2846
  /**
2847
+ * @public
2503
2848
  * <p>
2504
2849
  * Input variables use for generating predictions.
2505
2850
  * </p>
2506
2851
  */
2507
2852
  inputVariables?: Record<string, string>;
2508
2853
  /**
2854
+ * @public
2509
2855
  * <p>
2510
2856
  * Output variables.
2511
2857
  * </p>
@@ -2520,12 +2866,14 @@ export interface EvaluatedExternalModel {
2520
2866
  */
2521
2867
  export interface VariableImpactExplanation {
2522
2868
  /**
2869
+ * @public
2523
2870
  * <p>
2524
2871
  * The event variable name.
2525
2872
  * </p>
2526
2873
  */
2527
2874
  eventVariableName?: string;
2528
2875
  /**
2876
+ * @public
2529
2877
  * <p>
2530
2878
  * The event variable's relative impact in terms of magnitude on the prediction scores.
2531
2879
  * The relative impact values consist of a numerical rating (0-5, 5 being the highest) and direction (increased/decreased) impact of the fraud risk.
@@ -2533,6 +2881,7 @@ export interface VariableImpactExplanation {
2533
2881
  */
2534
2882
  relativeImpact?: string;
2535
2883
  /**
2884
+ * @public
2536
2885
  * <p>
2537
2886
  * The raw, uninterpreted value represented as log-odds of the fraud. These values are usually between -10 to +10, but range from - infinity to + infinity.</p>
2538
2887
  * <ul>
@@ -2554,12 +2903,14 @@ export interface VariableImpactExplanation {
2554
2903
  */
2555
2904
  export interface PredictionExplanations {
2556
2905
  /**
2906
+ * @public
2557
2907
  * <p>
2558
2908
  * The details of the event variable's impact on the prediction score.
2559
2909
  * </p>
2560
2910
  */
2561
2911
  variableImpactExplanations?: VariableImpactExplanation[];
2562
2912
  /**
2913
+ * @public
2563
2914
  * <p>
2564
2915
  * The details of the aggregated variables impact on the prediction score.
2565
2916
  * </p>
@@ -2577,18 +2928,21 @@ export interface PredictionExplanations {
2577
2928
  */
2578
2929
  export interface ModelVersionEvaluation {
2579
2930
  /**
2931
+ * @public
2580
2932
  * <p>
2581
2933
  * The output variable name.
2582
2934
  * </p>
2583
2935
  */
2584
2936
  outputVariableName?: string;
2585
2937
  /**
2938
+ * @public
2586
2939
  * <p>
2587
2940
  * The evaluation score generated for the model version.
2588
2941
  * </p>
2589
2942
  */
2590
2943
  evaluationScore?: string;
2591
2944
  /**
2945
+ * @public
2592
2946
  * <p>
2593
2947
  * The prediction explanations generated for the model version.
2594
2948
  * </p>
@@ -2603,24 +2957,28 @@ export interface ModelVersionEvaluation {
2603
2957
  */
2604
2958
  export interface EvaluatedModelVersion {
2605
2959
  /**
2960
+ * @public
2606
2961
  * <p>
2607
2962
  * The model ID.
2608
2963
  * </p>
2609
2964
  */
2610
2965
  modelId?: string;
2611
2966
  /**
2967
+ * @public
2612
2968
  * <p>
2613
2969
  * The model version.
2614
2970
  * </p>
2615
2971
  */
2616
2972
  modelVersion?: string;
2617
2973
  /**
2974
+ * @public
2618
2975
  * <p>The model type. </p>
2619
2976
  * <p>Valid values: <code>ONLINE_FRAUD_INSIGHTS</code> | <code>TRANSACTION_FRAUD_INSIGHTS</code>
2620
2977
  * </p>
2621
2978
  */
2622
2979
  modelType?: string;
2623
2980
  /**
2981
+ * @public
2624
2982
  * <p>
2625
2983
  * Evaluations generated for the model version.
2626
2984
  * </p>
@@ -2635,18 +2993,21 @@ export interface EvaluatedModelVersion {
2635
2993
  */
2636
2994
  export interface EventVariableSummary {
2637
2995
  /**
2996
+ * @public
2638
2997
  * <p>
2639
2998
  * The event variable name.
2640
2999
  * </p>
2641
3000
  */
2642
3001
  name?: string;
2643
3002
  /**
3003
+ * @public
2644
3004
  * <p>
2645
3005
  * The value of the event variable.
2646
3006
  * </p>
2647
3007
  */
2648
3008
  value?: string;
2649
3009
  /**
3010
+ * @public
2650
3011
  * <p>
2651
3012
  * The event variable source.
2652
3013
  * </p>
@@ -2661,42 +3022,49 @@ export interface EventVariableSummary {
2661
3022
  */
2662
3023
  export interface EvaluatedRule {
2663
3024
  /**
3025
+ * @public
2664
3026
  * <p>
2665
3027
  * The rule ID.
2666
3028
  * </p>
2667
3029
  */
2668
3030
  ruleId?: string;
2669
3031
  /**
3032
+ * @public
2670
3033
  * <p>
2671
3034
  * The rule version.
2672
3035
  * </p>
2673
3036
  */
2674
3037
  ruleVersion?: string;
2675
3038
  /**
3039
+ * @public
2676
3040
  * <p>
2677
3041
  * The rule expression.
2678
3042
  * </p>
2679
3043
  */
2680
3044
  expression?: string;
2681
3045
  /**
3046
+ * @public
2682
3047
  * <p>
2683
3048
  * The rule expression value.
2684
3049
  * </p>
2685
3050
  */
2686
3051
  expressionWithValues?: string;
2687
3052
  /**
3053
+ * @public
2688
3054
  * <p>
2689
3055
  * The rule outcome.
2690
3056
  * </p>
2691
3057
  */
2692
3058
  outcomes?: string[];
2693
3059
  /**
3060
+ * @public
2694
3061
  * <p>
2695
3062
  * Indicates whether the rule was evaluated.
2696
3063
  * </p>
2697
3064
  */
2698
3065
  evaluated?: boolean;
2699
3066
  /**
3067
+ * @public
2700
3068
  * <p>
2701
3069
  * Indicates whether the rule matched.
2702
3070
  * </p>
@@ -2708,90 +3076,105 @@ export interface EvaluatedRule {
2708
3076
  */
2709
3077
  export interface GetEventPredictionMetadataResult {
2710
3078
  /**
3079
+ * @public
2711
3080
  * <p>
2712
3081
  * The event ID.
2713
3082
  * </p>
2714
3083
  */
2715
3084
  eventId?: string;
2716
3085
  /**
3086
+ * @public
2717
3087
  * <p>
2718
3088
  * The event type associated with the detector specified for this prediction.
2719
3089
  * </p>
2720
3090
  */
2721
3091
  eventTypeName?: string;
2722
3092
  /**
3093
+ * @public
2723
3094
  * <p>
2724
3095
  * The entity ID.
2725
3096
  * </p>
2726
3097
  */
2727
3098
  entityId?: string;
2728
3099
  /**
3100
+ * @public
2729
3101
  * <p>
2730
3102
  * The entity type.
2731
3103
  * </p>
2732
3104
  */
2733
3105
  entityType?: string;
2734
3106
  /**
3107
+ * @public
2735
3108
  * <p>
2736
3109
  * The timestamp for when the prediction was generated for the associated event ID.
2737
3110
  * </p>
2738
3111
  */
2739
3112
  eventTimestamp?: string;
2740
3113
  /**
3114
+ * @public
2741
3115
  * <p>
2742
3116
  * The detector ID.
2743
3117
  * </p>
2744
3118
  */
2745
3119
  detectorId?: string;
2746
3120
  /**
3121
+ * @public
2747
3122
  * <p>
2748
3123
  * The detector version ID.
2749
3124
  * </p>
2750
3125
  */
2751
3126
  detectorVersionId?: string;
2752
3127
  /**
3128
+ * @public
2753
3129
  * <p>
2754
3130
  * The status of the detector version.
2755
3131
  * </p>
2756
3132
  */
2757
3133
  detectorVersionStatus?: string;
2758
3134
  /**
3135
+ * @public
2759
3136
  * <p>
2760
3137
  * A list of event variables that influenced the prediction scores.
2761
3138
  * </p>
2762
3139
  */
2763
3140
  eventVariables?: EventVariableSummary[];
2764
3141
  /**
3142
+ * @public
2765
3143
  * <p>
2766
3144
  * List of rules associated with the detector version that were used for evaluating variable values.
2767
3145
  * </p>
2768
3146
  */
2769
3147
  rules?: EvaluatedRule[];
2770
3148
  /**
3149
+ * @public
2771
3150
  * <p>
2772
3151
  * The execution mode of the rule used for evaluating variable values.
2773
3152
  * </p>
2774
3153
  */
2775
3154
  ruleExecutionMode?: RuleExecutionMode | string;
2776
3155
  /**
3156
+ * @public
2777
3157
  * <p>
2778
3158
  * The outcomes of the matched rule, based on the rule execution mode.
2779
3159
  * </p>
2780
3160
  */
2781
3161
  outcomes?: string[];
2782
3162
  /**
3163
+ * @public
2783
3164
  * <p>
2784
3165
  * Model versions that were evaluated for generating predictions.
2785
3166
  * </p>
2786
3167
  */
2787
3168
  evaluatedModelVersions?: EvaluatedModelVersion[];
2788
3169
  /**
3170
+ * @public
2789
3171
  * <p>
2790
3172
  * External (Amazon SageMaker) models that were evaluated for generating predictions.
2791
3173
  * </p>
2792
3174
  */
2793
3175
  evaluatedExternalModels?: EvaluatedExternalModel[];
2794
3176
  /**
3177
+ * @public
2795
3178
  * <p>The timestamp that defines when the prediction was generated. </p>
2796
3179
  */
2797
3180
  predictionTimestamp?: string;
@@ -2801,14 +3184,17 @@ export interface GetEventPredictionMetadataResult {
2801
3184
  */
2802
3185
  export interface GetEventTypesRequest {
2803
3186
  /**
3187
+ * @public
2804
3188
  * <p>The name.</p>
2805
3189
  */
2806
3190
  name?: string;
2807
3191
  /**
3192
+ * @public
2808
3193
  * <p>The next token for the subsequent request.</p>
2809
3194
  */
2810
3195
  nextToken?: string;
2811
3196
  /**
3197
+ * @public
2812
3198
  * <p>The maximum number of objects to return for the request.</p>
2813
3199
  */
2814
3200
  maxResults?: number;
@@ -2833,6 +3219,7 @@ export type EventIngestion = (typeof EventIngestion)[keyof typeof EventIngestion
2833
3219
  */
2834
3220
  export interface EventOrchestration {
2835
3221
  /**
3222
+ * @public
2836
3223
  * <p>Specifies if event orchestration is enabled through Amazon EventBridge.</p>
2837
3224
  */
2838
3225
  eventBridgeEnabled: boolean | undefined;
@@ -2843,22 +3230,27 @@ export interface EventOrchestration {
2843
3230
  */
2844
3231
  export interface IngestedEventStatistics {
2845
3232
  /**
3233
+ * @public
2846
3234
  * <p>The number of stored events.</p>
2847
3235
  */
2848
3236
  numberOfEvents?: number;
2849
3237
  /**
3238
+ * @public
2850
3239
  * <p>The total size of the stored events.</p>
2851
3240
  */
2852
3241
  eventDataSizeInBytes?: number;
2853
3242
  /**
3243
+ * @public
2854
3244
  * <p>The oldest stored event.</p>
2855
3245
  */
2856
3246
  leastRecentEvent?: string;
2857
3247
  /**
3248
+ * @public
2858
3249
  * <p>The newest stored event.</p>
2859
3250
  */
2860
3251
  mostRecentEvent?: string;
2861
3252
  /**
3253
+ * @public
2862
3254
  * <p>Timestamp of when the stored event was last updated.
2863
3255
  * </p>
2864
3256
  */
@@ -2870,46 +3262,57 @@ export interface IngestedEventStatistics {
2870
3262
  */
2871
3263
  export interface EventType {
2872
3264
  /**
3265
+ * @public
2873
3266
  * <p>The event type name.</p>
2874
3267
  */
2875
3268
  name?: string;
2876
3269
  /**
3270
+ * @public
2877
3271
  * <p>The event type description.</p>
2878
3272
  */
2879
3273
  description?: string;
2880
3274
  /**
3275
+ * @public
2881
3276
  * <p>The event type event variables.</p>
2882
3277
  */
2883
3278
  eventVariables?: string[];
2884
3279
  /**
3280
+ * @public
2885
3281
  * <p>The event type labels.</p>
2886
3282
  */
2887
3283
  labels?: string[];
2888
3284
  /**
3285
+ * @public
2889
3286
  * <p>The event type entity types.</p>
2890
3287
  */
2891
3288
  entityTypes?: string[];
2892
3289
  /**
3290
+ * @public
2893
3291
  * <p>If <code>Enabled</code>, Amazon Fraud Detector stores event data when you generate a prediction and uses that data to update calculated variables in near real-time. Amazon Fraud Detector uses this data, known as <code>INGESTED_EVENTS</code>, to train your model and improve fraud predictions.</p>
2894
3292
  */
2895
3293
  eventIngestion?: EventIngestion | string;
2896
3294
  /**
3295
+ * @public
2897
3296
  * <p>Data about the stored events.</p>
2898
3297
  */
2899
3298
  ingestedEventStatistics?: IngestedEventStatistics;
2900
3299
  /**
3300
+ * @public
2901
3301
  * <p>Timestamp of when the event type was last updated.</p>
2902
3302
  */
2903
3303
  lastUpdatedTime?: string;
2904
3304
  /**
3305
+ * @public
2905
3306
  * <p>Timestamp of when the event type was created.</p>
2906
3307
  */
2907
3308
  createdTime?: string;
2908
3309
  /**
3310
+ * @public
2909
3311
  * <p>The entity type ARN.</p>
2910
3312
  */
2911
3313
  arn?: string;
2912
3314
  /**
3315
+ * @public
2913
3316
  * <p>The event orchestration status. </p>
2914
3317
  */
2915
3318
  eventOrchestration?: EventOrchestration;
@@ -2919,10 +3322,12 @@ export interface EventType {
2919
3322
  */
2920
3323
  export interface GetEventTypesResult {
2921
3324
  /**
3325
+ * @public
2922
3326
  * <p>An array of event types.</p>
2923
3327
  */
2924
3328
  eventTypes?: EventType[];
2925
3329
  /**
3330
+ * @public
2926
3331
  * <p>The next page token.</p>
2927
3332
  */
2928
3333
  nextToken?: string;
@@ -2932,14 +3337,17 @@ export interface GetEventTypesResult {
2932
3337
  */
2933
3338
  export interface GetExternalModelsRequest {
2934
3339
  /**
3340
+ * @public
2935
3341
  * <p>The Amazon SageMaker model endpoint.</p>
2936
3342
  */
2937
3343
  modelEndpoint?: string;
2938
3344
  /**
3345
+ * @public
2939
3346
  * <p>The next page token for the request.</p>
2940
3347
  */
2941
3348
  nextToken?: string;
2942
3349
  /**
3350
+ * @public
2943
3351
  * <p>The maximum number of objects to return for the request.</p>
2944
3352
  */
2945
3353
  maxResults?: number;
@@ -2962,25 +3370,30 @@ export type ModelInputDataFormat = (typeof ModelInputDataFormat)[keyof typeof Mo
2962
3370
  */
2963
3371
  export interface ModelInputConfiguration {
2964
3372
  /**
3373
+ * @public
2965
3374
  * <p>The event type name.</p>
2966
3375
  */
2967
3376
  eventTypeName?: string;
2968
3377
  /**
3378
+ * @public
2969
3379
  * <p> The format of the model input configuration. The format differs depending on if it is
2970
3380
  * passed through to SageMaker or constructed by Amazon Fraud Detector.</p>
2971
3381
  */
2972
3382
  format?: ModelInputDataFormat | string;
2973
3383
  /**
3384
+ * @public
2974
3385
  * <p>The event variables.</p>
2975
3386
  */
2976
3387
  useEventVariables: boolean | undefined;
2977
3388
  /**
3389
+ * @public
2978
3390
  * <p> Template for constructing the JSON input-data sent to SageMaker. At event-evaluation,
2979
3391
  * the placeholders for variable names in the template will be replaced with the variable
2980
3392
  * values before being sent to SageMaker. </p>
2981
3393
  */
2982
3394
  jsonInputTemplate?: string;
2983
3395
  /**
3396
+ * @public
2984
3397
  * <p> Template for constructing the CSV input-data sent to SageMaker. At event-evaluation,
2985
3398
  * the placeholders for variable-names in the template will be replaced with the variable
2986
3399
  * values before being sent to SageMaker. </p>
@@ -3017,14 +3430,17 @@ export type ModelOutputDataFormat = (typeof ModelOutputDataFormat)[keyof typeof
3017
3430
  */
3018
3431
  export interface ModelOutputConfiguration {
3019
3432
  /**
3433
+ * @public
3020
3434
  * <p>The format of the model output configuration.</p>
3021
3435
  */
3022
3436
  format: ModelOutputDataFormat | string | undefined;
3023
3437
  /**
3438
+ * @public
3024
3439
  * <p>A map of JSON keys in response from SageMaker to the Amazon Fraud Detector variables. </p>
3025
3440
  */
3026
3441
  jsonKeyToVariableMap?: Record<string, string>;
3027
3442
  /**
3443
+ * @public
3028
3444
  * <p>A map of CSV index values in the SageMaker response to the Amazon Fraud Detector variables. </p>
3029
3445
  */
3030
3446
  csvIndexToVariableMap?: Record<string, string>;
@@ -3035,38 +3451,47 @@ export interface ModelOutputConfiguration {
3035
3451
  */
3036
3452
  export interface ExternalModel {
3037
3453
  /**
3454
+ * @public
3038
3455
  * <p>The Amazon SageMaker model endpoints.</p>
3039
3456
  */
3040
3457
  modelEndpoint?: string;
3041
3458
  /**
3459
+ * @public
3042
3460
  * <p>The source of the model.</p>
3043
3461
  */
3044
3462
  modelSource?: ModelSource | string;
3045
3463
  /**
3464
+ * @public
3046
3465
  * <p>The role used to invoke the model. </p>
3047
3466
  */
3048
3467
  invokeModelEndpointRoleArn?: string;
3049
3468
  /**
3469
+ * @public
3050
3470
  * <p>The input configuration.</p>
3051
3471
  */
3052
3472
  inputConfiguration?: ModelInputConfiguration;
3053
3473
  /**
3474
+ * @public
3054
3475
  * <p>The output configuration.</p>
3055
3476
  */
3056
3477
  outputConfiguration?: ModelOutputConfiguration;
3057
3478
  /**
3479
+ * @public
3058
3480
  * <p>The Amazon Fraud Detector status for the external model endpoint</p>
3059
3481
  */
3060
3482
  modelEndpointStatus?: ModelEndpointStatus | string;
3061
3483
  /**
3484
+ * @public
3062
3485
  * <p>Timestamp of when the model was last updated.</p>
3063
3486
  */
3064
3487
  lastUpdatedTime?: string;
3065
3488
  /**
3489
+ * @public
3066
3490
  * <p>Timestamp of when the model was last created.</p>
3067
3491
  */
3068
3492
  createdTime?: string;
3069
3493
  /**
3494
+ * @public
3070
3495
  * <p>The model ARN.</p>
3071
3496
  */
3072
3497
  arn?: string;
@@ -3076,10 +3501,12 @@ export interface ExternalModel {
3076
3501
  */
3077
3502
  export interface GetExternalModelsResult {
3078
3503
  /**
3504
+ * @public
3079
3505
  * <p>Gets the Amazon SageMaker models.</p>
3080
3506
  */
3081
3507
  externalModels?: ExternalModel[];
3082
3508
  /**
3509
+ * @public
3083
3510
  * <p>The next page token to be used in subsequent requests.</p>
3084
3511
  */
3085
3512
  nextToken?: string;
@@ -3090,6 +3517,7 @@ export interface GetExternalModelsResult {
3090
3517
  */
3091
3518
  export interface KMSKey {
3092
3519
  /**
3520
+ * @public
3093
3521
  * <p>The encryption key ARN.</p>
3094
3522
  */
3095
3523
  kmsEncryptionKeyArn?: string;
@@ -3099,6 +3527,7 @@ export interface KMSKey {
3099
3527
  */
3100
3528
  export interface GetKMSEncryptionKeyResult {
3101
3529
  /**
3530
+ * @public
3102
3531
  * <p>The KMS encryption key.</p>
3103
3532
  */
3104
3533
  kmsKey?: KMSKey;
@@ -3108,14 +3537,17 @@ export interface GetKMSEncryptionKeyResult {
3108
3537
  */
3109
3538
  export interface GetLabelsRequest {
3110
3539
  /**
3540
+ * @public
3111
3541
  * <p>The name of the label or labels to get.</p>
3112
3542
  */
3113
3543
  name?: string;
3114
3544
  /**
3545
+ * @public
3115
3546
  * <p>The next token for the subsequent request.</p>
3116
3547
  */
3117
3548
  nextToken?: string;
3118
3549
  /**
3550
+ * @public
3119
3551
  * <p>The maximum number of objects to return for the request.</p>
3120
3552
  */
3121
3553
  maxResults?: number;
@@ -3126,22 +3558,27 @@ export interface GetLabelsRequest {
3126
3558
  */
3127
3559
  export interface Label {
3128
3560
  /**
3561
+ * @public
3129
3562
  * <p>The label name.</p>
3130
3563
  */
3131
3564
  name?: string;
3132
3565
  /**
3566
+ * @public
3133
3567
  * <p>The label description.</p>
3134
3568
  */
3135
3569
  description?: string;
3136
3570
  /**
3571
+ * @public
3137
3572
  * <p>Timestamp of when the label was last updated.</p>
3138
3573
  */
3139
3574
  lastUpdatedTime?: string;
3140
3575
  /**
3576
+ * @public
3141
3577
  * <p>Timestamp of when the event type was created.</p>
3142
3578
  */
3143
3579
  createdTime?: string;
3144
3580
  /**
3581
+ * @public
3145
3582
  * <p>The label ARN.</p>
3146
3583
  */
3147
3584
  arn?: string;
@@ -3151,10 +3588,12 @@ export interface Label {
3151
3588
  */
3152
3589
  export interface GetLabelsResult {
3153
3590
  /**
3591
+ * @public
3154
3592
  * <p>An array of labels.</p>
3155
3593
  */
3156
3594
  labels?: Label[];
3157
3595
  /**
3596
+ * @public
3158
3597
  * <p>The next page token.</p>
3159
3598
  */
3160
3599
  nextToken?: string;
@@ -3164,18 +3603,21 @@ export interface GetLabelsResult {
3164
3603
  */
3165
3604
  export interface GetListElementsRequest {
3166
3605
  /**
3606
+ * @public
3167
3607
  * <p>
3168
3608
  * The name of the list.
3169
3609
  * </p>
3170
3610
  */
3171
3611
  name: string | undefined;
3172
3612
  /**
3613
+ * @public
3173
3614
  * <p>
3174
3615
  * The next token for the subsequent request.
3175
3616
  * </p>
3176
3617
  */
3177
3618
  nextToken?: string;
3178
3619
  /**
3620
+ * @public
3179
3621
  * <p>
3180
3622
  * The maximum number of objects to return for the request.
3181
3623
  * </p>
@@ -3187,12 +3629,14 @@ export interface GetListElementsRequest {
3187
3629
  */
3188
3630
  export interface GetListElementsResult {
3189
3631
  /**
3632
+ * @public
3190
3633
  * <p>
3191
3634
  * The list elements.
3192
3635
  * </p>
3193
3636
  */
3194
3637
  elements?: string[];
3195
3638
  /**
3639
+ * @public
3196
3640
  * <p>
3197
3641
  * The next page token.
3198
3642
  * </p>
@@ -3204,18 +3648,21 @@ export interface GetListElementsResult {
3204
3648
  */
3205
3649
  export interface GetListsMetadataRequest {
3206
3650
  /**
3651
+ * @public
3207
3652
  * <p>
3208
3653
  * The name of the list.
3209
3654
  * </p>
3210
3655
  */
3211
3656
  name?: string;
3212
3657
  /**
3658
+ * @public
3213
3659
  * <p>
3214
3660
  * The next token for the subsequent request.
3215
3661
  * </p>
3216
3662
  */
3217
3663
  nextToken?: string;
3218
3664
  /**
3665
+ * @public
3219
3666
  * <p>
3220
3667
  * The maximum number of objects to return for the request.
3221
3668
  * </p>
@@ -3227,12 +3674,14 @@ export interface GetListsMetadataRequest {
3227
3674
  */
3228
3675
  export interface GetListsMetadataResult {
3229
3676
  /**
3677
+ * @public
3230
3678
  * <p>
3231
3679
  * The metadata of the specified list or all lists under the account.
3232
3680
  * </p>
3233
3681
  */
3234
3682
  lists?: AllowDenyList[];
3235
3683
  /**
3684
+ * @public
3236
3685
  * <p>
3237
3686
  * The next page token.
3238
3687
  * </p>
@@ -3244,18 +3693,22 @@ export interface GetListsMetadataResult {
3244
3693
  */
3245
3694
  export interface GetModelsRequest {
3246
3695
  /**
3696
+ * @public
3247
3697
  * <p>The model ID.</p>
3248
3698
  */
3249
3699
  modelId?: string;
3250
3700
  /**
3701
+ * @public
3251
3702
  * <p>The model type.</p>
3252
3703
  */
3253
3704
  modelType?: ModelTypeEnum | string;
3254
3705
  /**
3706
+ * @public
3255
3707
  * <p>The next token for the subsequent request.</p>
3256
3708
  */
3257
3709
  nextToken?: string;
3258
3710
  /**
3711
+ * @public
3259
3712
  * <p>The maximum number of objects to return for the request. </p>
3260
3713
  */
3261
3714
  maxResults?: number;
@@ -3266,30 +3719,37 @@ export interface GetModelsRequest {
3266
3719
  */
3267
3720
  export interface Model {
3268
3721
  /**
3722
+ * @public
3269
3723
  * <p>The model ID.</p>
3270
3724
  */
3271
3725
  modelId?: string;
3272
3726
  /**
3727
+ * @public
3273
3728
  * <p>The model type.</p>
3274
3729
  */
3275
3730
  modelType?: ModelTypeEnum | string;
3276
3731
  /**
3732
+ * @public
3277
3733
  * <p>The model description.</p>
3278
3734
  */
3279
3735
  description?: string;
3280
3736
  /**
3737
+ * @public
3281
3738
  * <p>The name of the event type.</p>
3282
3739
  */
3283
3740
  eventTypeName?: string;
3284
3741
  /**
3742
+ * @public
3285
3743
  * <p>Timestamp of when the model was created.</p>
3286
3744
  */
3287
3745
  createdTime?: string;
3288
3746
  /**
3747
+ * @public
3289
3748
  * <p>Timestamp of last time the model was updated.</p>
3290
3749
  */
3291
3750
  lastUpdatedTime?: string;
3292
3751
  /**
3752
+ * @public
3293
3753
  * <p>The ARN of the model.</p>
3294
3754
  */
3295
3755
  arn?: string;
@@ -3299,10 +3759,12 @@ export interface Model {
3299
3759
  */
3300
3760
  export interface GetModelsResult {
3301
3761
  /**
3762
+ * @public
3302
3763
  * <p>The next page token to be used in subsequent requests.</p>
3303
3764
  */
3304
3765
  nextToken?: string;
3305
3766
  /**
3767
+ * @public
3306
3768
  * <p>The array of models.</p>
3307
3769
  */
3308
3770
  models?: Model[];
@@ -3312,14 +3774,17 @@ export interface GetModelsResult {
3312
3774
  */
3313
3775
  export interface GetModelVersionRequest {
3314
3776
  /**
3777
+ * @public
3315
3778
  * <p>The model ID.</p>
3316
3779
  */
3317
3780
  modelId: string | undefined;
3318
3781
  /**
3782
+ * @public
3319
3783
  * <p>The model type.</p>
3320
3784
  */
3321
3785
  modelType: ModelTypeEnum | string | undefined;
3322
3786
  /**
3787
+ * @public
3323
3788
  * <p>The model version number.</p>
3324
3789
  */
3325
3790
  modelVersionNumber: string | undefined;
@@ -3329,37 +3794,45 @@ export interface GetModelVersionRequest {
3329
3794
  */
3330
3795
  export interface GetModelVersionResult {
3331
3796
  /**
3797
+ * @public
3332
3798
  * <p>The model ID.</p>
3333
3799
  */
3334
3800
  modelId?: string;
3335
3801
  /**
3802
+ * @public
3336
3803
  * <p>The model type.</p>
3337
3804
  */
3338
3805
  modelType?: ModelTypeEnum | string;
3339
3806
  /**
3807
+ * @public
3340
3808
  * <p>The model version number.</p>
3341
3809
  */
3342
3810
  modelVersionNumber?: string;
3343
3811
  /**
3812
+ * @public
3344
3813
  * <p>The training data source.</p>
3345
3814
  */
3346
3815
  trainingDataSource?: TrainingDataSourceEnum | string;
3347
3816
  /**
3817
+ * @public
3348
3818
  * <p>The training data schema.</p>
3349
3819
  */
3350
3820
  trainingDataSchema?: TrainingDataSchema;
3351
3821
  /**
3822
+ * @public
3352
3823
  * <p>The details of the external events data used for training the model version.
3353
3824
  * This will be populated if the <code>trainingDataSource</code> is <code>EXTERNAL_EVENTS</code>
3354
3825
  * </p>
3355
3826
  */
3356
3827
  externalEventsDetail?: ExternalEventsDetail;
3357
3828
  /**
3829
+ * @public
3358
3830
  * <p>The details of the ingested events data used for training the model version.
3359
3831
  * This will be populated if the <code>trainingDataSource</code> is <code>INGESTED_EVENTS</code>.</p>
3360
3832
  */
3361
3833
  ingestedEventsDetail?: IngestedEventsDetail;
3362
3834
  /**
3835
+ * @public
3363
3836
  * <p>The model version status.</p>
3364
3837
  * <p>Possible values are:</p>
3365
3838
  * <ul>
@@ -3412,6 +3885,7 @@ export interface GetModelVersionResult {
3412
3885
  */
3413
3886
  status?: string;
3414
3887
  /**
3888
+ * @public
3415
3889
  * <p>The model version ARN.</p>
3416
3890
  */
3417
3891
  arn?: string;
@@ -3421,14 +3895,17 @@ export interface GetModelVersionResult {
3421
3895
  */
3422
3896
  export interface GetOutcomesRequest {
3423
3897
  /**
3898
+ * @public
3424
3899
  * <p>The name of the outcome or outcomes to get.</p>
3425
3900
  */
3426
3901
  name?: string;
3427
3902
  /**
3903
+ * @public
3428
3904
  * <p>The next page token for the request. </p>
3429
3905
  */
3430
3906
  nextToken?: string;
3431
3907
  /**
3908
+ * @public
3432
3909
  * <p>The maximum number of objects to return for the request. </p>
3433
3910
  */
3434
3911
  maxResults?: number;
@@ -3439,22 +3916,27 @@ export interface GetOutcomesRequest {
3439
3916
  */
3440
3917
  export interface Outcome {
3441
3918
  /**
3919
+ * @public
3442
3920
  * <p>The outcome name.</p>
3443
3921
  */
3444
3922
  name?: string;
3445
3923
  /**
3924
+ * @public
3446
3925
  * <p>The outcome description.</p>
3447
3926
  */
3448
3927
  description?: string;
3449
3928
  /**
3929
+ * @public
3450
3930
  * <p>The timestamp when the outcome was last updated.</p>
3451
3931
  */
3452
3932
  lastUpdatedTime?: string;
3453
3933
  /**
3934
+ * @public
3454
3935
  * <p>The timestamp when the outcome was created.</p>
3455
3936
  */
3456
3937
  createdTime?: string;
3457
3938
  /**
3939
+ * @public
3458
3940
  * <p>The outcome ARN.</p>
3459
3941
  */
3460
3942
  arn?: string;
@@ -3464,10 +3946,12 @@ export interface Outcome {
3464
3946
  */
3465
3947
  export interface GetOutcomesResult {
3466
3948
  /**
3949
+ * @public
3467
3950
  * <p>The outcomes. </p>
3468
3951
  */
3469
3952
  outcomes?: Outcome[];
3470
3953
  /**
3954
+ * @public
3471
3955
  * <p>The next page token for subsequent requests.</p>
3472
3956
  */
3473
3957
  nextToken?: string;
@@ -3477,22 +3961,27 @@ export interface GetOutcomesResult {
3477
3961
  */
3478
3962
  export interface GetRulesRequest {
3479
3963
  /**
3964
+ * @public
3480
3965
  * <p>The rule ID.</p>
3481
3966
  */
3482
3967
  ruleId?: string;
3483
3968
  /**
3969
+ * @public
3484
3970
  * <p>The detector ID.</p>
3485
3971
  */
3486
3972
  detectorId: string | undefined;
3487
3973
  /**
3974
+ * @public
3488
3975
  * <p>The rule version.</p>
3489
3976
  */
3490
3977
  ruleVersion?: string;
3491
3978
  /**
3979
+ * @public
3492
3980
  * <p>The next page token.</p>
3493
3981
  */
3494
3982
  nextToken?: string;
3495
3983
  /**
3984
+ * @public
3496
3985
  * <p>The maximum number of rules to return for the request.</p>
3497
3986
  */
3498
3987
  maxResults?: number;
@@ -3503,42 +3992,52 @@ export interface GetRulesRequest {
3503
3992
  */
3504
3993
  export interface RuleDetail {
3505
3994
  /**
3995
+ * @public
3506
3996
  * <p>The rule ID.</p>
3507
3997
  */
3508
3998
  ruleId?: string;
3509
3999
  /**
4000
+ * @public
3510
4001
  * <p>The rule description.</p>
3511
4002
  */
3512
4003
  description?: string;
3513
4004
  /**
4005
+ * @public
3514
4006
  * <p>The detector for which the rule is associated.</p>
3515
4007
  */
3516
4008
  detectorId?: string;
3517
4009
  /**
4010
+ * @public
3518
4011
  * <p>The rule version.</p>
3519
4012
  */
3520
4013
  ruleVersion?: string;
3521
4014
  /**
4015
+ * @public
3522
4016
  * <p>The rule expression.</p>
3523
4017
  */
3524
4018
  expression?: string;
3525
4019
  /**
4020
+ * @public
3526
4021
  * <p>The rule language.</p>
3527
4022
  */
3528
4023
  language?: Language | string;
3529
4024
  /**
4025
+ * @public
3530
4026
  * <p>The rule outcomes.</p>
3531
4027
  */
3532
4028
  outcomes?: string[];
3533
4029
  /**
4030
+ * @public
3534
4031
  * <p>Timestamp of the last time the rule was updated.</p>
3535
4032
  */
3536
4033
  lastUpdatedTime?: string;
3537
4034
  /**
4035
+ * @public
3538
4036
  * <p>The timestamp of when the rule was created.</p>
3539
4037
  */
3540
4038
  createdTime?: string;
3541
4039
  /**
4040
+ * @public
3542
4041
  * <p>The rule ARN.</p>
3543
4042
  */
3544
4043
  arn?: string;
@@ -3548,10 +4047,12 @@ export interface RuleDetail {
3548
4047
  */
3549
4048
  export interface GetRulesResult {
3550
4049
  /**
4050
+ * @public
3551
4051
  * <p>The details of the requested rule.</p>
3552
4052
  */
3553
4053
  ruleDetails?: RuleDetail[];
3554
4054
  /**
4055
+ * @public
3555
4056
  * <p>The next page token to be used in subsequent requests.</p>
3556
4057
  */
3557
4058
  nextToken?: string;
@@ -3561,14 +4062,17 @@ export interface GetRulesResult {
3561
4062
  */
3562
4063
  export interface GetVariablesRequest {
3563
4064
  /**
4065
+ * @public
3564
4066
  * <p>The name of the variable. </p>
3565
4067
  */
3566
4068
  name?: string;
3567
4069
  /**
4070
+ * @public
3568
4071
  * <p>The next page token of the get variable request. </p>
3569
4072
  */
3570
4073
  nextToken?: string;
3571
4074
  /**
4075
+ * @public
3572
4076
  * <p>The max size per page determined for the get variable request. </p>
3573
4077
  */
3574
4078
  maxResults?: number;
@@ -3578,10 +4082,12 @@ export interface GetVariablesRequest {
3578
4082
  */
3579
4083
  export interface GetVariablesResult {
3580
4084
  /**
4085
+ * @public
3581
4086
  * <p>The names of the variables returned. </p>
3582
4087
  */
3583
4088
  variables?: Variable[];
3584
4089
  /**
4090
+ * @public
3585
4091
  * <p>The next page token to be used in subsequent requests. </p>
3586
4092
  */
3587
4093
  nextToken?: string;
@@ -3594,6 +4100,7 @@ export interface GetVariablesResult {
3594
4100
  */
3595
4101
  export interface FilterCondition {
3596
4102
  /**
4103
+ * @public
3597
4104
  * <p>
3598
4105
  * A statement containing a resource property and a value to specify filter condition.
3599
4106
  * </p>
@@ -3608,12 +4115,14 @@ export interface FilterCondition {
3608
4115
  */
3609
4116
  export interface PredictionTimeRange {
3610
4117
  /**
4118
+ * @public
3611
4119
  * <p>
3612
4120
  * The start time of the time period for when the predictions were generated.
3613
4121
  * </p>
3614
4122
  */
3615
4123
  startTime: string | undefined;
3616
4124
  /**
4125
+ * @public
3617
4126
  * <p>
3618
4127
  * The end time of the time period for when the predictions were generated.
3619
4128
  * </p>
@@ -3625,42 +4134,49 @@ export interface PredictionTimeRange {
3625
4134
  */
3626
4135
  export interface ListEventPredictionsRequest {
3627
4136
  /**
4137
+ * @public
3628
4138
  * <p>
3629
4139
  * The event ID.
3630
4140
  * </p>
3631
4141
  */
3632
4142
  eventId?: FilterCondition;
3633
4143
  /**
4144
+ * @public
3634
4145
  * <p>
3635
4146
  * The event type associated with the detector.
3636
4147
  * </p>
3637
4148
  */
3638
4149
  eventType?: FilterCondition;
3639
4150
  /**
4151
+ * @public
3640
4152
  * <p>
3641
4153
  * The detector ID.
3642
4154
  * </p>
3643
4155
  */
3644
4156
  detectorId?: FilterCondition;
3645
4157
  /**
4158
+ * @public
3646
4159
  * <p>
3647
4160
  * The detector version ID.
3648
4161
  * </p>
3649
4162
  */
3650
4163
  detectorVersionId?: FilterCondition;
3651
4164
  /**
4165
+ * @public
3652
4166
  * <p>
3653
4167
  * The time period for when the predictions were generated.
3654
4168
  * </p>
3655
4169
  */
3656
4170
  predictionTimeRange?: PredictionTimeRange;
3657
4171
  /**
4172
+ * @public
3658
4173
  * <p>
3659
4174
  * Identifies the next page of results to return. Use the token to make the call again to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
3660
4175
  * </p>
3661
4176
  */
3662
4177
  nextToken?: string;
3663
4178
  /**
4179
+ * @public
3664
4180
  * <p>
3665
4181
  * The maximum number of predictions to return for the request.
3666
4182
  * </p>
@@ -3675,36 +4191,42 @@ export interface ListEventPredictionsRequest {
3675
4191
  */
3676
4192
  export interface EventPredictionSummary {
3677
4193
  /**
4194
+ * @public
3678
4195
  * <p>
3679
4196
  * The event ID.
3680
4197
  * </p>
3681
4198
  */
3682
4199
  eventId?: string;
3683
4200
  /**
4201
+ * @public
3684
4202
  * <p>
3685
4203
  * The event type.
3686
4204
  * </p>
3687
4205
  */
3688
4206
  eventTypeName?: string;
3689
4207
  /**
4208
+ * @public
3690
4209
  * <p>
3691
4210
  * The timestamp of the event.
3692
4211
  * </p>
3693
4212
  */
3694
4213
  eventTimestamp?: string;
3695
4214
  /**
4215
+ * @public
3696
4216
  * <p>
3697
4217
  * The timestamp when the prediction was generated.
3698
4218
  * </p>
3699
4219
  */
3700
4220
  predictionTimestamp?: string;
3701
4221
  /**
4222
+ * @public
3702
4223
  * <p>
3703
4224
  * The detector ID.
3704
4225
  * </p>
3705
4226
  */
3706
4227
  detectorId?: string;
3707
4228
  /**
4229
+ * @public
3708
4230
  * <p>
3709
4231
  * The detector version ID.
3710
4232
  * </p>
@@ -3716,12 +4238,14 @@ export interface EventPredictionSummary {
3716
4238
  */
3717
4239
  export interface ListEventPredictionsResult {
3718
4240
  /**
4241
+ * @public
3719
4242
  * <p>
3720
4243
  * The summary of the past predictions.
3721
4244
  * </p>
3722
4245
  */
3723
4246
  eventPredictionSummaries?: EventPredictionSummary[];
3724
4247
  /**
4248
+ * @public
3725
4249
  * <p>
3726
4250
  * Identifies the next page of results to return. Use the token to make the call again to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
3727
4251
  * </p>
@@ -3733,14 +4257,17 @@ export interface ListEventPredictionsResult {
3733
4257
  */
3734
4258
  export interface ListTagsForResourceRequest {
3735
4259
  /**
4260
+ * @public
3736
4261
  * <p>The ARN that specifies the resource whose tags you want to list.</p>
3737
4262
  */
3738
4263
  resourceARN: string | undefined;
3739
4264
  /**
4265
+ * @public
3740
4266
  * <p>The next token from the previous results.</p>
3741
4267
  */
3742
4268
  nextToken?: string;
3743
4269
  /**
4270
+ * @public
3744
4271
  * <p>The maximum number of objects to return for the request. </p>
3745
4272
  */
3746
4273
  maxResults?: number;
@@ -3750,10 +4277,12 @@ export interface ListTagsForResourceRequest {
3750
4277
  */
3751
4278
  export interface ListTagsForResourceResult {
3752
4279
  /**
4280
+ * @public
3753
4281
  * <p>A collection of key and value pairs.</p>
3754
4282
  */
3755
4283
  tags?: Tag[];
3756
4284
  /**
4285
+ * @public
3757
4286
  * <p>The next token for subsequent requests. </p>
3758
4287
  */
3759
4288
  nextToken?: string;
@@ -3763,18 +4292,22 @@ export interface ListTagsForResourceResult {
3763
4292
  */
3764
4293
  export interface PutDetectorRequest {
3765
4294
  /**
4295
+ * @public
3766
4296
  * <p>The detector ID. </p>
3767
4297
  */
3768
4298
  detectorId: string | undefined;
3769
4299
  /**
4300
+ * @public
3770
4301
  * <p>The description of the detector.</p>
3771
4302
  */
3772
4303
  description?: string;
3773
4304
  /**
4305
+ * @public
3774
4306
  * <p>The name of the event type.</p>
3775
4307
  */
3776
4308
  eventTypeName: string | undefined;
3777
4309
  /**
4310
+ * @public
3778
4311
  * <p>A collection of key and value pairs.</p>
3779
4312
  */
3780
4313
  tags?: Tag[];
@@ -3789,14 +4322,17 @@ export interface PutDetectorResult {
3789
4322
  */
3790
4323
  export interface PutEntityTypeRequest {
3791
4324
  /**
4325
+ * @public
3792
4326
  * <p>The name of the entity type.</p>
3793
4327
  */
3794
4328
  name: string | undefined;
3795
4329
  /**
4330
+ * @public
3796
4331
  * <p>The description.</p>
3797
4332
  */
3798
4333
  description?: string;
3799
4334
  /**
4335
+ * @public
3800
4336
  * <p>A collection of key and value pairs.</p>
3801
4337
  */
3802
4338
  tags?: Tag[];
@@ -3811,34 +4347,42 @@ export interface PutEntityTypeResult {
3811
4347
  */
3812
4348
  export interface PutEventTypeRequest {
3813
4349
  /**
4350
+ * @public
3814
4351
  * <p>The name.</p>
3815
4352
  */
3816
4353
  name: string | undefined;
3817
4354
  /**
4355
+ * @public
3818
4356
  * <p>The description of the event type.</p>
3819
4357
  */
3820
4358
  description?: string;
3821
4359
  /**
4360
+ * @public
3822
4361
  * <p>The event type variables.</p>
3823
4362
  */
3824
4363
  eventVariables: string[] | undefined;
3825
4364
  /**
4365
+ * @public
3826
4366
  * <p>The event type labels.</p>
3827
4367
  */
3828
4368
  labels?: string[];
3829
4369
  /**
4370
+ * @public
3830
4371
  * <p>The entity type for the event type. Example entity types: customer, merchant, account.</p>
3831
4372
  */
3832
4373
  entityTypes: string[] | undefined;
3833
4374
  /**
4375
+ * @public
3834
4376
  * <p>Specifies if ingestion is enabled or disabled.</p>
3835
4377
  */
3836
4378
  eventIngestion?: EventIngestion | string;
3837
4379
  /**
4380
+ * @public
3838
4381
  * <p>A collection of key and value pairs.</p>
3839
4382
  */
3840
4383
  tags?: Tag[];
3841
4384
  /**
4385
+ * @public
3842
4386
  * <p>Enables or disables event orchestration. If enabled, you can send event predictions to select AWS services for downstream processing of the events.</p>
3843
4387
  */
3844
4388
  eventOrchestration?: EventOrchestration;
@@ -3853,30 +4397,37 @@ export interface PutEventTypeResult {
3853
4397
  */
3854
4398
  export interface PutExternalModelRequest {
3855
4399
  /**
4400
+ * @public
3856
4401
  * <p>The model endpoints name.</p>
3857
4402
  */
3858
4403
  modelEndpoint: string | undefined;
3859
4404
  /**
4405
+ * @public
3860
4406
  * <p>The source of the model.</p>
3861
4407
  */
3862
4408
  modelSource: ModelSource | string | undefined;
3863
4409
  /**
4410
+ * @public
3864
4411
  * <p>The IAM role used to invoke the model endpoint.</p>
3865
4412
  */
3866
4413
  invokeModelEndpointRoleArn: string | undefined;
3867
4414
  /**
4415
+ * @public
3868
4416
  * <p>The model endpoint input configuration.</p>
3869
4417
  */
3870
4418
  inputConfiguration: ModelInputConfiguration | undefined;
3871
4419
  /**
4420
+ * @public
3872
4421
  * <p>The model endpoint output configuration.</p>
3873
4422
  */
3874
4423
  outputConfiguration: ModelOutputConfiguration | undefined;
3875
4424
  /**
4425
+ * @public
3876
4426
  * <p>The model endpoint’s status in Amazon Fraud Detector.</p>
3877
4427
  */
3878
4428
  modelEndpointStatus: ModelEndpointStatus | string | undefined;
3879
4429
  /**
4430
+ * @public
3880
4431
  * <p>A collection of key and value pairs.</p>
3881
4432
  */
3882
4433
  tags?: Tag[];
@@ -3891,6 +4442,7 @@ export interface PutExternalModelResult {
3891
4442
  */
3892
4443
  export interface PutKMSEncryptionKeyRequest {
3893
4444
  /**
4445
+ * @public
3894
4446
  * <p>The KMS encryption key ARN.</p>
3895
4447
  * <p>The KMS key must be single-Region key. Amazon Fraud Detector does not support multi-Region KMS key.</p>
3896
4448
  */
@@ -3906,14 +4458,17 @@ export interface PutKMSEncryptionKeyResult {
3906
4458
  */
3907
4459
  export interface PutLabelRequest {
3908
4460
  /**
4461
+ * @public
3909
4462
  * <p>The label name.</p>
3910
4463
  */
3911
4464
  name: string | undefined;
3912
4465
  /**
4466
+ * @public
3913
4467
  * <p>The label description.</p>
3914
4468
  */
3915
4469
  description?: string;
3916
4470
  /**
4471
+ * @public
3917
4472
  * <p>A collection of key and value pairs.</p>
3918
4473
  */
3919
4474
  tags?: Tag[];
@@ -3928,14 +4483,17 @@ export interface PutLabelResult {
3928
4483
  */
3929
4484
  export interface PutOutcomeRequest {
3930
4485
  /**
4486
+ * @public
3931
4487
  * <p>The name of the outcome.</p>
3932
4488
  */
3933
4489
  name: string | undefined;
3934
4490
  /**
4491
+ * @public
3935
4492
  * <p>The outcome description.</p>
3936
4493
  */
3937
4494
  description?: string;
3938
4495
  /**
4496
+ * @public
3939
4497
  * <p>A collection of key and value pairs.</p>
3940
4498
  */
3941
4499
  tags?: Tag[];
@@ -3950,30 +4508,37 @@ export interface PutOutcomeResult {
3950
4508
  */
3951
4509
  export interface SendEventRequest {
3952
4510
  /**
4511
+ * @public
3953
4512
  * <p>The event ID to upload.</p>
3954
4513
  */
3955
4514
  eventId: string | undefined;
3956
4515
  /**
4516
+ * @public
3957
4517
  * <p>The event type name of the event.</p>
3958
4518
  */
3959
4519
  eventTypeName: string | undefined;
3960
4520
  /**
4521
+ * @public
3961
4522
  * <p>The timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.</p>
3962
4523
  */
3963
4524
  eventTimestamp: string | undefined;
3964
4525
  /**
4526
+ * @public
3965
4527
  * <p>Names of the event type's variables you defined in Amazon Fraud Detector to represent data elements and their corresponding values for the event you are sending for evaluation.</p>
3966
4528
  */
3967
4529
  eventVariables: Record<string, string> | undefined;
3968
4530
  /**
4531
+ * @public
3969
4532
  * <p>The label to associate with the event. Required if specifying <code>labelTimestamp</code>.</p>
3970
4533
  */
3971
4534
  assignedLabel?: string;
3972
4535
  /**
4536
+ * @public
3973
4537
  * <p>The timestamp associated with the label. Required if specifying <code>assignedLabel</code>.</p>
3974
4538
  */
3975
4539
  labelTimestamp?: string;
3976
4540
  /**
4541
+ * @public
3977
4542
  * <p>An array of entities.</p>
3978
4543
  */
3979
4544
  entities: Entity[] | undefined;
@@ -3988,10 +4553,12 @@ export interface SendEventResult {
3988
4553
  */
3989
4554
  export interface TagResourceRequest {
3990
4555
  /**
4556
+ * @public
3991
4557
  * <p>The resource ARN.</p>
3992
4558
  */
3993
4559
  resourceARN: string | undefined;
3994
4560
  /**
4561
+ * @public
3995
4562
  * <p>The tags to assign to the resource.</p>
3996
4563
  */
3997
4564
  tags: Tag[] | undefined;
@@ -4006,10 +4573,12 @@ export interface TagResourceResult {
4006
4573
  */
4007
4574
  export interface UntagResourceRequest {
4008
4575
  /**
4576
+ * @public
4009
4577
  * <p>The ARN of the resource from which to remove the tag.</p>
4010
4578
  */
4011
4579
  resourceARN: string | undefined;
4012
4580
  /**
4581
+ * @public
4013
4582
  * <p>The resource ARN.</p>
4014
4583
  */
4015
4584
  tagKeys: string[] | undefined;
@@ -4024,30 +4593,37 @@ export interface UntagResourceResult {
4024
4593
  */
4025
4594
  export interface UpdateDetectorVersionRequest {
4026
4595
  /**
4596
+ * @public
4027
4597
  * <p>The parent detector ID for the detector version you want to update.</p>
4028
4598
  */
4029
4599
  detectorId: string | undefined;
4030
4600
  /**
4601
+ * @public
4031
4602
  * <p>The detector version ID. </p>
4032
4603
  */
4033
4604
  detectorVersionId: string | undefined;
4034
4605
  /**
4606
+ * @public
4035
4607
  * <p>The Amazon SageMaker model endpoints to include in the detector version.</p>
4036
4608
  */
4037
4609
  externalModelEndpoints: string[] | undefined;
4038
4610
  /**
4611
+ * @public
4039
4612
  * <p>The rules to include in the detector version.</p>
4040
4613
  */
4041
4614
  rules: Rule[] | undefined;
4042
4615
  /**
4616
+ * @public
4043
4617
  * <p>The detector version description. </p>
4044
4618
  */
4045
4619
  description?: string;
4046
4620
  /**
4621
+ * @public
4047
4622
  * <p>The model versions to include in the detector version.</p>
4048
4623
  */
4049
4624
  modelVersions?: ModelVersion[];
4050
4625
  /**
4626
+ * @public
4051
4627
  * <p>The rule execution mode to add to the detector.</p>
4052
4628
  * <p>If you specify <code>FIRST_MATCHED</code>, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.</p>
4053
4629
  * <p>If you specifiy <code>ALL_MATCHED</code>, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status.</p>
@@ -4065,14 +4641,17 @@ export interface UpdateDetectorVersionResult {
4065
4641
  */
4066
4642
  export interface UpdateDetectorVersionMetadataRequest {
4067
4643
  /**
4644
+ * @public
4068
4645
  * <p>The detector ID.</p>
4069
4646
  */
4070
4647
  detectorId: string | undefined;
4071
4648
  /**
4649
+ * @public
4072
4650
  * <p>The detector version ID. </p>
4073
4651
  */
4074
4652
  detectorVersionId: string | undefined;
4075
4653
  /**
4654
+ * @public
4076
4655
  * <p>The description.</p>
4077
4656
  */
4078
4657
  description: string | undefined;
@@ -4087,14 +4666,17 @@ export interface UpdateDetectorVersionMetadataResult {
4087
4666
  */
4088
4667
  export interface UpdateDetectorVersionStatusRequest {
4089
4668
  /**
4669
+ * @public
4090
4670
  * <p>The detector ID. </p>
4091
4671
  */
4092
4672
  detectorId: string | undefined;
4093
4673
  /**
4674
+ * @public
4094
4675
  * <p>The detector version ID. </p>
4095
4676
  */
4096
4677
  detectorVersionId: string | undefined;
4097
4678
  /**
4679
+ * @public
4098
4680
  * <p>The new status.</p>
4099
4681
  * <p>The only supported values are <code>ACTIVE</code> and <code>INACTIVE</code>
4100
4682
  * </p>
@@ -4111,18 +4693,22 @@ export interface UpdateDetectorVersionStatusResult {
4111
4693
  */
4112
4694
  export interface UpdateEventLabelRequest {
4113
4695
  /**
4696
+ * @public
4114
4697
  * <p>The ID of the event associated with the label to update.</p>
4115
4698
  */
4116
4699
  eventId: string | undefined;
4117
4700
  /**
4701
+ * @public
4118
4702
  * <p>The event type of the event associated with the label to update.</p>
4119
4703
  */
4120
4704
  eventTypeName: string | undefined;
4121
4705
  /**
4706
+ * @public
4122
4707
  * <p>The new label to assign to the event.</p>
4123
4708
  */
4124
4709
  assignedLabel: string | undefined;
4125
4710
  /**
4711
+ * @public
4126
4712
  * <p>The timestamp associated with the label. The timestamp must be specified using ISO 8601 standard in UTC. </p>
4127
4713
  */
4128
4714
  labelTimestamp: string | undefined;
@@ -4150,12 +4736,14 @@ export type ListUpdateMode = (typeof ListUpdateMode)[keyof typeof ListUpdateMode
4150
4736
  */
4151
4737
  export interface UpdateListRequest {
4152
4738
  /**
4739
+ * @public
4153
4740
  * <p>
4154
4741
  * The name of the list to update.
4155
4742
  * </p>
4156
4743
  */
4157
4744
  name: string | undefined;
4158
4745
  /**
4746
+ * @public
4159
4747
  * <p>
4160
4748
  * One or more list elements to add or replace. If you are providing the elements, make sure to specify the <code>updateMode</code> to use.
4161
4749
  * </p>
@@ -4163,12 +4751,14 @@ export interface UpdateListRequest {
4163
4751
  */
4164
4752
  elements?: string[];
4165
4753
  /**
4754
+ * @public
4166
4755
  * <p>
4167
4756
  * The new description.
4168
4757
  * </p>
4169
4758
  */
4170
4759
  description?: string;
4171
4760
  /**
4761
+ * @public
4172
4762
  * <p>
4173
4763
  * The update mode (type).
4174
4764
  * </p>
@@ -4186,6 +4776,7 @@ export interface UpdateListRequest {
4186
4776
  */
4187
4777
  updateMode?: ListUpdateMode | string;
4188
4778
  /**
4779
+ * @public
4189
4780
  * <p>
4190
4781
  * The variable type you want to assign to the list.
4191
4782
  * </p>
@@ -4205,14 +4796,17 @@ export interface UpdateListResult {
4205
4796
  */
4206
4797
  export interface UpdateModelRequest {
4207
4798
  /**
4799
+ * @public
4208
4800
  * <p>The model ID.</p>
4209
4801
  */
4210
4802
  modelId: string | undefined;
4211
4803
  /**
4804
+ * @public
4212
4805
  * <p>The model type.</p>
4213
4806
  */
4214
4807
  modelType: ModelTypeEnum | string | undefined;
4215
4808
  /**
4809
+ * @public
4216
4810
  * <p>The new model description.</p>
4217
4811
  */
4218
4812
  description?: string;
@@ -4227,26 +4821,32 @@ export interface UpdateModelResult {
4227
4821
  */
4228
4822
  export interface UpdateModelVersionRequest {
4229
4823
  /**
4824
+ * @public
4230
4825
  * <p>The model ID.</p>
4231
4826
  */
4232
4827
  modelId: string | undefined;
4233
4828
  /**
4829
+ * @public
4234
4830
  * <p>The model type.</p>
4235
4831
  */
4236
4832
  modelType: ModelTypeEnum | string | undefined;
4237
4833
  /**
4834
+ * @public
4238
4835
  * <p>The major version number.</p>
4239
4836
  */
4240
4837
  majorVersionNumber: string | undefined;
4241
4838
  /**
4839
+ * @public
4242
4840
  * <p>The details of the external events data used for training the model version. Required if <code>trainingDataSource</code> is <code>EXTERNAL_EVENTS</code>.</p>
4243
4841
  */
4244
4842
  externalEventsDetail?: ExternalEventsDetail;
4245
4843
  /**
4844
+ * @public
4246
4845
  * <p>The details of the ingested event used for training the model version. Required if your <code>trainingDataSource</code> is <code>INGESTED_EVENTS</code>.</p>
4247
4846
  */
4248
4847
  ingestedEventsDetail?: IngestedEventsDetail;
4249
4848
  /**
4849
+ * @public
4250
4850
  * <p>A collection of key and value pairs.</p>
4251
4851
  */
4252
4852
  tags?: Tag[];
@@ -4256,18 +4856,22 @@ export interface UpdateModelVersionRequest {
4256
4856
  */
4257
4857
  export interface UpdateModelVersionResult {
4258
4858
  /**
4859
+ * @public
4259
4860
  * <p>The model ID.</p>
4260
4861
  */
4261
4862
  modelId?: string;
4262
4863
  /**
4864
+ * @public
4263
4865
  * <p>The model type.</p>
4264
4866
  */
4265
4867
  modelType?: ModelTypeEnum | string;
4266
4868
  /**
4869
+ * @public
4267
4870
  * <p>The model version number of the model version updated.</p>
4268
4871
  */
4269
4872
  modelVersionNumber?: string;
4270
4873
  /**
4874
+ * @public
4271
4875
  * <p>The status of the updated model version.</p>
4272
4876
  */
4273
4877
  status?: string;
@@ -4290,18 +4894,22 @@ export type ModelVersionStatus = (typeof ModelVersionStatus)[keyof typeof ModelV
4290
4894
  */
4291
4895
  export interface UpdateModelVersionStatusRequest {
4292
4896
  /**
4897
+ * @public
4293
4898
  * <p>The model ID of the model version to update.</p>
4294
4899
  */
4295
4900
  modelId: string | undefined;
4296
4901
  /**
4902
+ * @public
4297
4903
  * <p>The model type.</p>
4298
4904
  */
4299
4905
  modelType: ModelTypeEnum | string | undefined;
4300
4906
  /**
4907
+ * @public
4301
4908
  * <p>The model version number.</p>
4302
4909
  */
4303
4910
  modelVersionNumber: string | undefined;
4304
4911
  /**
4912
+ * @public
4305
4913
  * <p>The model version status.</p>
4306
4914
  */
4307
4915
  status: ModelVersionStatus | string | undefined;
@@ -4316,10 +4924,12 @@ export interface UpdateModelVersionStatusResult {
4316
4924
  */
4317
4925
  export interface UpdateRuleMetadataRequest {
4318
4926
  /**
4927
+ * @public
4319
4928
  * <p>The rule to update.</p>
4320
4929
  */
4321
4930
  rule: Rule | undefined;
4322
4931
  /**
4932
+ * @public
4323
4933
  * <p>The rule description.</p>
4324
4934
  */
4325
4935
  description: string | undefined;
@@ -4334,26 +4944,32 @@ export interface UpdateRuleMetadataResult {
4334
4944
  */
4335
4945
  export interface UpdateRuleVersionRequest {
4336
4946
  /**
4947
+ * @public
4337
4948
  * <p>The rule to update.</p>
4338
4949
  */
4339
4950
  rule: Rule | undefined;
4340
4951
  /**
4952
+ * @public
4341
4953
  * <p>The description.</p>
4342
4954
  */
4343
4955
  description?: string;
4344
4956
  /**
4957
+ * @public
4345
4958
  * <p>The rule expression.</p>
4346
4959
  */
4347
4960
  expression: string | undefined;
4348
4961
  /**
4962
+ * @public
4349
4963
  * <p>The language.</p>
4350
4964
  */
4351
4965
  language: Language | string | undefined;
4352
4966
  /**
4967
+ * @public
4353
4968
  * <p>The outcomes.</p>
4354
4969
  */
4355
4970
  outcomes: string[] | undefined;
4356
4971
  /**
4972
+ * @public
4357
4973
  * <p>The tags to assign to the rule version.</p>
4358
4974
  */
4359
4975
  tags?: Tag[];
@@ -4363,6 +4979,7 @@ export interface UpdateRuleVersionRequest {
4363
4979
  */
4364
4980
  export interface UpdateRuleVersionResult {
4365
4981
  /**
4982
+ * @public
4366
4983
  * <p>The new rule version that was created.</p>
4367
4984
  */
4368
4985
  rule?: Rule;
@@ -4372,18 +4989,22 @@ export interface UpdateRuleVersionResult {
4372
4989
  */
4373
4990
  export interface UpdateVariableRequest {
4374
4991
  /**
4992
+ * @public
4375
4993
  * <p>The name of the variable.</p>
4376
4994
  */
4377
4995
  name: string | undefined;
4378
4996
  /**
4997
+ * @public
4379
4998
  * <p>The new default value of the variable.</p>
4380
4999
  */
4381
5000
  defaultValue?: string;
4382
5001
  /**
5002
+ * @public
4383
5003
  * <p>The new description.</p>
4384
5004
  */
4385
5005
  description?: string;
4386
5006
  /**
5007
+ * @public
4387
5008
  * <p>The variable type. For more information see <a href="https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types">Variable types</a>.</p>
4388
5009
  */
4389
5010
  variableType?: string;