aws-sdk-frauddetector 1.3.0 → 1.8.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -25,6 +27,7 @@ module Aws::FraudDetector
25
27
  # See {Seahorse::Client::RequestContext} for more information.
26
28
  #
27
29
  # ## Error Classes
30
+ # * {AccessDeniedException}
28
31
  # * {ConflictException}
29
32
  # * {InternalServerException}
30
33
  # * {ResourceNotFoundException}
@@ -37,6 +40,21 @@ module Aws::FraudDetector
37
40
 
38
41
  extend Aws::Errors::DynamicErrors
39
42
 
43
+ class AccessDeniedException < ServiceError
44
+
45
+ # @param [Seahorse::Client::RequestContext] context
46
+ # @param [String] message
47
+ # @param [Aws::FraudDetector::Types::AccessDeniedException] data
48
+ def initialize(context, message, data = Aws::EmptyStructure.new)
49
+ super(context, message, data)
50
+ end
51
+
52
+ # @return [String]
53
+ def message
54
+ @message || @data[:message]
55
+ end
56
+ end
57
+
40
58
  class ConflictException < ServiceError
41
59
 
42
60
  # @param [Seahorse::Client::RequestContext] context
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -8,6 +10,21 @@
8
10
  module Aws::FraudDetector
9
11
  module Types
10
12
 
13
+ # An exception indicating Amazon Fraud Detector does not have the needed
14
+ # permissions. This can occur if you submit a request, such as
15
+ # `PutExternalModel`, that specifies a role that is not in your account.
16
+ #
17
+ # @!attribute [rw] message
18
+ # @return [String]
19
+ #
20
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/AccessDeniedException AWS API Documentation
21
+ #
22
+ class AccessDeniedException < Struct.new(
23
+ :message)
24
+ SENSITIVE = []
25
+ include Aws::Structure
26
+ end
27
+
11
28
  # Provides the error of the batch create variable API.
12
29
  #
13
30
  # @!attribute [rw] name
@@ -28,6 +45,7 @@ module Aws::FraudDetector
28
45
  :name,
29
46
  :code,
30
47
  :message)
48
+ SENSITIVE = []
31
49
  include Aws::Structure
32
50
  end
33
51
 
@@ -45,16 +63,28 @@ module Aws::FraudDetector
45
63
  # variable_type: "string",
46
64
  # },
47
65
  # ],
66
+ # tags: [
67
+ # {
68
+ # key: "tagKey", # required
69
+ # value: "tagValue", # required
70
+ # },
71
+ # ],
48
72
  # }
49
73
  #
50
74
  # @!attribute [rw] variable_entries
51
75
  # The list of variables for the batch create variable request.
52
76
  # @return [Array<Types::VariableEntry>]
53
77
  #
78
+ # @!attribute [rw] tags
79
+ # A collection of key and value pairs.
80
+ # @return [Array<Types::Tag>]
81
+ #
54
82
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/BatchCreateVariableRequest AWS API Documentation
55
83
  #
56
84
  class BatchCreateVariableRequest < Struct.new(
57
- :variable_entries)
85
+ :variable_entries,
86
+ :tags)
87
+ SENSITIVE = []
58
88
  include Aws::Structure
59
89
  end
60
90
 
@@ -66,6 +96,7 @@ module Aws::FraudDetector
66
96
  #
67
97
  class BatchCreateVariableResult < Struct.new(
68
98
  :errors)
99
+ SENSITIVE = []
69
100
  include Aws::Structure
70
101
  end
71
102
 
@@ -89,6 +120,7 @@ module Aws::FraudDetector
89
120
  :name,
90
121
  :code,
91
122
  :message)
123
+ SENSITIVE = []
92
124
  include Aws::Structure
93
125
  end
94
126
 
@@ -107,6 +139,7 @@ module Aws::FraudDetector
107
139
  #
108
140
  class BatchGetVariableRequest < Struct.new(
109
141
  :names)
142
+ SENSITIVE = []
110
143
  include Aws::Structure
111
144
  end
112
145
 
@@ -123,6 +156,7 @@ module Aws::FraudDetector
123
156
  class BatchGetVariableResult < Struct.new(
124
157
  :variables,
125
158
  :errors)
159
+ SENSITIVE = []
126
160
  include Aws::Structure
127
161
  end
128
162
 
@@ -137,9 +171,8 @@ module Aws::FraudDetector
137
171
  # * DeleteDetectorVersion: A conflict exception will occur if the
138
172
  # `DetectorVersion` status is `ACTIVE`.
139
173
  #
140
- # * DeleteRuleVersion: A conflict exception will occur if the
141
- # `RuleVersion` is in use by an associated `ACTIVE` or `INACTIVE
142
- # DetectorVersion`.
174
+ # * DeleteRule: A conflict exception will occur if the `RuleVersion` is
175
+ # in use by an associated `ACTIVE` or `INACTIVE DetectorVersion`.
143
176
  #
144
177
  # @!attribute [rw] message
145
178
  # @return [String]
@@ -148,6 +181,7 @@ module Aws::FraudDetector
148
181
  #
149
182
  class ConflictException < Struct.new(
150
183
  :message)
184
+ SENSITIVE = []
151
185
  include Aws::Structure
152
186
  end
153
187
 
@@ -162,7 +196,7 @@ module Aws::FraudDetector
162
196
  # {
163
197
  # detector_id: "identifier", # required
164
198
  # rule_id: "identifier", # required
165
- # rule_version: "nonEmptyString", # required
199
+ # rule_version: "wholeNumberVersionString", # required
166
200
  # },
167
201
  # ],
168
202
  # model_versions: [
@@ -170,9 +204,16 @@ module Aws::FraudDetector
170
204
  # model_id: "identifier", # required
171
205
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
172
206
  # model_version_number: "nonEmptyString", # required
207
+ # arn: "fraudDetectorArn",
173
208
  # },
174
209
  # ],
175
210
  # rule_execution_mode: "ALL_MATCHED", # accepts ALL_MATCHED, FIRST_MATCHED
211
+ # tags: [
212
+ # {
213
+ # key: "tagKey", # required
214
+ # value: "tagValue", # required
215
+ # },
216
+ # ],
176
217
  # }
177
218
  #
178
219
  # @!attribute [rw] detector_id
@@ -214,6 +255,10 @@ module Aws::FraudDetector
214
255
  # The default behavior is `FIRST_MATCHED`.
215
256
  # @return [String]
216
257
  #
258
+ # @!attribute [rw] tags
259
+ # A collection of key and value pairs.
260
+ # @return [Array<Types::Tag>]
261
+ #
217
262
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateDetectorVersionRequest AWS API Documentation
218
263
  #
219
264
  class CreateDetectorVersionRequest < Struct.new(
@@ -222,7 +267,9 @@ module Aws::FraudDetector
222
267
  :external_model_endpoints,
223
268
  :rules,
224
269
  :model_versions,
225
- :rule_execution_mode)
270
+ :rule_execution_mode,
271
+ :tags)
272
+ SENSITIVE = []
226
273
  include Aws::Structure
227
274
  end
228
275
 
@@ -244,16 +291,24 @@ module Aws::FraudDetector
244
291
  :detector_id,
245
292
  :detector_version_id,
246
293
  :status)
294
+ SENSITIVE = []
247
295
  include Aws::Structure
248
296
  end
249
297
 
250
- # @note When making an API call, you may pass CreateModelVersionRequest
298
+ # @note When making an API call, you may pass CreateModelRequest
251
299
  # data as a hash:
252
300
  #
253
301
  # {
254
302
  # model_id: "identifier", # required
255
303
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
256
304
  # description: "description",
305
+ # event_type_name: "string", # required
306
+ # tags: [
307
+ # {
308
+ # key: "tagKey", # required
309
+ # value: "tagValue", # required
310
+ # },
311
+ # ],
257
312
  # }
258
313
  #
259
314
  # @!attribute [rw] model_id
@@ -265,15 +320,95 @@ module Aws::FraudDetector
265
320
  # @return [String]
266
321
  #
267
322
  # @!attribute [rw] description
268
- # The model version description.
323
+ # The model description.
324
+ # @return [String]
325
+ #
326
+ # @!attribute [rw] event_type_name
327
+ # The name of the event type.
328
+ # @return [String]
329
+ #
330
+ # @!attribute [rw] tags
331
+ # A collection of key and value pairs.
332
+ # @return [Array<Types::Tag>]
333
+ #
334
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateModelRequest AWS API Documentation
335
+ #
336
+ class CreateModelRequest < Struct.new(
337
+ :model_id,
338
+ :model_type,
339
+ :description,
340
+ :event_type_name,
341
+ :tags)
342
+ SENSITIVE = []
343
+ include Aws::Structure
344
+ end
345
+
346
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateModelResult AWS API Documentation
347
+ #
348
+ class CreateModelResult < Aws::EmptyStructure; end
349
+
350
+ # @note When making an API call, you may pass CreateModelVersionRequest
351
+ # data as a hash:
352
+ #
353
+ # {
354
+ # model_id: "identifier", # required
355
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
356
+ # training_data_source: "EXTERNAL_EVENTS", # required, accepts EXTERNAL_EVENTS
357
+ # training_data_schema: { # required
358
+ # model_variables: ["string"], # required
359
+ # label_schema: { # required
360
+ # label_mapper: { # required
361
+ # "string" => ["string"],
362
+ # },
363
+ # },
364
+ # },
365
+ # external_events_detail: {
366
+ # data_location: "s3BucketLocation", # required
367
+ # data_access_role_arn: "iamRoleArn", # required
368
+ # },
369
+ # tags: [
370
+ # {
371
+ # key: "tagKey", # required
372
+ # value: "tagValue", # required
373
+ # },
374
+ # ],
375
+ # }
376
+ #
377
+ # @!attribute [rw] model_id
378
+ # The model ID.
379
+ # @return [String]
380
+ #
381
+ # @!attribute [rw] model_type
382
+ # The model type.
383
+ # @return [String]
384
+ #
385
+ # @!attribute [rw] training_data_source
386
+ # The training data source location in Amazon S3.
269
387
  # @return [String]
270
388
  #
389
+ # @!attribute [rw] training_data_schema
390
+ # The training data schema.
391
+ # @return [Types::TrainingDataSchema]
392
+ #
393
+ # @!attribute [rw] external_events_detail
394
+ # Details for the external events data used for model version
395
+ # training. Required if `trainingDataSource` is `EXTERNAL_EVENTS`.
396
+ # @return [Types::ExternalEventsDetail]
397
+ #
398
+ # @!attribute [rw] tags
399
+ # A collection of key and value pairs.
400
+ # @return [Array<Types::Tag>]
401
+ #
271
402
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateModelVersionRequest AWS API Documentation
272
403
  #
273
404
  class CreateModelVersionRequest < Struct.new(
274
405
  :model_id,
275
406
  :model_type,
276
- :description)
407
+ :training_data_source,
408
+ :training_data_schema,
409
+ :external_events_detail,
410
+ :tags)
411
+ SENSITIVE = []
277
412
  include Aws::Structure
278
413
  end
279
414
 
@@ -286,7 +421,7 @@ module Aws::FraudDetector
286
421
  # @return [String]
287
422
  #
288
423
  # @!attribute [rw] model_version_number
289
- # The version of the model.
424
+ # The model version number of the model version created.
290
425
  # @return [String]
291
426
  #
292
427
  # @!attribute [rw] status
@@ -300,6 +435,7 @@ module Aws::FraudDetector
300
435
  :model_type,
301
436
  :model_version_number,
302
437
  :status)
438
+ SENSITIVE = []
303
439
  include Aws::Structure
304
440
  end
305
441
 
@@ -313,6 +449,12 @@ module Aws::FraudDetector
313
449
  # expression: "ruleExpression", # required
314
450
  # language: "DETECTORPL", # required, accepts DETECTORPL
315
451
  # outcomes: ["string"], # required
452
+ # tags: [
453
+ # {
454
+ # key: "tagKey", # required
455
+ # value: "tagValue", # required
456
+ # },
457
+ # ],
316
458
  # }
317
459
  #
318
460
  # @!attribute [rw] rule_id
@@ -339,6 +481,10 @@ module Aws::FraudDetector
339
481
  # The outcome or outcomes returned when the rule expression matches.
340
482
  # @return [Array<String>]
341
483
  #
484
+ # @!attribute [rw] tags
485
+ # A collection of key and value pairs.
486
+ # @return [Array<Types::Tag>]
487
+ #
342
488
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateRuleRequest AWS API Documentation
343
489
  #
344
490
  class CreateRuleRequest < Struct.new(
@@ -347,7 +493,9 @@ module Aws::FraudDetector
347
493
  :description,
348
494
  :expression,
349
495
  :language,
350
- :outcomes)
496
+ :outcomes,
497
+ :tags)
498
+ SENSITIVE = [:expression]
351
499
  include Aws::Structure
352
500
  end
353
501
 
@@ -359,6 +507,7 @@ module Aws::FraudDetector
359
507
  #
360
508
  class CreateRuleResult < Struct.new(
361
509
  :rule)
510
+ SENSITIVE = []
362
511
  include Aws::Structure
363
512
  end
364
513
 
@@ -372,6 +521,12 @@ module Aws::FraudDetector
372
521
  # default_value: "string", # required
373
522
  # description: "string",
374
523
  # variable_type: "string",
524
+ # tags: [
525
+ # {
526
+ # key: "tagKey", # required
527
+ # value: "tagValue", # required
528
+ # },
529
+ # ],
375
530
  # }
376
531
  #
377
532
  # @!attribute [rw] name
@@ -395,9 +550,27 @@ module Aws::FraudDetector
395
550
  # @return [String]
396
551
  #
397
552
  # @!attribute [rw] variable_type
398
- # The variable type.
553
+ # The variable type. For more information see [Variable types][1].
554
+ #
555
+ # Valid Values: `AUTH_CODE | AVS | BILLING_ADDRESS_L1 |
556
+ # BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME |
557
+ # BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL
558
+ # | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL |
559
+ # FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE |
560
+ # PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 |
561
+ # SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY |
562
+ # SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP |
563
+ # USERAGENT | SHIPPING_ZIP | USERAGENT`
564
+ #
565
+ #
566
+ #
567
+ # [1]: https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types
399
568
  # @return [String]
400
569
  #
570
+ # @!attribute [rw] tags
571
+ # A collection of key and value pairs.
572
+ # @return [Array<Types::Tag>]
573
+ #
401
574
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateVariableRequest AWS API Documentation
402
575
  #
403
576
  class CreateVariableRequest < Struct.new(
@@ -406,7 +579,9 @@ module Aws::FraudDetector
406
579
  :data_source,
407
580
  :default_value,
408
581
  :description,
409
- :variable_type)
582
+ :variable_type,
583
+ :tags)
584
+ SENSITIVE = []
410
585
  include Aws::Structure
411
586
  end
412
587
 
@@ -414,6 +589,25 @@ module Aws::FraudDetector
414
589
  #
415
590
  class CreateVariableResult < Aws::EmptyStructure; end
416
591
 
592
+ # The model training validation messages.
593
+ #
594
+ # @!attribute [rw] file_level_messages
595
+ # The file-specific model training validation messages.
596
+ # @return [Array<Types::FileValidationMessage>]
597
+ #
598
+ # @!attribute [rw] field_level_messages
599
+ # The field-specific model training validation messages.
600
+ # @return [Array<Types::FieldValidationMessage>]
601
+ #
602
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DataValidationMetrics AWS API Documentation
603
+ #
604
+ class DataValidationMetrics < Struct.new(
605
+ :file_level_messages,
606
+ :field_level_messages)
607
+ SENSITIVE = []
608
+ include Aws::Structure
609
+ end
610
+
417
611
  # @note When making an API call, you may pass DeleteDetectorRequest
418
612
  # data as a hash:
419
613
  #
@@ -429,6 +623,7 @@ module Aws::FraudDetector
429
623
  #
430
624
  class DeleteDetectorRequest < Struct.new(
431
625
  :detector_id)
626
+ SENSITIVE = []
432
627
  include Aws::Structure
433
628
  end
434
629
 
@@ -441,7 +636,7 @@ module Aws::FraudDetector
441
636
  #
442
637
  # {
443
638
  # detector_id: "identifier", # required
444
- # detector_version_id: "nonEmptyString", # required
639
+ # detector_version_id: "wholeNumberVersionString", # required
445
640
  # }
446
641
  #
447
642
  # @!attribute [rw] detector_id
@@ -457,6 +652,7 @@ module Aws::FraudDetector
457
652
  class DeleteDetectorVersionRequest < Struct.new(
458
653
  :detector_id,
459
654
  :detector_version_id)
655
+ SENSITIVE = []
460
656
  include Aws::Structure
461
657
  end
462
658
 
@@ -469,16 +665,23 @@ module Aws::FraudDetector
469
665
  #
470
666
  # {
471
667
  # event_id: "string", # required
668
+ # event_type_name: "string", # required
472
669
  # }
473
670
  #
474
671
  # @!attribute [rw] event_id
475
672
  # The ID of the event to delete.
476
673
  # @return [String]
477
674
  #
675
+ # @!attribute [rw] event_type_name
676
+ # The name of the event type.
677
+ # @return [String]
678
+ #
478
679
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteEventRequest AWS API Documentation
479
680
  #
480
681
  class DeleteEventRequest < Struct.new(
481
- :event_id)
682
+ :event_id,
683
+ :event_type_name)
684
+ SENSITIVE = []
482
685
  include Aws::Structure
483
686
  end
484
687
 
@@ -486,39 +689,32 @@ module Aws::FraudDetector
486
689
  #
487
690
  class DeleteEventResult < Aws::EmptyStructure; end
488
691
 
489
- # @note When making an API call, you may pass DeleteRuleVersionRequest
692
+ # @note When making an API call, you may pass DeleteRuleRequest
490
693
  # data as a hash:
491
694
  #
492
695
  # {
493
- # detector_id: "identifier", # required
494
- # rule_id: "identifier", # required
495
- # rule_version: "nonEmptyString", # required
696
+ # rule: { # required
697
+ # detector_id: "identifier", # required
698
+ # rule_id: "identifier", # required
699
+ # rule_version: "wholeNumberVersionString", # required
700
+ # },
496
701
  # }
497
702
  #
498
- # @!attribute [rw] detector_id
499
- # The ID of the detector that includes the rule version to delete.
500
- # @return [String]
501
- #
502
- # @!attribute [rw] rule_id
503
- # The rule ID of the rule version to delete.
504
- # @return [String]
505
- #
506
- # @!attribute [rw] rule_version
507
- # The rule version to delete.
508
- # @return [String]
703
+ # @!attribute [rw] rule
704
+ # A rule.
705
+ # @return [Types::Rule]
509
706
  #
510
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteRuleVersionRequest AWS API Documentation
707
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteRuleRequest AWS API Documentation
511
708
  #
512
- class DeleteRuleVersionRequest < Struct.new(
513
- :detector_id,
514
- :rule_id,
515
- :rule_version)
709
+ class DeleteRuleRequest < Struct.new(
710
+ :rule)
711
+ SENSITIVE = []
516
712
  include Aws::Structure
517
713
  end
518
714
 
519
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteRuleVersionResult AWS API Documentation
715
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteRuleResult AWS API Documentation
520
716
  #
521
- class DeleteRuleVersionResult < Aws::EmptyStructure; end
717
+ class DeleteRuleResult < Aws::EmptyStructure; end
522
718
 
523
719
  # @note When making an API call, you may pass DescribeDetectorRequest
524
720
  # data as a hash:
@@ -547,6 +743,7 @@ module Aws::FraudDetector
547
743
  :detector_id,
548
744
  :next_token,
549
745
  :max_results)
746
+ SENSITIVE = []
550
747
  include Aws::Structure
551
748
  end
552
749
 
@@ -562,12 +759,18 @@ module Aws::FraudDetector
562
759
  # The next token to be used for subsequent requests.
563
760
  # @return [String]
564
761
  #
762
+ # @!attribute [rw] arn
763
+ # The detector ARN.
764
+ # @return [String]
765
+ #
565
766
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DescribeDetectorResult AWS API Documentation
566
767
  #
567
768
  class DescribeDetectorResult < Struct.new(
568
769
  :detector_id,
569
770
  :detector_version_summaries,
570
- :next_token)
771
+ :next_token,
772
+ :arn)
773
+ SENSITIVE = []
571
774
  include Aws::Structure
572
775
  end
573
776
 
@@ -576,7 +779,7 @@ module Aws::FraudDetector
576
779
  #
577
780
  # {
578
781
  # model_id: "identifier",
579
- # model_version_number: "nonEmptyString",
782
+ # model_version_number: "floatVersionString",
580
783
  # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
581
784
  # next_token: "string",
582
785
  # max_results: 1,
@@ -587,7 +790,7 @@ module Aws::FraudDetector
587
790
  # @return [String]
588
791
  #
589
792
  # @!attribute [rw] model_version_number
590
- # The model version.
793
+ # The model version number.
591
794
  # @return [String]
592
795
  #
593
796
  # @!attribute [rw] model_type
@@ -610,6 +813,7 @@ module Aws::FraudDetector
610
813
  :model_type,
611
814
  :next_token,
612
815
  :max_results)
816
+ SENSITIVE = []
613
817
  include Aws::Structure
614
818
  end
615
819
 
@@ -626,6 +830,7 @@ module Aws::FraudDetector
626
830
  class DescribeModelVersionsResult < Struct.new(
627
831
  :model_version_details,
628
832
  :next_token)
833
+ SENSITIVE = []
629
834
  include Aws::Structure
630
835
  end
631
836
 
@@ -639,6 +844,10 @@ module Aws::FraudDetector
639
844
  # The detector description.
640
845
  # @return [String]
641
846
  #
847
+ # @!attribute [rw] event_type_name
848
+ # The name of the event type.
849
+ # @return [String]
850
+ #
642
851
  # @!attribute [rw] last_updated_time
643
852
  # Timestamp of when the detector was last updated.
644
853
  # @return [String]
@@ -647,13 +856,20 @@ module Aws::FraudDetector
647
856
  # Timestamp of when the detector was created.
648
857
  # @return [String]
649
858
  #
859
+ # @!attribute [rw] arn
860
+ # The detector ARN.
861
+ # @return [String]
862
+ #
650
863
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Detector AWS API Documentation
651
864
  #
652
865
  class Detector < Struct.new(
653
866
  :detector_id,
654
867
  :description,
868
+ :event_type_name,
655
869
  :last_updated_time,
656
- :created_time)
870
+ :created_time,
871
+ :arn)
872
+ SENSITIVE = []
657
873
  include Aws::Structure
658
874
  end
659
875
 
@@ -682,6 +898,146 @@ module Aws::FraudDetector
682
898
  :status,
683
899
  :description,
684
900
  :last_updated_time)
901
+ SENSITIVE = []
902
+ include Aws::Structure
903
+ end
904
+
905
+ # The entity details.
906
+ #
907
+ # @note When making an API call, you may pass Entity
908
+ # data as a hash:
909
+ #
910
+ # {
911
+ # entity_type: "string",
912
+ # entity_id: "identifier",
913
+ # }
914
+ #
915
+ # @!attribute [rw] entity_type
916
+ # The entity type.
917
+ # @return [String]
918
+ #
919
+ # @!attribute [rw] entity_id
920
+ # The entity ID. If you do not know the `entityId`, you can pass
921
+ # `unknown`, which is areserved string literal.
922
+ # @return [String]
923
+ #
924
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Entity AWS API Documentation
925
+ #
926
+ class Entity < Struct.new(
927
+ :entity_type,
928
+ :entity_id)
929
+ SENSITIVE = []
930
+ include Aws::Structure
931
+ end
932
+
933
+ # The entity type details.
934
+ #
935
+ # @!attribute [rw] name
936
+ # The entity type name.
937
+ # @return [String]
938
+ #
939
+ # @!attribute [rw] description
940
+ # The entity type description.
941
+ # @return [String]
942
+ #
943
+ # @!attribute [rw] last_updated_time
944
+ # Timestamp of when the entity type was last updated.
945
+ # @return [String]
946
+ #
947
+ # @!attribute [rw] created_time
948
+ # Timestamp of when the entity type was created.
949
+ # @return [String]
950
+ #
951
+ # @!attribute [rw] arn
952
+ # The entity type ARN.
953
+ # @return [String]
954
+ #
955
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/EntityType AWS API Documentation
956
+ #
957
+ class EntityType < Struct.new(
958
+ :name,
959
+ :description,
960
+ :last_updated_time,
961
+ :created_time,
962
+ :arn)
963
+ SENSITIVE = []
964
+ include Aws::Structure
965
+ end
966
+
967
+ # The event type details.
968
+ #
969
+ # @!attribute [rw] name
970
+ # The event type name.
971
+ # @return [String]
972
+ #
973
+ # @!attribute [rw] description
974
+ # The event type description.
975
+ # @return [String]
976
+ #
977
+ # @!attribute [rw] event_variables
978
+ # The event type event variables.
979
+ # @return [Array<String>]
980
+ #
981
+ # @!attribute [rw] labels
982
+ # The event type labels.
983
+ # @return [Array<String>]
984
+ #
985
+ # @!attribute [rw] entity_types
986
+ # The event type entity types.
987
+ # @return [Array<String>]
988
+ #
989
+ # @!attribute [rw] last_updated_time
990
+ # Timestamp of when the event type was last updated.
991
+ # @return [String]
992
+ #
993
+ # @!attribute [rw] created_time
994
+ # Timestamp of when the event type was created.
995
+ # @return [String]
996
+ #
997
+ # @!attribute [rw] arn
998
+ # The entity type ARN.
999
+ # @return [String]
1000
+ #
1001
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/EventType AWS API Documentation
1002
+ #
1003
+ class EventType < Struct.new(
1004
+ :name,
1005
+ :description,
1006
+ :event_variables,
1007
+ :labels,
1008
+ :entity_types,
1009
+ :last_updated_time,
1010
+ :created_time,
1011
+ :arn)
1012
+ SENSITIVE = []
1013
+ include Aws::Structure
1014
+ end
1015
+
1016
+ # Details for the external events data used for model version training.
1017
+ #
1018
+ # @note When making an API call, you may pass ExternalEventsDetail
1019
+ # data as a hash:
1020
+ #
1021
+ # {
1022
+ # data_location: "s3BucketLocation", # required
1023
+ # data_access_role_arn: "iamRoleArn", # required
1024
+ # }
1025
+ #
1026
+ # @!attribute [rw] data_location
1027
+ # The Amazon S3 bucket location for the data.
1028
+ # @return [String]
1029
+ #
1030
+ # @!attribute [rw] data_access_role_arn
1031
+ # The ARN of the role that provides Amazon Fraud Detector access to
1032
+ # the data location.
1033
+ # @return [String]
1034
+ #
1035
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ExternalEventsDetail AWS API Documentation
1036
+ #
1037
+ class ExternalEventsDetail < Struct.new(
1038
+ :data_location,
1039
+ :data_access_role_arn)
1040
+ SENSITIVE = []
685
1041
  include Aws::Structure
686
1042
  end
687
1043
 
@@ -691,13 +1047,17 @@ module Aws::FraudDetector
691
1047
  # The Amazon SageMaker model endpoints.
692
1048
  # @return [String]
693
1049
  #
1050
+ # @!attribute [rw] event_type_name
1051
+ # The event type names.
1052
+ # @return [String]
1053
+ #
694
1054
  # @!attribute [rw] model_source
695
1055
  # The source of the model.
696
1056
  # @return [String]
697
1057
  #
698
- # @!attribute [rw] role
1058
+ # @!attribute [rw] invoke_model_endpoint_role_arn
699
1059
  # The role used to invoke the model.
700
- # @return [Types::Role]
1060
+ # @return [String]
701
1061
  #
702
1062
  # @!attribute [rw] input_configuration
703
1063
  # The input configuration.
@@ -719,17 +1079,82 @@ module Aws::FraudDetector
719
1079
  # Timestamp of when the model was last created.
720
1080
  # @return [String]
721
1081
  #
1082
+ # @!attribute [rw] arn
1083
+ # The model ARN.
1084
+ # @return [String]
1085
+ #
722
1086
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ExternalModel AWS API Documentation
723
1087
  #
724
1088
  class ExternalModel < Struct.new(
725
1089
  :model_endpoint,
1090
+ :event_type_name,
726
1091
  :model_source,
727
- :role,
1092
+ :invoke_model_endpoint_role_arn,
728
1093
  :input_configuration,
729
1094
  :output_configuration,
730
1095
  :model_endpoint_status,
731
1096
  :last_updated_time,
732
- :created_time)
1097
+ :created_time,
1098
+ :arn)
1099
+ SENSITIVE = []
1100
+ include Aws::Structure
1101
+ end
1102
+
1103
+ # The message details.
1104
+ #
1105
+ # @!attribute [rw] field_name
1106
+ # The field name.
1107
+ # @return [String]
1108
+ #
1109
+ # @!attribute [rw] identifier
1110
+ # The message ID.
1111
+ # @return [String]
1112
+ #
1113
+ # @!attribute [rw] title
1114
+ # The message title.
1115
+ # @return [String]
1116
+ #
1117
+ # @!attribute [rw] content
1118
+ # The message content.
1119
+ # @return [String]
1120
+ #
1121
+ # @!attribute [rw] type
1122
+ # The message type.
1123
+ # @return [String]
1124
+ #
1125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/FieldValidationMessage AWS API Documentation
1126
+ #
1127
+ class FieldValidationMessage < Struct.new(
1128
+ :field_name,
1129
+ :identifier,
1130
+ :title,
1131
+ :content,
1132
+ :type)
1133
+ SENSITIVE = []
1134
+ include Aws::Structure
1135
+ end
1136
+
1137
+ # The message details.
1138
+ #
1139
+ # @!attribute [rw] title
1140
+ # The message title.
1141
+ # @return [String]
1142
+ #
1143
+ # @!attribute [rw] content
1144
+ # The message content.
1145
+ # @return [String]
1146
+ #
1147
+ # @!attribute [rw] type
1148
+ # The message type.
1149
+ # @return [String]
1150
+ #
1151
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/FileValidationMessage AWS API Documentation
1152
+ #
1153
+ class FileValidationMessage < Struct.new(
1154
+ :title,
1155
+ :content,
1156
+ :type)
1157
+ SENSITIVE = []
733
1158
  include Aws::Structure
734
1159
  end
735
1160
 
@@ -738,7 +1163,7 @@ module Aws::FraudDetector
738
1163
  #
739
1164
  # {
740
1165
  # detector_id: "identifier", # required
741
- # detector_version_id: "nonEmptyString", # required
1166
+ # detector_version_id: "wholeNumberVersionString", # required
742
1167
  # }
743
1168
  #
744
1169
  # @!attribute [rw] detector_id
@@ -754,6 +1179,7 @@ module Aws::FraudDetector
754
1179
  class GetDetectorVersionRequest < Struct.new(
755
1180
  :detector_id,
756
1181
  :detector_version_id)
1182
+ SENSITIVE = []
757
1183
  include Aws::Structure
758
1184
  end
759
1185
 
@@ -808,6 +1234,10 @@ module Aws::FraudDetector
808
1234
  # draft status.
809
1235
  # @return [String]
810
1236
  #
1237
+ # @!attribute [rw] arn
1238
+ # The detector version ARN.
1239
+ # @return [String]
1240
+ #
811
1241
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetDetectorVersionResult AWS API Documentation
812
1242
  #
813
1243
  class GetDetectorVersionResult < Struct.new(
@@ -820,7 +1250,9 @@ module Aws::FraudDetector
820
1250
  :status,
821
1251
  :last_updated_time,
822
1252
  :created_time,
823
- :rule_execution_mode)
1253
+ :rule_execution_mode,
1254
+ :arn)
1255
+ SENSITIVE = []
824
1256
  include Aws::Structure
825
1257
  end
826
1258
 
@@ -851,6 +1283,7 @@ module Aws::FraudDetector
851
1283
  :detector_id,
852
1284
  :next_token,
853
1285
  :max_results)
1286
+ SENSITIVE = []
854
1287
  include Aws::Structure
855
1288
  end
856
1289
 
@@ -867,19 +1300,216 @@ module Aws::FraudDetector
867
1300
  class GetDetectorsResult < Struct.new(
868
1301
  :detectors,
869
1302
  :next_token)
1303
+ SENSITIVE = []
870
1304
  include Aws::Structure
871
1305
  end
872
1306
 
873
- # @note When making an API call, you may pass GetExternalModelsRequest
1307
+ # @note When making an API call, you may pass GetEntityTypesRequest
874
1308
  # data as a hash:
875
1309
  #
876
1310
  # {
877
- # model_endpoint: "string",
1311
+ # name: "identifier",
878
1312
  # next_token: "string",
879
1313
  # max_results: 1,
880
1314
  # }
881
1315
  #
882
- # @!attribute [rw] model_endpoint
1316
+ # @!attribute [rw] name
1317
+ # The name.
1318
+ # @return [String]
1319
+ #
1320
+ # @!attribute [rw] next_token
1321
+ # The next token for the subsequent request.
1322
+ # @return [String]
1323
+ #
1324
+ # @!attribute [rw] max_results
1325
+ # The maximum number of objects to return for the request.
1326
+ # @return [Integer]
1327
+ #
1328
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEntityTypesRequest AWS API Documentation
1329
+ #
1330
+ class GetEntityTypesRequest < Struct.new(
1331
+ :name,
1332
+ :next_token,
1333
+ :max_results)
1334
+ SENSITIVE = []
1335
+ include Aws::Structure
1336
+ end
1337
+
1338
+ # @!attribute [rw] entity_types
1339
+ # An array of entity types.
1340
+ # @return [Array<Types::EntityType>]
1341
+ #
1342
+ # @!attribute [rw] next_token
1343
+ # The next page token.
1344
+ # @return [String]
1345
+ #
1346
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEntityTypesResult AWS API Documentation
1347
+ #
1348
+ class GetEntityTypesResult < Struct.new(
1349
+ :entity_types,
1350
+ :next_token)
1351
+ SENSITIVE = []
1352
+ include Aws::Structure
1353
+ end
1354
+
1355
+ # @note When making an API call, you may pass GetEventPredictionRequest
1356
+ # data as a hash:
1357
+ #
1358
+ # {
1359
+ # detector_id: "string", # required
1360
+ # detector_version_id: "wholeNumberVersionString",
1361
+ # event_id: "string", # required
1362
+ # event_type_name: "string", # required
1363
+ # entities: [ # required
1364
+ # {
1365
+ # entity_type: "string",
1366
+ # entity_id: "identifier",
1367
+ # },
1368
+ # ],
1369
+ # event_timestamp: "string", # required
1370
+ # event_variables: { # required
1371
+ # "variableName" => "variableValue",
1372
+ # },
1373
+ # external_model_endpoint_data_blobs: {
1374
+ # "string" => {
1375
+ # byte_buffer: "data",
1376
+ # content_type: "contentType",
1377
+ # },
1378
+ # },
1379
+ # }
1380
+ #
1381
+ # @!attribute [rw] detector_id
1382
+ # The detector ID.
1383
+ # @return [String]
1384
+ #
1385
+ # @!attribute [rw] detector_version_id
1386
+ # The detector version ID.
1387
+ # @return [String]
1388
+ #
1389
+ # @!attribute [rw] event_id
1390
+ # The unique ID used to identify the event.
1391
+ # @return [String]
1392
+ #
1393
+ # @!attribute [rw] event_type_name
1394
+ # The event type associated with the detector specified for the
1395
+ # prediction.
1396
+ # @return [String]
1397
+ #
1398
+ # @!attribute [rw] entities
1399
+ # The entity type (associated with the detector's event type) and
1400
+ # specific entity ID representing who performed the event. If an
1401
+ # entity id is not available, use "UNKNOWN."
1402
+ # @return [Array<Types::Entity>]
1403
+ #
1404
+ # @!attribute [rw] event_timestamp
1405
+ # Timestamp that defines when the event under evaluation occurred.
1406
+ # @return [String]
1407
+ #
1408
+ # @!attribute [rw] event_variables
1409
+ # Names of the event type's variables you defined in Amazon Fraud
1410
+ # Detector to represent data elements and their corresponding values
1411
+ # for the event you are sending for evaluation.
1412
+ # @return [Hash<String,String>]
1413
+ #
1414
+ # @!attribute [rw] external_model_endpoint_data_blobs
1415
+ # The Amazon SageMaker model endpoint input data blobs.
1416
+ # @return [Hash<String,Types::ModelEndpointDataBlob>]
1417
+ #
1418
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventPredictionRequest AWS API Documentation
1419
+ #
1420
+ class GetEventPredictionRequest < Struct.new(
1421
+ :detector_id,
1422
+ :detector_version_id,
1423
+ :event_id,
1424
+ :event_type_name,
1425
+ :entities,
1426
+ :event_timestamp,
1427
+ :event_variables,
1428
+ :external_model_endpoint_data_blobs)
1429
+ SENSITIVE = [:external_model_endpoint_data_blobs]
1430
+ include Aws::Structure
1431
+ end
1432
+
1433
+ # @!attribute [rw] model_scores
1434
+ # The model scores. Amazon Fraud Detector generates model scores
1435
+ # between 0 and 1000, where 0 is low fraud risk and 1000 is high fraud
1436
+ # risk. Model scores are directly related to the false positive rate
1437
+ # (FPR). For example, a score of 600 corresponds to an estimated 10%
1438
+ # false positive rate whereas a score of 900 corresponds to an
1439
+ # estimated 2% false positive rate.
1440
+ # @return [Array<Types::ModelScores>]
1441
+ #
1442
+ # @!attribute [rw] rule_results
1443
+ # The results.
1444
+ # @return [Array<Types::RuleResult>]
1445
+ #
1446
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventPredictionResult AWS API Documentation
1447
+ #
1448
+ class GetEventPredictionResult < Struct.new(
1449
+ :model_scores,
1450
+ :rule_results)
1451
+ SENSITIVE = []
1452
+ include Aws::Structure
1453
+ end
1454
+
1455
+ # @note When making an API call, you may pass GetEventTypesRequest
1456
+ # data as a hash:
1457
+ #
1458
+ # {
1459
+ # name: "identifier",
1460
+ # next_token: "string",
1461
+ # max_results: 1,
1462
+ # }
1463
+ #
1464
+ # @!attribute [rw] name
1465
+ # The name.
1466
+ # @return [String]
1467
+ #
1468
+ # @!attribute [rw] next_token
1469
+ # The next token for the subsequent request.
1470
+ # @return [String]
1471
+ #
1472
+ # @!attribute [rw] max_results
1473
+ # The maximum number of objects to return for the request.
1474
+ # @return [Integer]
1475
+ #
1476
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventTypesRequest AWS API Documentation
1477
+ #
1478
+ class GetEventTypesRequest < Struct.new(
1479
+ :name,
1480
+ :next_token,
1481
+ :max_results)
1482
+ SENSITIVE = []
1483
+ include Aws::Structure
1484
+ end
1485
+
1486
+ # @!attribute [rw] event_types
1487
+ # An array of event types.
1488
+ # @return [Array<Types::EventType>]
1489
+ #
1490
+ # @!attribute [rw] next_token
1491
+ # The next page token.
1492
+ # @return [String]
1493
+ #
1494
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventTypesResult AWS API Documentation
1495
+ #
1496
+ class GetEventTypesResult < Struct.new(
1497
+ :event_types,
1498
+ :next_token)
1499
+ SENSITIVE = []
1500
+ include Aws::Structure
1501
+ end
1502
+
1503
+ # @note When making an API call, you may pass GetExternalModelsRequest
1504
+ # data as a hash:
1505
+ #
1506
+ # {
1507
+ # model_endpoint: "string",
1508
+ # next_token: "string",
1509
+ # max_results: 1,
1510
+ # }
1511
+ #
1512
+ # @!attribute [rw] model_endpoint
883
1513
  # The Amazon SageMaker model endpoint.
884
1514
  # @return [String]
885
1515
  #
@@ -897,6 +1527,7 @@ module Aws::FraudDetector
897
1527
  :model_endpoint,
898
1528
  :next_token,
899
1529
  :max_results)
1530
+ SENSITIVE = []
900
1531
  include Aws::Structure
901
1532
  end
902
1533
 
@@ -913,6 +1544,67 @@ module Aws::FraudDetector
913
1544
  class GetExternalModelsResult < Struct.new(
914
1545
  :external_models,
915
1546
  :next_token)
1547
+ SENSITIVE = []
1548
+ include Aws::Structure
1549
+ end
1550
+
1551
+ # @!attribute [rw] kms_key
1552
+ # The KMS encryption key.
1553
+ # @return [Types::KMSKey]
1554
+ #
1555
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetKMSEncryptionKeyResult AWS API Documentation
1556
+ #
1557
+ class GetKMSEncryptionKeyResult < Struct.new(
1558
+ :kms_key)
1559
+ SENSITIVE = []
1560
+ include Aws::Structure
1561
+ end
1562
+
1563
+ # @note When making an API call, you may pass GetLabelsRequest
1564
+ # data as a hash:
1565
+ #
1566
+ # {
1567
+ # name: "identifier",
1568
+ # next_token: "string",
1569
+ # max_results: 1,
1570
+ # }
1571
+ #
1572
+ # @!attribute [rw] name
1573
+ # The name of the label or labels to get.
1574
+ # @return [String]
1575
+ #
1576
+ # @!attribute [rw] next_token
1577
+ # The next token for the subsequent request.
1578
+ # @return [String]
1579
+ #
1580
+ # @!attribute [rw] max_results
1581
+ # The maximum number of objects to return for the request.
1582
+ # @return [Integer]
1583
+ #
1584
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetLabelsRequest AWS API Documentation
1585
+ #
1586
+ class GetLabelsRequest < Struct.new(
1587
+ :name,
1588
+ :next_token,
1589
+ :max_results)
1590
+ SENSITIVE = []
1591
+ include Aws::Structure
1592
+ end
1593
+
1594
+ # @!attribute [rw] labels
1595
+ # An array of labels.
1596
+ # @return [Array<Types::Label>]
1597
+ #
1598
+ # @!attribute [rw] next_token
1599
+ # The next page token.
1600
+ # @return [String]
1601
+ #
1602
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetLabelsResult AWS API Documentation
1603
+ #
1604
+ class GetLabelsResult < Struct.new(
1605
+ :labels,
1606
+ :next_token)
1607
+ SENSITIVE = []
916
1608
  include Aws::Structure
917
1609
  end
918
1610
 
@@ -922,7 +1614,7 @@ module Aws::FraudDetector
922
1614
  # {
923
1615
  # model_id: "identifier", # required
924
1616
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
925
- # model_version_number: "nonEmptyString", # required
1617
+ # model_version_number: "floatVersionString", # required
926
1618
  # }
927
1619
  #
928
1620
  # @!attribute [rw] model_id
@@ -934,7 +1626,7 @@ module Aws::FraudDetector
934
1626
  # @return [String]
935
1627
  #
936
1628
  # @!attribute [rw] model_version_number
937
- # The model version.
1629
+ # The model version number.
938
1630
  # @return [String]
939
1631
  #
940
1632
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModelVersionRequest AWS API Documentation
@@ -943,6 +1635,7 @@ module Aws::FraudDetector
943
1635
  :model_id,
944
1636
  :model_type,
945
1637
  :model_version_number)
1638
+ SENSITIVE = []
946
1639
  include Aws::Structure
947
1640
  end
948
1641
 
@@ -955,25 +1648,41 @@ module Aws::FraudDetector
955
1648
  # @return [String]
956
1649
  #
957
1650
  # @!attribute [rw] model_version_number
958
- # The model version.
1651
+ # The model version number.
959
1652
  # @return [String]
960
1653
  #
961
- # @!attribute [rw] description
962
- # The model version description.
1654
+ # @!attribute [rw] training_data_source
1655
+ # The training data source.
963
1656
  # @return [String]
964
1657
  #
1658
+ # @!attribute [rw] training_data_schema
1659
+ # The training data schema.
1660
+ # @return [Types::TrainingDataSchema]
1661
+ #
1662
+ # @!attribute [rw] external_events_detail
1663
+ # The event details.
1664
+ # @return [Types::ExternalEventsDetail]
1665
+ #
965
1666
  # @!attribute [rw] status
966
1667
  # The model version status.
967
1668
  # @return [String]
968
1669
  #
1670
+ # @!attribute [rw] arn
1671
+ # The model version ARN.
1672
+ # @return [String]
1673
+ #
969
1674
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModelVersionResult AWS API Documentation
970
1675
  #
971
1676
  class GetModelVersionResult < Struct.new(
972
1677
  :model_id,
973
1678
  :model_type,
974
1679
  :model_version_number,
975
- :description,
976
- :status)
1680
+ :training_data_source,
1681
+ :training_data_schema,
1682
+ :external_events_detail,
1683
+ :status,
1684
+ :arn)
1685
+ SENSITIVE = []
977
1686
  include Aws::Structure
978
1687
  end
979
1688
 
@@ -981,44 +1690,45 @@ module Aws::FraudDetector
981
1690
  # data as a hash:
982
1691
  #
983
1692
  # {
984
- # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
985
1693
  # model_id: "identifier",
1694
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
986
1695
  # next_token: "string",
987
1696
  # max_results: 1,
988
1697
  # }
989
1698
  #
990
- # @!attribute [rw] model_type
991
- # The model type.
992
- # @return [String]
993
- #
994
1699
  # @!attribute [rw] model_id
995
1700
  # The model ID.
996
1701
  # @return [String]
997
1702
  #
1703
+ # @!attribute [rw] model_type
1704
+ # The model type.
1705
+ # @return [String]
1706
+ #
998
1707
  # @!attribute [rw] next_token
999
- # The next token for the request.
1708
+ # The next token for the subsequent request.
1000
1709
  # @return [String]
1001
1710
  #
1002
1711
  # @!attribute [rw] max_results
1003
- # The maximum results to return for the request.
1712
+ # The maximum number of objects to return for the request.
1004
1713
  # @return [Integer]
1005
1714
  #
1006
1715
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModelsRequest AWS API Documentation
1007
1716
  #
1008
1717
  class GetModelsRequest < Struct.new(
1009
- :model_type,
1010
1718
  :model_id,
1719
+ :model_type,
1011
1720
  :next_token,
1012
1721
  :max_results)
1722
+ SENSITIVE = []
1013
1723
  include Aws::Structure
1014
1724
  end
1015
1725
 
1016
1726
  # @!attribute [rw] next_token
1017
- # The next token for subsequent requests.
1727
+ # The next page token to be used in subsequent requests.
1018
1728
  # @return [String]
1019
1729
  #
1020
1730
  # @!attribute [rw] models
1021
- # The returned models.
1731
+ # The array of models.
1022
1732
  # @return [Array<Types::Model>]
1023
1733
  #
1024
1734
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModelsResult AWS API Documentation
@@ -1026,6 +1736,7 @@ module Aws::FraudDetector
1026
1736
  class GetModelsResult < Struct.new(
1027
1737
  :next_token,
1028
1738
  :models)
1739
+ SENSITIVE = []
1029
1740
  include Aws::Structure
1030
1741
  end
1031
1742
 
@@ -1056,6 +1767,7 @@ module Aws::FraudDetector
1056
1767
  :name,
1057
1768
  :next_token,
1058
1769
  :max_results)
1770
+ SENSITIVE = []
1059
1771
  include Aws::Structure
1060
1772
  end
1061
1773
 
@@ -1072,78 +1784,7 @@ module Aws::FraudDetector
1072
1784
  class GetOutcomesResult < Struct.new(
1073
1785
  :outcomes,
1074
1786
  :next_token)
1075
- include Aws::Structure
1076
- end
1077
-
1078
- # @note When making an API call, you may pass GetPredictionRequest
1079
- # data as a hash:
1080
- #
1081
- # {
1082
- # detector_id: "string", # required
1083
- # detector_version_id: "string",
1084
- # event_id: "string", # required
1085
- # event_attributes: {
1086
- # "attributeKey" => "attributeValue",
1087
- # },
1088
- # external_model_endpoint_data_blobs: {
1089
- # "string" => {
1090
- # byte_buffer: "data",
1091
- # content_type: "contentType",
1092
- # },
1093
- # },
1094
- # }
1095
- #
1096
- # @!attribute [rw] detector_id
1097
- # The detector ID.
1098
- # @return [String]
1099
- #
1100
- # @!attribute [rw] detector_version_id
1101
- # The detector version ID.
1102
- # @return [String]
1103
- #
1104
- # @!attribute [rw] event_id
1105
- # The unique ID used to identify the event.
1106
- # @return [String]
1107
- #
1108
- # @!attribute [rw] event_attributes
1109
- # Names of variables you defined in Amazon Fraud Detector to represent
1110
- # event data elements and their corresponding values for the event you
1111
- # are sending for evaluation.
1112
- # @return [Hash<String,String>]
1113
- #
1114
- # @!attribute [rw] external_model_endpoint_data_blobs
1115
- # The Amazon SageMaker model endpoint input data blobs.
1116
- # @return [Hash<String,Types::ModelEndpointDataBlob>]
1117
- #
1118
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetPredictionRequest AWS API Documentation
1119
- #
1120
- class GetPredictionRequest < Struct.new(
1121
- :detector_id,
1122
- :detector_version_id,
1123
- :event_id,
1124
- :event_attributes,
1125
- :external_model_endpoint_data_blobs)
1126
- include Aws::Structure
1127
- end
1128
-
1129
- # @!attribute [rw] outcomes
1130
- # The prediction outcomes.
1131
- # @return [Array<String>]
1132
- #
1133
- # @!attribute [rw] model_scores
1134
- # The model scores for models used in the detector version.
1135
- # @return [Array<Types::ModelScores>]
1136
- #
1137
- # @!attribute [rw] rule_results
1138
- # The rule results in the prediction.
1139
- # @return [Array<Types::RuleResult>]
1140
- #
1141
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetPredictionResult AWS API Documentation
1142
- #
1143
- class GetPredictionResult < Struct.new(
1144
- :outcomes,
1145
- :model_scores,
1146
- :rule_results)
1787
+ SENSITIVE = []
1147
1788
  include Aws::Structure
1148
1789
  end
1149
1790
 
@@ -1153,7 +1794,7 @@ module Aws::FraudDetector
1153
1794
  # {
1154
1795
  # rule_id: "identifier",
1155
1796
  # detector_id: "identifier", # required
1156
- # rule_version: "nonEmptyString",
1797
+ # rule_version: "wholeNumberVersionString",
1157
1798
  # next_token: "string",
1158
1799
  # max_results: 1,
1159
1800
  # }
@@ -1186,6 +1827,7 @@ module Aws::FraudDetector
1186
1827
  :rule_version,
1187
1828
  :next_token,
1188
1829
  :max_results)
1830
+ SENSITIVE = []
1189
1831
  include Aws::Structure
1190
1832
  end
1191
1833
 
@@ -1202,6 +1844,7 @@ module Aws::FraudDetector
1202
1844
  class GetRulesResult < Struct.new(
1203
1845
  :rule_details,
1204
1846
  :next_token)
1847
+ SENSITIVE = []
1205
1848
  include Aws::Structure
1206
1849
  end
1207
1850
 
@@ -1232,6 +1875,7 @@ module Aws::FraudDetector
1232
1875
  :name,
1233
1876
  :next_token,
1234
1877
  :max_results)
1878
+ SENSITIVE = []
1235
1879
  include Aws::Structure
1236
1880
  end
1237
1881
 
@@ -1248,6 +1892,7 @@ module Aws::FraudDetector
1248
1892
  class GetVariablesResult < Struct.new(
1249
1893
  :variables,
1250
1894
  :next_token)
1895
+ SENSITIVE = []
1251
1896
  include Aws::Structure
1252
1897
  end
1253
1898
 
@@ -1260,6 +1905,55 @@ module Aws::FraudDetector
1260
1905
  #
1261
1906
  class InternalServerException < Struct.new(
1262
1907
  :message)
1908
+ SENSITIVE = []
1909
+ include Aws::Structure
1910
+ end
1911
+
1912
+ # The KMS key details.
1913
+ #
1914
+ # @!attribute [rw] kms_encryption_key_arn
1915
+ # The encryption key ARN.
1916
+ # @return [String]
1917
+ #
1918
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/KMSKey AWS API Documentation
1919
+ #
1920
+ class KMSKey < Struct.new(
1921
+ :kms_encryption_key_arn)
1922
+ SENSITIVE = []
1923
+ include Aws::Structure
1924
+ end
1925
+
1926
+ # The label details.
1927
+ #
1928
+ # @!attribute [rw] name
1929
+ # The label name.
1930
+ # @return [String]
1931
+ #
1932
+ # @!attribute [rw] description
1933
+ # The label description.
1934
+ # @return [String]
1935
+ #
1936
+ # @!attribute [rw] last_updated_time
1937
+ # Timestamp of when the label was last updated.
1938
+ # @return [String]
1939
+ #
1940
+ # @!attribute [rw] created_time
1941
+ # Timestamp of when the event type was created.
1942
+ # @return [String]
1943
+ #
1944
+ # @!attribute [rw] arn
1945
+ # The label ARN.
1946
+ # @return [String]
1947
+ #
1948
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Label AWS API Documentation
1949
+ #
1950
+ class Label < Struct.new(
1951
+ :name,
1952
+ :description,
1953
+ :last_updated_time,
1954
+ :created_time,
1955
+ :arn)
1956
+ SENSITIVE = []
1263
1957
  include Aws::Structure
1264
1958
  end
1265
1959
 
@@ -1269,32 +1963,110 @@ module Aws::FraudDetector
1269
1963
  # data as a hash:
1270
1964
  #
1271
1965
  # {
1272
- # label_key: "string", # required
1273
1966
  # label_mapper: { # required
1274
1967
  # "string" => ["string"],
1275
1968
  # },
1276
1969
  # }
1277
1970
  #
1278
- # @!attribute [rw] label_key
1279
- # The label key.
1280
- # @return [String]
1281
- #
1282
1971
  # @!attribute [rw] label_mapper
1283
- # The label mapper maps the Amazon Fraud Detector supported label to
1284
- # the appropriate source labels. For example, if `"FRAUD"` and
1285
- # `"LEGIT"` are Amazon Fraud Detector supported labels, this mapper
1286
- # could be: `\{"FRAUD" => ["0"]`, "LEGIT" =&gt; \["1"\]\\} or
1287
- # `\{"FRAUD" => ["false"], "LEGIT" => ["true"]\}` or `\{"FRAUD" =>
1288
- # ["fraud", "abuse"], "LEGIT" => ["legit", "safe"]\}`. The value part
1289
- # of the mapper is a list, because you may have multiple variants for
1290
- # a single Amazon Fraud Detector label.
1972
+ # The label mapper maps the Amazon Fraud Detector supported model
1973
+ # classification labels (`FRAUD`, `LEGIT`) to the appropriate event
1974
+ # type labels. For example, if "`FRAUD`" and "`LEGIT`" are Amazon
1975
+ # Fraud Detector supported labels, this mapper could be: `\{"FRAUD" =>
1976
+ # ["0"]`, `"LEGIT" => ["1"]\}` or `\{"FRAUD" => ["false"]`, `"LEGIT"
1977
+ # => ["true"]\}` or `\{"FRAUD" => ["fraud", "abuse"]`, `"LEGIT" =>
1978
+ # ["legit", "safe"]\}`. The value part of the mapper is a list,
1979
+ # because you may have multiple label variants from your event type
1980
+ # for a single Amazon Fraud Detector label.
1291
1981
  # @return [Hash<String,Array<String>>]
1292
1982
  #
1293
1983
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/LabelSchema AWS API Documentation
1294
1984
  #
1295
1985
  class LabelSchema < Struct.new(
1296
- :label_key,
1297
1986
  :label_mapper)
1987
+ SENSITIVE = []
1988
+ include Aws::Structure
1989
+ end
1990
+
1991
+ # @note When making an API call, you may pass ListTagsForResourceRequest
1992
+ # data as a hash:
1993
+ #
1994
+ # {
1995
+ # resource_arn: "fraudDetectorArn", # required
1996
+ # next_token: "string",
1997
+ # max_results: 1,
1998
+ # }
1999
+ #
2000
+ # @!attribute [rw] resource_arn
2001
+ # The ARN that specifies the resource whose tags you want to list.
2002
+ # @return [String]
2003
+ #
2004
+ # @!attribute [rw] next_token
2005
+ # The next token from the previous results.
2006
+ # @return [String]
2007
+ #
2008
+ # @!attribute [rw] max_results
2009
+ # The maximum number of objects to return for the request.
2010
+ # @return [Integer]
2011
+ #
2012
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ListTagsForResourceRequest AWS API Documentation
2013
+ #
2014
+ class ListTagsForResourceRequest < Struct.new(
2015
+ :resource_arn,
2016
+ :next_token,
2017
+ :max_results)
2018
+ SENSITIVE = []
2019
+ include Aws::Structure
2020
+ end
2021
+
2022
+ # @!attribute [rw] tags
2023
+ # A collection of key and value pairs.
2024
+ # @return [Array<Types::Tag>]
2025
+ #
2026
+ # @!attribute [rw] next_token
2027
+ # The next token for subsequent requests.
2028
+ # @return [String]
2029
+ #
2030
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ListTagsForResourceResult AWS API Documentation
2031
+ #
2032
+ class ListTagsForResourceResult < Struct.new(
2033
+ :tags,
2034
+ :next_token)
2035
+ SENSITIVE = []
2036
+ include Aws::Structure
2037
+ end
2038
+
2039
+ # Model performance metrics data points.
2040
+ #
2041
+ # @!attribute [rw] fpr
2042
+ # The false positive rate. This is the percentage of total legitimate
2043
+ # events that are incorrectly predicted as fraud.
2044
+ # @return [Float]
2045
+ #
2046
+ # @!attribute [rw] precision
2047
+ # The percentage of fraud events correctly predicted as fraudulent as
2048
+ # compared to all events predicted as fraudulent.
2049
+ # @return [Float]
2050
+ #
2051
+ # @!attribute [rw] tpr
2052
+ # The true positive rate. This is the percentage of total fraud the
2053
+ # model detects. Also known as capture rate.
2054
+ # @return [Float]
2055
+ #
2056
+ # @!attribute [rw] threshold
2057
+ # The model threshold that specifies an acceptable fraud capture rate.
2058
+ # For example, a threshold of 500 means any model score 500 or above
2059
+ # is labeled as fraud.
2060
+ # @return [Float]
2061
+ #
2062
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/MetricDataPoint AWS API Documentation
2063
+ #
2064
+ class MetricDataPoint < Struct.new(
2065
+ :fpr,
2066
+ :precision,
2067
+ :tpr,
2068
+ :threshold)
2069
+ SENSITIVE = []
1298
2070
  include Aws::Structure
1299
2071
  end
1300
2072
 
@@ -1312,24 +2084,20 @@ module Aws::FraudDetector
1312
2084
  # The model description.
1313
2085
  # @return [String]
1314
2086
  #
1315
- # @!attribute [rw] training_data_source
1316
- # The model training data source in Amazon S3.
1317
- # @return [Types::TrainingDataSource]
1318
- #
1319
- # @!attribute [rw] model_variables
1320
- # The model input variables.
1321
- # @return [Array<Types::ModelVariable>]
2087
+ # @!attribute [rw] event_type_name
2088
+ # The name of the event type.
2089
+ # @return [String]
1322
2090
  #
1323
- # @!attribute [rw] label_schema
1324
- # The model label schema.
1325
- # @return [Types::LabelSchema]
2091
+ # @!attribute [rw] created_time
2092
+ # Timestamp of when the model was created.
2093
+ # @return [String]
1326
2094
  #
1327
2095
  # @!attribute [rw] last_updated_time
1328
2096
  # Timestamp of last time the model was updated.
1329
2097
  # @return [String]
1330
2098
  #
1331
- # @!attribute [rw] created_time
1332
- # Timestamp of when the model was created.
2099
+ # @!attribute [rw] arn
2100
+ # The ARN of the model.
1333
2101
  # @return [String]
1334
2102
  #
1335
2103
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Model AWS API Documentation
@@ -1338,11 +2106,11 @@ module Aws::FraudDetector
1338
2106
  :model_id,
1339
2107
  :model_type,
1340
2108
  :description,
1341
- :training_data_source,
1342
- :model_variables,
1343
- :label_schema,
2109
+ :event_type_name,
2110
+ :created_time,
1344
2111
  :last_updated_time,
1345
- :created_time)
2112
+ :arn)
2113
+ SENSITIVE = []
1346
2114
  include Aws::Structure
1347
2115
  end
1348
2116
 
@@ -1373,17 +2141,18 @@ module Aws::FraudDetector
1373
2141
  class ModelEndpointDataBlob < Struct.new(
1374
2142
  :byte_buffer,
1375
2143
  :content_type)
2144
+ SENSITIVE = []
1376
2145
  include Aws::Structure
1377
2146
  end
1378
2147
 
1379
- # The model input configuration.
2148
+ # The Amazon SageMaker model input configuration.
1380
2149
  #
1381
2150
  # @note When making an API call, you may pass ModelInputConfiguration
1382
2151
  # data as a hash:
1383
2152
  #
1384
2153
  # {
1385
2154
  # format: "TEXT_CSV", # accepts TEXT_CSV, APPLICATION_JSON
1386
- # is_opaque: false, # required
2155
+ # use_event_variables: false, # required
1387
2156
  # json_input_template: "string",
1388
2157
  # csv_input_template: "string",
1389
2158
  # }
@@ -1394,12 +2163,8 @@ module Aws::FraudDetector
1394
2163
  # Amazon Fraud Detector.
1395
2164
  # @return [String]
1396
2165
  #
1397
- # @!attribute [rw] is_opaque
1398
- # For an opaque-model, the input to the model will be a ByteBuffer
1399
- # blob provided in the getPrediction request, and will be passed to
1400
- # SageMaker as-is. For non-opaque models, the input will be
1401
- # constructed by Amazon Fraud Detector based on the
1402
- # model-configuration.
2166
+ # @!attribute [rw] use_event_variables
2167
+ # The event variables.
1403
2168
  # @return [Boolean]
1404
2169
  #
1405
2170
  # @!attribute [rw] json_input_template
@@ -1420,13 +2185,14 @@ module Aws::FraudDetector
1420
2185
  #
1421
2186
  class ModelInputConfiguration < Struct.new(
1422
2187
  :format,
1423
- :is_opaque,
2188
+ :use_event_variables,
1424
2189
  :json_input_template,
1425
2190
  :csv_input_template)
2191
+ SENSITIVE = []
1426
2192
  include Aws::Structure
1427
2193
  end
1428
2194
 
1429
- # Provides the model output configuration.
2195
+ # Provides the Amazon Sagemaker model output configuration.
1430
2196
  #
1431
2197
  # @note When making an API call, you may pass ModelOutputConfiguration
1432
2198
  # data as a hash:
@@ -1461,6 +2227,7 @@ module Aws::FraudDetector
1461
2227
  :format,
1462
2228
  :json_key_to_variable_map,
1463
2229
  :csv_index_to_variable_map)
2230
+ SENSITIVE = []
1464
2231
  include Aws::Structure
1465
2232
  end
1466
2233
 
@@ -1479,32 +2246,7 @@ module Aws::FraudDetector
1479
2246
  class ModelScores < Struct.new(
1480
2247
  :model_version,
1481
2248
  :scores)
1482
- include Aws::Structure
1483
- end
1484
-
1485
- # The model variable.&gt;
1486
- #
1487
- # @note When making an API call, you may pass ModelVariable
1488
- # data as a hash:
1489
- #
1490
- # {
1491
- # name: "string", # required
1492
- # index: 1,
1493
- # }
1494
- #
1495
- # @!attribute [rw] name
1496
- # The model variable's name.&gt;
1497
- # @return [String]
1498
- #
1499
- # @!attribute [rw] index
1500
- # The model variable's index.&gt;
1501
- # @return [Integer]
1502
- #
1503
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ModelVariable AWS API Documentation
1504
- #
1505
- class ModelVariable < Struct.new(
1506
- :name,
1507
- :index)
2249
+ SENSITIVE = []
1508
2250
  include Aws::Structure
1509
2251
  end
1510
2252
 
@@ -1517,10 +2259,11 @@ module Aws::FraudDetector
1517
2259
  # model_id: "identifier", # required
1518
2260
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1519
2261
  # model_version_number: "nonEmptyString", # required
2262
+ # arn: "fraudDetectorArn",
1520
2263
  # }
1521
2264
  #
1522
2265
  # @!attribute [rw] model_id
1523
- # The parent model ID.
2266
+ # The model ID.
1524
2267
  # @return [String]
1525
2268
  #
1526
2269
  # @!attribute [rw] model_type
@@ -1528,7 +2271,11 @@ module Aws::FraudDetector
1528
2271
  # @return [String]
1529
2272
  #
1530
2273
  # @!attribute [rw] model_version_number
1531
- # The model version.
2274
+ # The model version number.
2275
+ # @return [String]
2276
+ #
2277
+ # @!attribute [rw] arn
2278
+ # The model version ARN.
1532
2279
  # @return [String]
1533
2280
  #
1534
2281
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ModelVersion AWS API Documentation
@@ -1536,11 +2283,13 @@ module Aws::FraudDetector
1536
2283
  class ModelVersion < Struct.new(
1537
2284
  :model_id,
1538
2285
  :model_type,
1539
- :model_version_number)
2286
+ :model_version_number,
2287
+ :arn)
2288
+ SENSITIVE = []
1540
2289
  include Aws::Structure
1541
2290
  end
1542
2291
 
1543
- # Provides the model version details.
2292
+ # The details of the model version.
1544
2293
  #
1545
2294
  # @!attribute [rw] model_id
1546
2295
  # The model ID.
@@ -1551,36 +2300,28 @@ module Aws::FraudDetector
1551
2300
  # @return [String]
1552
2301
  #
1553
2302
  # @!attribute [rw] model_version_number
1554
- # The model version.
1555
- # @return [String]
1556
- #
1557
- # @!attribute [rw] description
1558
- # The model description.
2303
+ # The model version number.
1559
2304
  # @return [String]
1560
2305
  #
1561
2306
  # @!attribute [rw] status
1562
- # The model status.
2307
+ # The status of the model version.
1563
2308
  # @return [String]
1564
2309
  #
1565
2310
  # @!attribute [rw] training_data_source
1566
- # The model training data source.
1567
- # @return [Types::TrainingDataSource]
1568
- #
1569
- # @!attribute [rw] model_variables
1570
- # The model variables.
1571
- # @return [Array<Types::ModelVariable>]
2311
+ # The model version training data source.
2312
+ # @return [String]
1572
2313
  #
1573
- # @!attribute [rw] label_schema
1574
- # The model label schema.
1575
- # @return [Types::LabelSchema]
2314
+ # @!attribute [rw] training_data_schema
2315
+ # The training data schema.
2316
+ # @return [Types::TrainingDataSchema]
1576
2317
  #
1577
- # @!attribute [rw] validation_metrics
1578
- # The model validation metrics.
1579
- # @return [Hash<String,String>]
2318
+ # @!attribute [rw] external_events_detail
2319
+ # The event details.
2320
+ # @return [Types::ExternalEventsDetail]
1580
2321
  #
1581
- # @!attribute [rw] training_metrics
1582
- # The model training metrics.
1583
- # @return [Hash<String,String>]
2322
+ # @!attribute [rw] training_result
2323
+ # The training results.
2324
+ # @return [Types::TrainingResult]
1584
2325
  #
1585
2326
  # @!attribute [rw] last_updated_time
1586
2327
  # The timestamp when the model was last updated.
@@ -1590,21 +2331,25 @@ module Aws::FraudDetector
1590
2331
  # The timestamp when the model was created.
1591
2332
  # @return [String]
1592
2333
  #
2334
+ # @!attribute [rw] arn
2335
+ # The model version ARN.
2336
+ # @return [String]
2337
+ #
1593
2338
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ModelVersionDetail AWS API Documentation
1594
2339
  #
1595
2340
  class ModelVersionDetail < Struct.new(
1596
2341
  :model_id,
1597
2342
  :model_type,
1598
2343
  :model_version_number,
1599
- :description,
1600
2344
  :status,
1601
2345
  :training_data_source,
1602
- :model_variables,
1603
- :label_schema,
1604
- :validation_metrics,
1605
- :training_metrics,
2346
+ :training_data_schema,
2347
+ :external_events_detail,
2348
+ :training_result,
1606
2349
  :last_updated_time,
1607
- :created_time)
2350
+ :created_time,
2351
+ :arn)
2352
+ SENSITIVE = []
1608
2353
  include Aws::Structure
1609
2354
  end
1610
2355
 
@@ -1626,13 +2371,19 @@ module Aws::FraudDetector
1626
2371
  # The timestamp when the outcome was created.
1627
2372
  # @return [String]
1628
2373
  #
2374
+ # @!attribute [rw] arn
2375
+ # The outcome ARN.
2376
+ # @return [String]
2377
+ #
1629
2378
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Outcome AWS API Documentation
1630
2379
  #
1631
2380
  class Outcome < Struct.new(
1632
2381
  :name,
1633
2382
  :description,
1634
2383
  :last_updated_time,
1635
- :created_time)
2384
+ :created_time,
2385
+ :arn)
2386
+ SENSITIVE = []
1636
2387
  include Aws::Structure
1637
2388
  end
1638
2389
 
@@ -1642,6 +2393,13 @@ module Aws::FraudDetector
1642
2393
  # {
1643
2394
  # detector_id: "identifier", # required
1644
2395
  # description: "description",
2396
+ # event_type_name: "identifier", # required
2397
+ # tags: [
2398
+ # {
2399
+ # key: "tagKey", # required
2400
+ # value: "tagValue", # required
2401
+ # },
2402
+ # ],
1645
2403
  # }
1646
2404
  #
1647
2405
  # @!attribute [rw] detector_id
@@ -1652,11 +2410,22 @@ module Aws::FraudDetector
1652
2410
  # The description of the detector.
1653
2411
  # @return [String]
1654
2412
  #
2413
+ # @!attribute [rw] event_type_name
2414
+ # The name of the event type.
2415
+ # @return [String]
2416
+ #
2417
+ # @!attribute [rw] tags
2418
+ # A collection of key and value pairs.
2419
+ # @return [Array<Types::Tag>]
2420
+ #
1655
2421
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutDetectorRequest AWS API Documentation
1656
2422
  #
1657
2423
  class PutDetectorRequest < Struct.new(
1658
2424
  :detector_id,
1659
- :description)
2425
+ :description,
2426
+ :event_type_name,
2427
+ :tags)
2428
+ SENSITIVE = []
1660
2429
  include Aws::Structure
1661
2430
  end
1662
2431
 
@@ -1664,19 +2433,116 @@ module Aws::FraudDetector
1664
2433
  #
1665
2434
  class PutDetectorResult < Aws::EmptyStructure; end
1666
2435
 
2436
+ # @note When making an API call, you may pass PutEntityTypeRequest
2437
+ # data as a hash:
2438
+ #
2439
+ # {
2440
+ # name: "identifier", # required
2441
+ # description: "description",
2442
+ # tags: [
2443
+ # {
2444
+ # key: "tagKey", # required
2445
+ # value: "tagValue", # required
2446
+ # },
2447
+ # ],
2448
+ # }
2449
+ #
2450
+ # @!attribute [rw] name
2451
+ # The name of the entity type.
2452
+ # @return [String]
2453
+ #
2454
+ # @!attribute [rw] description
2455
+ # The description.
2456
+ # @return [String]
2457
+ #
2458
+ # @!attribute [rw] tags
2459
+ # A collection of key and value pairs.
2460
+ # @return [Array<Types::Tag>]
2461
+ #
2462
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutEntityTypeRequest AWS API Documentation
2463
+ #
2464
+ class PutEntityTypeRequest < Struct.new(
2465
+ :name,
2466
+ :description,
2467
+ :tags)
2468
+ SENSITIVE = []
2469
+ include Aws::Structure
2470
+ end
2471
+
2472
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutEntityTypeResult AWS API Documentation
2473
+ #
2474
+ class PutEntityTypeResult < Aws::EmptyStructure; end
2475
+
2476
+ # @note When making an API call, you may pass PutEventTypeRequest
2477
+ # data as a hash:
2478
+ #
2479
+ # {
2480
+ # name: "identifier", # required
2481
+ # description: "description",
2482
+ # event_variables: ["string"], # required
2483
+ # labels: ["string"],
2484
+ # entity_types: ["string"], # required
2485
+ # tags: [
2486
+ # {
2487
+ # key: "tagKey", # required
2488
+ # value: "tagValue", # required
2489
+ # },
2490
+ # ],
2491
+ # }
2492
+ #
2493
+ # @!attribute [rw] name
2494
+ # The name.
2495
+ # @return [String]
2496
+ #
2497
+ # @!attribute [rw] description
2498
+ # The description of the event type.
2499
+ # @return [String]
2500
+ #
2501
+ # @!attribute [rw] event_variables
2502
+ # The event type variables.
2503
+ # @return [Array<String>]
2504
+ #
2505
+ # @!attribute [rw] labels
2506
+ # The event type labels.
2507
+ # @return [Array<String>]
2508
+ #
2509
+ # @!attribute [rw] entity_types
2510
+ # The entity type for the event type. Example entity types: customer,
2511
+ # merchant, account.
2512
+ # @return [Array<String>]
2513
+ #
2514
+ # @!attribute [rw] tags
2515
+ # A collection of key and value pairs.
2516
+ # @return [Array<Types::Tag>]
2517
+ #
2518
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutEventTypeRequest AWS API Documentation
2519
+ #
2520
+ class PutEventTypeRequest < Struct.new(
2521
+ :name,
2522
+ :description,
2523
+ :event_variables,
2524
+ :labels,
2525
+ :entity_types,
2526
+ :tags)
2527
+ SENSITIVE = []
2528
+ include Aws::Structure
2529
+ end
2530
+
2531
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutEventTypeResult AWS API Documentation
2532
+ #
2533
+ class PutEventTypeResult < Aws::EmptyStructure; end
2534
+
1667
2535
  # @note When making an API call, you may pass PutExternalModelRequest
1668
2536
  # data as a hash:
1669
2537
  #
1670
2538
  # {
1671
- # model_endpoint: "string", # required
2539
+ # model_endpoint: "sageMakerEndpointIdentifier", # required
2540
+ # event_type_name: "identifier",
1672
2541
  # model_source: "SAGEMAKER", # required, accepts SAGEMAKER
1673
- # role: { # required
1674
- # arn: "string", # required
1675
- # name: "string", # required
1676
- # },
2542
+ # invoke_model_endpoint_role_arn: "string", # required
1677
2543
  # input_configuration: { # required
1678
2544
  # format: "TEXT_CSV", # accepts TEXT_CSV, APPLICATION_JSON
1679
- # is_opaque: false, # required
2545
+ # use_event_variables: false, # required
1680
2546
  # json_input_template: "string",
1681
2547
  # csv_input_template: "string",
1682
2548
  # },
@@ -1690,19 +2556,29 @@ module Aws::FraudDetector
1690
2556
  # },
1691
2557
  # },
1692
2558
  # model_endpoint_status: "ASSOCIATED", # required, accepts ASSOCIATED, DISSOCIATED
2559
+ # tags: [
2560
+ # {
2561
+ # key: "tagKey", # required
2562
+ # value: "tagValue", # required
2563
+ # },
2564
+ # ],
1693
2565
  # }
1694
2566
  #
1695
2567
  # @!attribute [rw] model_endpoint
1696
2568
  # The model endpoints name.
1697
2569
  # @return [String]
1698
2570
  #
2571
+ # @!attribute [rw] event_type_name
2572
+ # The event type name.
2573
+ # @return [String]
2574
+ #
1699
2575
  # @!attribute [rw] model_source
1700
2576
  # The source of the model.
1701
2577
  # @return [String]
1702
2578
  #
1703
- # @!attribute [rw] role
2579
+ # @!attribute [rw] invoke_model_endpoint_role_arn
1704
2580
  # The IAM role used to invoke the model endpoint.
1705
- # @return [Types::Role]
2581
+ # @return [String]
1706
2582
  #
1707
2583
  # @!attribute [rw] input_configuration
1708
2584
  # The model endpoint input configuration.
@@ -1716,15 +2592,22 @@ module Aws::FraudDetector
1716
2592
  # The model endpoint’s status in Amazon Fraud Detector.
1717
2593
  # @return [String]
1718
2594
  #
2595
+ # @!attribute [rw] tags
2596
+ # A collection of key and value pairs.
2597
+ # @return [Array<Types::Tag>]
2598
+ #
1719
2599
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutExternalModelRequest AWS API Documentation
1720
2600
  #
1721
2601
  class PutExternalModelRequest < Struct.new(
1722
2602
  :model_endpoint,
2603
+ :event_type_name,
1723
2604
  :model_source,
1724
- :role,
2605
+ :invoke_model_endpoint_role_arn,
1725
2606
  :input_configuration,
1726
2607
  :output_configuration,
1727
- :model_endpoint_status)
2608
+ :model_endpoint_status,
2609
+ :tags)
2610
+ SENSITIVE = []
1728
2611
  include Aws::Structure
1729
2612
  end
1730
2613
 
@@ -1732,70 +2615,67 @@ module Aws::FraudDetector
1732
2615
  #
1733
2616
  class PutExternalModelResult < Aws::EmptyStructure; end
1734
2617
 
1735
- # @note When making an API call, you may pass PutModelRequest
2618
+ # @note When making an API call, you may pass PutKMSEncryptionKeyRequest
1736
2619
  # data as a hash:
1737
2620
  #
1738
2621
  # {
1739
- # model_id: "identifier", # required
1740
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
2622
+ # kms_encryption_key_arn: "KmsEncryptionKeyArn", # required
2623
+ # }
2624
+ #
2625
+ # @!attribute [rw] kms_encryption_key_arn
2626
+ # The KMS encryption key ARN.
2627
+ # @return [String]
2628
+ #
2629
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutKMSEncryptionKeyRequest AWS API Documentation
2630
+ #
2631
+ class PutKMSEncryptionKeyRequest < Struct.new(
2632
+ :kms_encryption_key_arn)
2633
+ SENSITIVE = []
2634
+ include Aws::Structure
2635
+ end
2636
+
2637
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutKMSEncryptionKeyResult AWS API Documentation
2638
+ #
2639
+ class PutKMSEncryptionKeyResult < Aws::EmptyStructure; end
2640
+
2641
+ # @note When making an API call, you may pass PutLabelRequest
2642
+ # data as a hash:
2643
+ #
2644
+ # {
2645
+ # name: "identifier", # required
1741
2646
  # description: "description",
1742
- # training_data_source: { # required
1743
- # data_location: "s3BucketLocation", # required
1744
- # data_access_role_arn: "iamRoleArn", # required
1745
- # },
1746
- # model_variables: [ # required
2647
+ # tags: [
1747
2648
  # {
1748
- # name: "string", # required
1749
- # index: 1,
2649
+ # key: "tagKey", # required
2650
+ # value: "tagValue", # required
1750
2651
  # },
1751
2652
  # ],
1752
- # label_schema: { # required
1753
- # label_key: "string", # required
1754
- # label_mapper: { # required
1755
- # "string" => ["string"],
1756
- # },
1757
- # },
1758
2653
  # }
1759
2654
  #
1760
- # @!attribute [rw] model_id
1761
- # The model ID.
1762
- # @return [String]
1763
- #
1764
- # @!attribute [rw] model_type
1765
- # The model type.
2655
+ # @!attribute [rw] name
2656
+ # The label name.
1766
2657
  # @return [String]
1767
2658
  #
1768
2659
  # @!attribute [rw] description
1769
- # The model description.
2660
+ # The label description.
1770
2661
  # @return [String]
1771
2662
  #
1772
- # @!attribute [rw] training_data_source
1773
- # The training data source location in Amazon S3.
1774
- # @return [Types::TrainingDataSource]
1775
- #
1776
- # @!attribute [rw] model_variables
1777
- # The model input variables.
1778
- # @return [Array<Types::ModelVariable>]
1779
- #
1780
- # @!attribute [rw] label_schema
1781
- # The label schema.
1782
- # @return [Types::LabelSchema]
2663
+ # @!attribute [rw] tags
2664
+ # @return [Array<Types::Tag>]
1783
2665
  #
1784
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutModelRequest AWS API Documentation
2666
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutLabelRequest AWS API Documentation
1785
2667
  #
1786
- class PutModelRequest < Struct.new(
1787
- :model_id,
1788
- :model_type,
2668
+ class PutLabelRequest < Struct.new(
2669
+ :name,
1789
2670
  :description,
1790
- :training_data_source,
1791
- :model_variables,
1792
- :label_schema)
2671
+ :tags)
2672
+ SENSITIVE = []
1793
2673
  include Aws::Structure
1794
2674
  end
1795
2675
 
1796
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutModelResult AWS API Documentation
2676
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutLabelResult AWS API Documentation
1797
2677
  #
1798
- class PutModelResult < Aws::EmptyStructure; end
2678
+ class PutLabelResult < Aws::EmptyStructure; end
1799
2679
 
1800
2680
  # @note When making an API call, you may pass PutOutcomeRequest
1801
2681
  # data as a hash:
@@ -1803,6 +2683,12 @@ module Aws::FraudDetector
1803
2683
  # {
1804
2684
  # name: "identifier", # required
1805
2685
  # description: "description",
2686
+ # tags: [
2687
+ # {
2688
+ # key: "tagKey", # required
2689
+ # value: "tagValue", # required
2690
+ # },
2691
+ # ],
1806
2692
  # }
1807
2693
  #
1808
2694
  # @!attribute [rw] name
@@ -1813,11 +2699,17 @@ module Aws::FraudDetector
1813
2699
  # The outcome description.
1814
2700
  # @return [String]
1815
2701
  #
2702
+ # @!attribute [rw] tags
2703
+ # A collection of key and value pairs.
2704
+ # @return [Array<Types::Tag>]
2705
+ #
1816
2706
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutOutcomeRequest AWS API Documentation
1817
2707
  #
1818
2708
  class PutOutcomeRequest < Struct.new(
1819
2709
  :name,
1820
- :description)
2710
+ :description,
2711
+ :tags)
2712
+ SENSITIVE = []
1821
2713
  include Aws::Structure
1822
2714
  end
1823
2715
 
@@ -1834,32 +2726,7 @@ module Aws::FraudDetector
1834
2726
  #
1835
2727
  class ResourceNotFoundException < Struct.new(
1836
2728
  :message)
1837
- include Aws::Structure
1838
- end
1839
-
1840
- # The role used to invoke external model endpoints.
1841
- #
1842
- # @note When making an API call, you may pass Role
1843
- # data as a hash:
1844
- #
1845
- # {
1846
- # arn: "string", # required
1847
- # name: "string", # required
1848
- # }
1849
- #
1850
- # @!attribute [rw] arn
1851
- # The role ARN.
1852
- # @return [String]
1853
- #
1854
- # @!attribute [rw] name
1855
- # The role name.
1856
- # @return [String]
1857
- #
1858
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Role AWS API Documentation
1859
- #
1860
- class Role < Struct.new(
1861
- :arn,
1862
- :name)
2729
+ SENSITIVE = []
1863
2730
  include Aws::Structure
1864
2731
  end
1865
2732
 
@@ -1871,7 +2738,7 @@ module Aws::FraudDetector
1871
2738
  # {
1872
2739
  # detector_id: "identifier", # required
1873
2740
  # rule_id: "identifier", # required
1874
- # rule_version: "nonEmptyString", # required
2741
+ # rule_version: "wholeNumberVersionString", # required
1875
2742
  # }
1876
2743
  #
1877
2744
  # @!attribute [rw] detector_id
@@ -1892,6 +2759,7 @@ module Aws::FraudDetector
1892
2759
  :detector_id,
1893
2760
  :rule_id,
1894
2761
  :rule_version)
2762
+ SENSITIVE = []
1895
2763
  include Aws::Structure
1896
2764
  end
1897
2765
 
@@ -1933,6 +2801,10 @@ module Aws::FraudDetector
1933
2801
  # The timestamp of when the rule was created.
1934
2802
  # @return [String]
1935
2803
  #
2804
+ # @!attribute [rw] arn
2805
+ # The rule ARN.
2806
+ # @return [String]
2807
+ #
1936
2808
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/RuleDetail AWS API Documentation
1937
2809
  #
1938
2810
  class RuleDetail < Struct.new(
@@ -1944,7 +2816,9 @@ module Aws::FraudDetector
1944
2816
  :language,
1945
2817
  :outcomes,
1946
2818
  :last_updated_time,
1947
- :created_time)
2819
+ :created_time,
2820
+ :arn)
2821
+ SENSITIVE = [:expression]
1948
2822
  include Aws::Structure
1949
2823
  end
1950
2824
 
@@ -1963,9 +2837,71 @@ module Aws::FraudDetector
1963
2837
  class RuleResult < Struct.new(
1964
2838
  :rule_id,
1965
2839
  :outcomes)
2840
+ SENSITIVE = []
2841
+ include Aws::Structure
2842
+ end
2843
+
2844
+ # A key and value pair.
2845
+ #
2846
+ # @note When making an API call, you may pass Tag
2847
+ # data as a hash:
2848
+ #
2849
+ # {
2850
+ # key: "tagKey", # required
2851
+ # value: "tagValue", # required
2852
+ # }
2853
+ #
2854
+ # @!attribute [rw] key
2855
+ # A tag key.
2856
+ # @return [String]
2857
+ #
2858
+ # @!attribute [rw] value
2859
+ # A value assigned to a tag key.
2860
+ # @return [String]
2861
+ #
2862
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Tag AWS API Documentation
2863
+ #
2864
+ class Tag < Struct.new(
2865
+ :key,
2866
+ :value)
2867
+ SENSITIVE = []
2868
+ include Aws::Structure
2869
+ end
2870
+
2871
+ # @note When making an API call, you may pass TagResourceRequest
2872
+ # data as a hash:
2873
+ #
2874
+ # {
2875
+ # resource_arn: "fraudDetectorArn", # required
2876
+ # tags: [ # required
2877
+ # {
2878
+ # key: "tagKey", # required
2879
+ # value: "tagValue", # required
2880
+ # },
2881
+ # ],
2882
+ # }
2883
+ #
2884
+ # @!attribute [rw] resource_arn
2885
+ # The resource ARN.
2886
+ # @return [String]
2887
+ #
2888
+ # @!attribute [rw] tags
2889
+ # The tags to assign to the resource.
2890
+ # @return [Array<Types::Tag>]
2891
+ #
2892
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/TagResourceRequest AWS API Documentation
2893
+ #
2894
+ class TagResourceRequest < Struct.new(
2895
+ :resource_arn,
2896
+ :tags)
2897
+ SENSITIVE = []
1966
2898
  include Aws::Structure
1967
2899
  end
1968
2900
 
2901
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/TagResourceResult AWS API Documentation
2902
+ #
2903
+ class TagResourceResult < Aws::EmptyStructure; end
2904
+
1969
2905
  # An exception indicating a throttling error.
1970
2906
  #
1971
2907
  # @!attribute [rw] message
@@ -1975,41 +2911,117 @@ module Aws::FraudDetector
1975
2911
  #
1976
2912
  class ThrottlingException < Struct.new(
1977
2913
  :message)
2914
+ SENSITIVE = []
1978
2915
  include Aws::Structure
1979
2916
  end
1980
2917
 
1981
- # The training data source.
2918
+ # The training data schema.
1982
2919
  #
1983
- # @note When making an API call, you may pass TrainingDataSource
2920
+ # @note When making an API call, you may pass TrainingDataSchema
1984
2921
  # data as a hash:
1985
2922
  #
1986
2923
  # {
1987
- # data_location: "s3BucketLocation", # required
1988
- # data_access_role_arn: "iamRoleArn", # required
2924
+ # model_variables: ["string"], # required
2925
+ # label_schema: { # required
2926
+ # label_mapper: { # required
2927
+ # "string" => ["string"],
2928
+ # },
2929
+ # },
1989
2930
  # }
1990
2931
  #
1991
- # @!attribute [rw] data_location
1992
- # The data location of the training data source.
1993
- # @return [String]
2932
+ # @!attribute [rw] model_variables
2933
+ # The training data schema variables.
2934
+ # @return [Array<String>]
1994
2935
  #
1995
- # @!attribute [rw] data_access_role_arn
1996
- # The data access role ARN for the training data source.
2936
+ # @!attribute [rw] label_schema
2937
+ # The label schema.
2938
+ # @return [Types::LabelSchema]
2939
+ #
2940
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/TrainingDataSchema AWS API Documentation
2941
+ #
2942
+ class TrainingDataSchema < Struct.new(
2943
+ :model_variables,
2944
+ :label_schema)
2945
+ SENSITIVE = []
2946
+ include Aws::Structure
2947
+ end
2948
+
2949
+ # The training metric details.
2950
+ #
2951
+ # @!attribute [rw] auc
2952
+ # The area under the curve. This summarizes true positive rate (TPR)
2953
+ # and false positive rate (FPR) across all possible model score
2954
+ # thresholds. A model with no predictive power has an AUC of 0.5,
2955
+ # whereas a perfect model has a score of 1.0.
2956
+ # @return [Float]
2957
+ #
2958
+ # @!attribute [rw] metric_data_points
2959
+ # The data points details.
2960
+ # @return [Array<Types::MetricDataPoint>]
2961
+ #
2962
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/TrainingMetrics AWS API Documentation
2963
+ #
2964
+ class TrainingMetrics < Struct.new(
2965
+ :auc,
2966
+ :metric_data_points)
2967
+ SENSITIVE = []
2968
+ include Aws::Structure
2969
+ end
2970
+
2971
+ # The training result details.
2972
+ #
2973
+ # @!attribute [rw] data_validation_metrics
2974
+ # The validation metrics.
2975
+ # @return [Types::DataValidationMetrics]
2976
+ #
2977
+ # @!attribute [rw] training_metrics
2978
+ # The training metric details.
2979
+ # @return [Types::TrainingMetrics]
2980
+ #
2981
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/TrainingResult AWS API Documentation
2982
+ #
2983
+ class TrainingResult < Struct.new(
2984
+ :data_validation_metrics,
2985
+ :training_metrics)
2986
+ SENSITIVE = []
2987
+ include Aws::Structure
2988
+ end
2989
+
2990
+ # @note When making an API call, you may pass UntagResourceRequest
2991
+ # data as a hash:
2992
+ #
2993
+ # {
2994
+ # resource_arn: "fraudDetectorArn", # required
2995
+ # tag_keys: ["tagKey"], # required
2996
+ # }
2997
+ #
2998
+ # @!attribute [rw] resource_arn
2999
+ # The ARN of the resource from which to remove the tag.
1997
3000
  # @return [String]
1998
3001
  #
1999
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/TrainingDataSource AWS API Documentation
3002
+ # @!attribute [rw] tag_keys
3003
+ # The resource ARN.
3004
+ # @return [Array<String>]
2000
3005
  #
2001
- class TrainingDataSource < Struct.new(
2002
- :data_location,
2003
- :data_access_role_arn)
3006
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UntagResourceRequest AWS API Documentation
3007
+ #
3008
+ class UntagResourceRequest < Struct.new(
3009
+ :resource_arn,
3010
+ :tag_keys)
3011
+ SENSITIVE = []
2004
3012
  include Aws::Structure
2005
3013
  end
2006
3014
 
3015
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UntagResourceResult AWS API Documentation
3016
+ #
3017
+ class UntagResourceResult < Aws::EmptyStructure; end
3018
+
2007
3019
  # @note When making an API call, you may pass UpdateDetectorVersionMetadataRequest
2008
3020
  # data as a hash:
2009
3021
  #
2010
3022
  # {
2011
3023
  # detector_id: "identifier", # required
2012
- # detector_version_id: "nonEmptyString", # required
3024
+ # detector_version_id: "wholeNumberVersionString", # required
2013
3025
  # description: "description", # required
2014
3026
  # }
2015
3027
  #
@@ -2031,6 +3043,7 @@ module Aws::FraudDetector
2031
3043
  :detector_id,
2032
3044
  :detector_version_id,
2033
3045
  :description)
3046
+ SENSITIVE = []
2034
3047
  include Aws::Structure
2035
3048
  end
2036
3049
 
@@ -2043,13 +3056,13 @@ module Aws::FraudDetector
2043
3056
  #
2044
3057
  # {
2045
3058
  # detector_id: "identifier", # required
2046
- # detector_version_id: "nonEmptyString", # required
3059
+ # detector_version_id: "wholeNumberVersionString", # required
2047
3060
  # external_model_endpoints: ["string"], # required
2048
3061
  # rules: [ # required
2049
3062
  # {
2050
3063
  # detector_id: "identifier", # required
2051
3064
  # rule_id: "identifier", # required
2052
- # rule_version: "nonEmptyString", # required
3065
+ # rule_version: "wholeNumberVersionString", # required
2053
3066
  # },
2054
3067
  # ],
2055
3068
  # description: "description",
@@ -2058,6 +3071,7 @@ module Aws::FraudDetector
2058
3071
  # model_id: "identifier", # required
2059
3072
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
2060
3073
  # model_version_number: "nonEmptyString", # required
3074
+ # arn: "fraudDetectorArn",
2061
3075
  # },
2062
3076
  # ],
2063
3077
  # rule_execution_mode: "ALL_MATCHED", # accepts ALL_MATCHED, FIRST_MATCHED
@@ -2114,6 +3128,7 @@ module Aws::FraudDetector
2114
3128
  :description,
2115
3129
  :model_versions,
2116
3130
  :rule_execution_mode)
3131
+ SENSITIVE = []
2117
3132
  include Aws::Structure
2118
3133
  end
2119
3134
 
@@ -2126,7 +3141,7 @@ module Aws::FraudDetector
2126
3141
  #
2127
3142
  # {
2128
3143
  # detector_id: "identifier", # required
2129
- # detector_version_id: "nonEmptyString", # required
3144
+ # detector_version_id: "wholeNumberVersionString", # required
2130
3145
  # status: "DRAFT", # required, accepts DRAFT, ACTIVE, INACTIVE
2131
3146
  # }
2132
3147
  #
@@ -2148,6 +3163,7 @@ module Aws::FraudDetector
2148
3163
  :detector_id,
2149
3164
  :detector_version_id,
2150
3165
  :status)
3166
+ SENSITIVE = []
2151
3167
  include Aws::Structure
2152
3168
  end
2153
3169
 
@@ -2155,17 +3171,92 @@ module Aws::FraudDetector
2155
3171
  #
2156
3172
  class UpdateDetectorVersionStatusResult < Aws::EmptyStructure; end
2157
3173
 
3174
+ # @note When making an API call, you may pass UpdateModelRequest
3175
+ # data as a hash:
3176
+ #
3177
+ # {
3178
+ # model_id: "identifier", # required
3179
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
3180
+ # description: "description",
3181
+ # }
3182
+ #
3183
+ # @!attribute [rw] model_id
3184
+ # The model ID.
3185
+ # @return [String]
3186
+ #
3187
+ # @!attribute [rw] model_type
3188
+ # The model type.
3189
+ # @return [String]
3190
+ #
3191
+ # @!attribute [rw] description
3192
+ # The new model description.
3193
+ # @return [String]
3194
+ #
3195
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelRequest AWS API Documentation
3196
+ #
3197
+ class UpdateModelRequest < Struct.new(
3198
+ :model_id,
3199
+ :model_type,
3200
+ :description)
3201
+ SENSITIVE = []
3202
+ include Aws::Structure
3203
+ end
3204
+
3205
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelResult AWS API Documentation
3206
+ #
3207
+ class UpdateModelResult < Aws::EmptyStructure; end
3208
+
2158
3209
  # @note When making an API call, you may pass UpdateModelVersionRequest
2159
3210
  # data as a hash:
2160
3211
  #
2161
3212
  # {
2162
3213
  # model_id: "identifier", # required
2163
3214
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
2164
- # model_version_number: "nonEmptyString", # required
2165
- # description: "description", # required
2166
- # status: "TRAINING_IN_PROGRESS", # required, accepts TRAINING_IN_PROGRESS, TRAINING_COMPLETE, ACTIVATE_REQUESTED, ACTIVATE_IN_PROGRESS, ACTIVE, INACTIVATE_IN_PROGRESS, INACTIVE, ERROR
3215
+ # major_version_number: "wholeNumberVersionString", # required
3216
+ # external_events_detail: {
3217
+ # data_location: "s3BucketLocation", # required
3218
+ # data_access_role_arn: "iamRoleArn", # required
3219
+ # },
3220
+ # tags: [
3221
+ # {
3222
+ # key: "tagKey", # required
3223
+ # value: "tagValue", # required
3224
+ # },
3225
+ # ],
2167
3226
  # }
2168
3227
  #
3228
+ # @!attribute [rw] model_id
3229
+ # The model ID.
3230
+ # @return [String]
3231
+ #
3232
+ # @!attribute [rw] model_type
3233
+ # The model type.
3234
+ # @return [String]
3235
+ #
3236
+ # @!attribute [rw] major_version_number
3237
+ # The major version number.
3238
+ # @return [String]
3239
+ #
3240
+ # @!attribute [rw] external_events_detail
3241
+ # The event details.
3242
+ # @return [Types::ExternalEventsDetail]
3243
+ #
3244
+ # @!attribute [rw] tags
3245
+ # A collection of key and value pairs.
3246
+ # @return [Array<Types::Tag>]
3247
+ #
3248
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelVersionRequest AWS API Documentation
3249
+ #
3250
+ class UpdateModelVersionRequest < Struct.new(
3251
+ :model_id,
3252
+ :model_type,
3253
+ :major_version_number,
3254
+ :external_events_detail,
3255
+ :tags)
3256
+ SENSITIVE = []
3257
+ include Aws::Structure
3258
+ end
3259
+
2169
3260
  # @!attribute [rw] model_id
2170
3261
  # The model ID.
2171
3262
  # @return [String]
@@ -2175,31 +3266,64 @@ module Aws::FraudDetector
2175
3266
  # @return [String]
2176
3267
  #
2177
3268
  # @!attribute [rw] model_version_number
2178
- # The model version.
3269
+ # The model version number of the model version updated.
2179
3270
  # @return [String]
2180
3271
  #
2181
- # @!attribute [rw] description
2182
- # The model description.
3272
+ # @!attribute [rw] status
3273
+ # The status of the updated model version.
3274
+ # @return [String]
3275
+ #
3276
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelVersionResult AWS API Documentation
3277
+ #
3278
+ class UpdateModelVersionResult < Struct.new(
3279
+ :model_id,
3280
+ :model_type,
3281
+ :model_version_number,
3282
+ :status)
3283
+ SENSITIVE = []
3284
+ include Aws::Structure
3285
+ end
3286
+
3287
+ # @note When making an API call, you may pass UpdateModelVersionStatusRequest
3288
+ # data as a hash:
3289
+ #
3290
+ # {
3291
+ # model_id: "identifier", # required
3292
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
3293
+ # model_version_number: "floatVersionString", # required
3294
+ # status: "ACTIVE", # required, accepts ACTIVE, INACTIVE
3295
+ # }
3296
+ #
3297
+ # @!attribute [rw] model_id
3298
+ # The model ID of the model version to update.
3299
+ # @return [String]
3300
+ #
3301
+ # @!attribute [rw] model_type
3302
+ # The model type.
3303
+ # @return [String]
3304
+ #
3305
+ # @!attribute [rw] model_version_number
3306
+ # The model version number.
2183
3307
  # @return [String]
2184
3308
  #
2185
3309
  # @!attribute [rw] status
2186
- # The new model status.
3310
+ # The model version status.
2187
3311
  # @return [String]
2188
3312
  #
2189
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelVersionRequest AWS API Documentation
3313
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelVersionStatusRequest AWS API Documentation
2190
3314
  #
2191
- class UpdateModelVersionRequest < Struct.new(
3315
+ class UpdateModelVersionStatusRequest < Struct.new(
2192
3316
  :model_id,
2193
3317
  :model_type,
2194
3318
  :model_version_number,
2195
- :description,
2196
3319
  :status)
3320
+ SENSITIVE = []
2197
3321
  include Aws::Structure
2198
3322
  end
2199
3323
 
2200
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelVersionResult AWS API Documentation
3324
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelVersionStatusResult AWS API Documentation
2201
3325
  #
2202
- class UpdateModelVersionResult < Aws::EmptyStructure; end
3326
+ class UpdateModelVersionStatusResult < Aws::EmptyStructure; end
2203
3327
 
2204
3328
  # @note When making an API call, you may pass UpdateRuleMetadataRequest
2205
3329
  # data as a hash:
@@ -2208,7 +3332,7 @@ module Aws::FraudDetector
2208
3332
  # rule: { # required
2209
3333
  # detector_id: "identifier", # required
2210
3334
  # rule_id: "identifier", # required
2211
- # rule_version: "nonEmptyString", # required
3335
+ # rule_version: "wholeNumberVersionString", # required
2212
3336
  # },
2213
3337
  # description: "description", # required
2214
3338
  # }
@@ -2226,6 +3350,7 @@ module Aws::FraudDetector
2226
3350
  class UpdateRuleMetadataRequest < Struct.new(
2227
3351
  :rule,
2228
3352
  :description)
3353
+ SENSITIVE = []
2229
3354
  include Aws::Structure
2230
3355
  end
2231
3356
 
@@ -2240,12 +3365,18 @@ module Aws::FraudDetector
2240
3365
  # rule: { # required
2241
3366
  # detector_id: "identifier", # required
2242
3367
  # rule_id: "identifier", # required
2243
- # rule_version: "nonEmptyString", # required
3368
+ # rule_version: "wholeNumberVersionString", # required
2244
3369
  # },
2245
3370
  # description: "description",
2246
3371
  # expression: "ruleExpression", # required
2247
3372
  # language: "DETECTORPL", # required, accepts DETECTORPL
2248
3373
  # outcomes: ["string"], # required
3374
+ # tags: [
3375
+ # {
3376
+ # key: "tagKey", # required
3377
+ # value: "tagValue", # required
3378
+ # },
3379
+ # ],
2249
3380
  # }
2250
3381
  #
2251
3382
  # @!attribute [rw] rule
@@ -2268,6 +3399,10 @@ module Aws::FraudDetector
2268
3399
  # The outcomes.
2269
3400
  # @return [Array<String>]
2270
3401
  #
3402
+ # @!attribute [rw] tags
3403
+ # The tags to assign to the rule version.
3404
+ # @return [Array<Types::Tag>]
3405
+ #
2271
3406
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateRuleVersionRequest AWS API Documentation
2272
3407
  #
2273
3408
  class UpdateRuleVersionRequest < Struct.new(
@@ -2275,7 +3410,9 @@ module Aws::FraudDetector
2275
3410
  :description,
2276
3411
  :expression,
2277
3412
  :language,
2278
- :outcomes)
3413
+ :outcomes,
3414
+ :tags)
3415
+ SENSITIVE = [:expression]
2279
3416
  include Aws::Structure
2280
3417
  end
2281
3418
 
@@ -2287,6 +3424,7 @@ module Aws::FraudDetector
2287
3424
  #
2288
3425
  class UpdateRuleVersionResult < Struct.new(
2289
3426
  :rule)
3427
+ SENSITIVE = []
2290
3428
  include Aws::Structure
2291
3429
  end
2292
3430
 
@@ -2313,7 +3451,11 @@ module Aws::FraudDetector
2313
3451
  # @return [String]
2314
3452
  #
2315
3453
  # @!attribute [rw] variable_type
2316
- # The variable type.
3454
+ # The variable type. For more information see [Variable types][1].
3455
+ #
3456
+ #
3457
+ #
3458
+ # [1]: https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types
2317
3459
  # @return [String]
2318
3460
  #
2319
3461
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateVariableRequest AWS API Documentation
@@ -2323,6 +3465,7 @@ module Aws::FraudDetector
2323
3465
  :default_value,
2324
3466
  :description,
2325
3467
  :variable_type)
3468
+ SENSITIVE = []
2326
3469
  include Aws::Structure
2327
3470
  end
2328
3471
 
@@ -2339,6 +3482,7 @@ module Aws::FraudDetector
2339
3482
  #
2340
3483
  class ValidationException < Struct.new(
2341
3484
  :message)
3485
+ SENSITIVE = []
2342
3486
  include Aws::Structure
2343
3487
  end
2344
3488
 
@@ -2349,7 +3493,12 @@ module Aws::FraudDetector
2349
3493
  # @return [String]
2350
3494
  #
2351
3495
  # @!attribute [rw] data_type
2352
- # The data type of the variable.
3496
+ # The data type of the variable. For more information see [Variable
3497
+ # types][1].
3498
+ #
3499
+ #
3500
+ #
3501
+ # [1]: https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types
2353
3502
  # @return [String]
2354
3503
  #
2355
3504
  # @!attribute [rw] data_source
@@ -2366,6 +3515,16 @@ module Aws::FraudDetector
2366
3515
  #
2367
3516
  # @!attribute [rw] variable_type
2368
3517
  # The variable type of the variable.
3518
+ #
3519
+ # Valid Values: `AUTH_CODE | AVS | BILLING_ADDRESS_L1 |
3520
+ # BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME |
3521
+ # BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL
3522
+ # | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL |
3523
+ # FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE |
3524
+ # PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 |
3525
+ # SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY |
3526
+ # SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP |
3527
+ # USERAGENT | SHIPPING_ZIP | USERAGENT`
2369
3528
  # @return [String]
2370
3529
  #
2371
3530
  # @!attribute [rw] last_updated_time
@@ -2376,6 +3535,10 @@ module Aws::FraudDetector
2376
3535
  # The time when the variable was created.
2377
3536
  # @return [String]
2378
3537
  #
3538
+ # @!attribute [rw] arn
3539
+ # The ARN of the variable.
3540
+ # @return [String]
3541
+ #
2379
3542
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Variable AWS API Documentation
2380
3543
  #
2381
3544
  class Variable < Struct.new(
@@ -2386,11 +3549,14 @@ module Aws::FraudDetector
2386
3549
  :description,
2387
3550
  :variable_type,
2388
3551
  :last_updated_time,
2389
- :created_time)
3552
+ :created_time,
3553
+ :arn)
3554
+ SENSITIVE = []
2390
3555
  include Aws::Structure
2391
3556
  end
2392
3557
 
2393
- # The variable entry in a list.
3558
+ # A variable in the list of variables for the batch create variable
3559
+ # request.
2394
3560
  #
2395
3561
  # @note When making an API call, you may pass VariableEntry
2396
3562
  # data as a hash:
@@ -2405,27 +3571,42 @@ module Aws::FraudDetector
2405
3571
  # }
2406
3572
  #
2407
3573
  # @!attribute [rw] name
2408
- # The name of the variable entry.
3574
+ # The name of the variable.
2409
3575
  # @return [String]
2410
3576
  #
2411
3577
  # @!attribute [rw] data_type
2412
- # The data type of the variable entry.
3578
+ # The data type of the variable.
2413
3579
  # @return [String]
2414
3580
  #
2415
3581
  # @!attribute [rw] data_source
2416
- # The data source of the variable entry.
3582
+ # The data source of the variable.
2417
3583
  # @return [String]
2418
3584
  #
2419
3585
  # @!attribute [rw] default_value
2420
- # The default value of the variable entry.
3586
+ # The default value of the variable.
2421
3587
  # @return [String]
2422
3588
  #
2423
3589
  # @!attribute [rw] description
2424
- # The description of the variable entry.
3590
+ # The description of the variable.
2425
3591
  # @return [String]
2426
3592
  #
2427
3593
  # @!attribute [rw] variable_type
2428
- # The type of the variable entry.
3594
+ # The type of the variable. For more information see [Variable
3595
+ # types][1].
3596
+ #
3597
+ # Valid Values: `AUTH_CODE | AVS | BILLING_ADDRESS_L1 |
3598
+ # BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME |
3599
+ # BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL
3600
+ # | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL |
3601
+ # FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE |
3602
+ # PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 |
3603
+ # SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY |
3604
+ # SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP |
3605
+ # USERAGENT | SHIPPING_ZIP | USERAGENT`
3606
+ #
3607
+ #
3608
+ #
3609
+ # [1]: https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types
2429
3610
  # @return [String]
2430
3611
  #
2431
3612
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/VariableEntry AWS API Documentation
@@ -2437,6 +3618,7 @@ module Aws::FraudDetector
2437
3618
  :default_value,
2438
3619
  :description,
2439
3620
  :variable_type)
3621
+ SENSITIVE = []
2440
3622
  include Aws::Structure
2441
3623
  end
2442
3624