aws-sdk-frauddetector 1.5.1 → 1.10.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,17 +196,24 @@ 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: [
169
203
  # {
170
- # model_id: "identifier", # required
204
+ # model_id: "modelIdentifier", # 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
- # model_id: "identifier", # required
302
+ # model_id: "modelIdentifier", # 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: "modelIdentifier", # 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
 
@@ -575,8 +778,8 @@ module Aws::FraudDetector
575
778
  # data as a hash:
576
779
  #
577
780
  # {
578
- # model_id: "identifier",
579
- # model_version_number: "nonEmptyString",
781
+ # model_id: "modelIdentifier",
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", # required
912
+ # entity_id: "identifier", # required
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
 
@@ -695,9 +1051,9 @@ module Aws::FraudDetector
695
1051
  # The source of the model.
696
1052
  # @return [String]
697
1053
  #
698
- # @!attribute [rw] role
1054
+ # @!attribute [rw] invoke_model_endpoint_role_arn
699
1055
  # The role used to invoke the model.
700
- # @return [Types::Role]
1056
+ # @return [String]
701
1057
  #
702
1058
  # @!attribute [rw] input_configuration
703
1059
  # The input configuration.
@@ -719,17 +1075,81 @@ module Aws::FraudDetector
719
1075
  # Timestamp of when the model was last created.
720
1076
  # @return [String]
721
1077
  #
1078
+ # @!attribute [rw] arn
1079
+ # The model ARN.
1080
+ # @return [String]
1081
+ #
722
1082
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ExternalModel AWS API Documentation
723
1083
  #
724
1084
  class ExternalModel < Struct.new(
725
1085
  :model_endpoint,
726
1086
  :model_source,
727
- :role,
1087
+ :invoke_model_endpoint_role_arn,
728
1088
  :input_configuration,
729
1089
  :output_configuration,
730
1090
  :model_endpoint_status,
731
1091
  :last_updated_time,
732
- :created_time)
1092
+ :created_time,
1093
+ :arn)
1094
+ SENSITIVE = []
1095
+ include Aws::Structure
1096
+ end
1097
+
1098
+ # The message details.
1099
+ #
1100
+ # @!attribute [rw] field_name
1101
+ # The field name.
1102
+ # @return [String]
1103
+ #
1104
+ # @!attribute [rw] identifier
1105
+ # The message ID.
1106
+ # @return [String]
1107
+ #
1108
+ # @!attribute [rw] title
1109
+ # The message title.
1110
+ # @return [String]
1111
+ #
1112
+ # @!attribute [rw] content
1113
+ # The message content.
1114
+ # @return [String]
1115
+ #
1116
+ # @!attribute [rw] type
1117
+ # The message type.
1118
+ # @return [String]
1119
+ #
1120
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/FieldValidationMessage AWS API Documentation
1121
+ #
1122
+ class FieldValidationMessage < Struct.new(
1123
+ :field_name,
1124
+ :identifier,
1125
+ :title,
1126
+ :content,
1127
+ :type)
1128
+ SENSITIVE = []
1129
+ include Aws::Structure
1130
+ end
1131
+
1132
+ # The message details.
1133
+ #
1134
+ # @!attribute [rw] title
1135
+ # The message title.
1136
+ # @return [String]
1137
+ #
1138
+ # @!attribute [rw] content
1139
+ # The message content.
1140
+ # @return [String]
1141
+ #
1142
+ # @!attribute [rw] type
1143
+ # The message type.
1144
+ # @return [String]
1145
+ #
1146
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/FileValidationMessage AWS API Documentation
1147
+ #
1148
+ class FileValidationMessage < Struct.new(
1149
+ :title,
1150
+ :content,
1151
+ :type)
1152
+ SENSITIVE = []
733
1153
  include Aws::Structure
734
1154
  end
735
1155
 
@@ -738,7 +1158,7 @@ module Aws::FraudDetector
738
1158
  #
739
1159
  # {
740
1160
  # detector_id: "identifier", # required
741
- # detector_version_id: "nonEmptyString", # required
1161
+ # detector_version_id: "wholeNumberVersionString", # required
742
1162
  # }
743
1163
  #
744
1164
  # @!attribute [rw] detector_id
@@ -754,6 +1174,7 @@ module Aws::FraudDetector
754
1174
  class GetDetectorVersionRequest < Struct.new(
755
1175
  :detector_id,
756
1176
  :detector_version_id)
1177
+ SENSITIVE = []
757
1178
  include Aws::Structure
758
1179
  end
759
1180
 
@@ -808,6 +1229,10 @@ module Aws::FraudDetector
808
1229
  # draft status.
809
1230
  # @return [String]
810
1231
  #
1232
+ # @!attribute [rw] arn
1233
+ # The detector version ARN.
1234
+ # @return [String]
1235
+ #
811
1236
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetDetectorVersionResult AWS API Documentation
812
1237
  #
813
1238
  class GetDetectorVersionResult < Struct.new(
@@ -820,7 +1245,9 @@ module Aws::FraudDetector
820
1245
  :status,
821
1246
  :last_updated_time,
822
1247
  :created_time,
823
- :rule_execution_mode)
1248
+ :rule_execution_mode,
1249
+ :arn)
1250
+ SENSITIVE = []
824
1251
  include Aws::Structure
825
1252
  end
826
1253
 
@@ -851,6 +1278,7 @@ module Aws::FraudDetector
851
1278
  :detector_id,
852
1279
  :next_token,
853
1280
  :max_results)
1281
+ SENSITIVE = []
854
1282
  include Aws::Structure
855
1283
  end
856
1284
 
@@ -867,20 +1295,217 @@ module Aws::FraudDetector
867
1295
  class GetDetectorsResult < Struct.new(
868
1296
  :detectors,
869
1297
  :next_token)
1298
+ SENSITIVE = []
870
1299
  include Aws::Structure
871
1300
  end
872
1301
 
873
- # @note When making an API call, you may pass GetExternalModelsRequest
1302
+ # @note When making an API call, you may pass GetEntityTypesRequest
874
1303
  # data as a hash:
875
1304
  #
876
1305
  # {
877
- # model_endpoint: "string",
1306
+ # name: "identifier",
878
1307
  # next_token: "string",
879
1308
  # max_results: 1,
880
1309
  # }
881
1310
  #
882
- # @!attribute [rw] model_endpoint
883
- # The Amazon SageMaker model endpoint.
1311
+ # @!attribute [rw] name
1312
+ # The name.
1313
+ # @return [String]
1314
+ #
1315
+ # @!attribute [rw] next_token
1316
+ # The next token for the subsequent request.
1317
+ # @return [String]
1318
+ #
1319
+ # @!attribute [rw] max_results
1320
+ # The maximum number of objects to return for the request.
1321
+ # @return [Integer]
1322
+ #
1323
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEntityTypesRequest AWS API Documentation
1324
+ #
1325
+ class GetEntityTypesRequest < Struct.new(
1326
+ :name,
1327
+ :next_token,
1328
+ :max_results)
1329
+ SENSITIVE = []
1330
+ include Aws::Structure
1331
+ end
1332
+
1333
+ # @!attribute [rw] entity_types
1334
+ # An array of entity types.
1335
+ # @return [Array<Types::EntityType>]
1336
+ #
1337
+ # @!attribute [rw] next_token
1338
+ # The next page token.
1339
+ # @return [String]
1340
+ #
1341
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEntityTypesResult AWS API Documentation
1342
+ #
1343
+ class GetEntityTypesResult < Struct.new(
1344
+ :entity_types,
1345
+ :next_token)
1346
+ SENSITIVE = []
1347
+ include Aws::Structure
1348
+ end
1349
+
1350
+ # @note When making an API call, you may pass GetEventPredictionRequest
1351
+ # data as a hash:
1352
+ #
1353
+ # {
1354
+ # detector_id: "string", # required
1355
+ # detector_version_id: "wholeNumberVersionString",
1356
+ # event_id: "string", # required
1357
+ # event_type_name: "string", # required
1358
+ # entities: [ # required
1359
+ # {
1360
+ # entity_type: "string", # required
1361
+ # entity_id: "identifier", # required
1362
+ # },
1363
+ # ],
1364
+ # event_timestamp: "string", # required
1365
+ # event_variables: { # required
1366
+ # "variableName" => "variableValue",
1367
+ # },
1368
+ # external_model_endpoint_data_blobs: {
1369
+ # "string" => {
1370
+ # byte_buffer: "data",
1371
+ # content_type: "contentType",
1372
+ # },
1373
+ # },
1374
+ # }
1375
+ #
1376
+ # @!attribute [rw] detector_id
1377
+ # The detector ID.
1378
+ # @return [String]
1379
+ #
1380
+ # @!attribute [rw] detector_version_id
1381
+ # The detector version ID.
1382
+ # @return [String]
1383
+ #
1384
+ # @!attribute [rw] event_id
1385
+ # The unique ID used to identify the event.
1386
+ # @return [String]
1387
+ #
1388
+ # @!attribute [rw] event_type_name
1389
+ # The event type associated with the detector specified for the
1390
+ # prediction.
1391
+ # @return [String]
1392
+ #
1393
+ # @!attribute [rw] entities
1394
+ # The entity type (associated with the detector's event type) and
1395
+ # specific entity ID representing who performed the event. If an
1396
+ # entity id is not available, use "UNKNOWN."
1397
+ # @return [Array<Types::Entity>]
1398
+ #
1399
+ # @!attribute [rw] event_timestamp
1400
+ # Timestamp that defines when the event under evaluation occurred.
1401
+ # @return [String]
1402
+ #
1403
+ # @!attribute [rw] event_variables
1404
+ # Names of the event type's variables you defined in Amazon Fraud
1405
+ # Detector to represent data elements and their corresponding values
1406
+ # for the event you are sending for evaluation.
1407
+ # @return [Hash<String,String>]
1408
+ #
1409
+ # @!attribute [rw] external_model_endpoint_data_blobs
1410
+ # The Amazon SageMaker model endpoint input data blobs.
1411
+ # @return [Hash<String,Types::ModelEndpointDataBlob>]
1412
+ #
1413
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventPredictionRequest AWS API Documentation
1414
+ #
1415
+ class GetEventPredictionRequest < Struct.new(
1416
+ :detector_id,
1417
+ :detector_version_id,
1418
+ :event_id,
1419
+ :event_type_name,
1420
+ :entities,
1421
+ :event_timestamp,
1422
+ :event_variables,
1423
+ :external_model_endpoint_data_blobs)
1424
+ SENSITIVE = [:external_model_endpoint_data_blobs]
1425
+ include Aws::Structure
1426
+ end
1427
+
1428
+ # @!attribute [rw] model_scores
1429
+ # The model scores. Amazon Fraud Detector generates model scores
1430
+ # between 0 and 1000, where 0 is low fraud risk and 1000 is high fraud
1431
+ # risk. Model scores are directly related to the false positive rate
1432
+ # (FPR). For example, a score of 600 corresponds to an estimated 10%
1433
+ # false positive rate whereas a score of 900 corresponds to an
1434
+ # estimated 2% false positive rate.
1435
+ # @return [Array<Types::ModelScores>]
1436
+ #
1437
+ # @!attribute [rw] rule_results
1438
+ # The results.
1439
+ # @return [Array<Types::RuleResult>]
1440
+ #
1441
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventPredictionResult AWS API Documentation
1442
+ #
1443
+ class GetEventPredictionResult < Struct.new(
1444
+ :model_scores,
1445
+ :rule_results)
1446
+ SENSITIVE = []
1447
+ include Aws::Structure
1448
+ end
1449
+
1450
+ # @note When making an API call, you may pass GetEventTypesRequest
1451
+ # data as a hash:
1452
+ #
1453
+ # {
1454
+ # name: "identifier",
1455
+ # next_token: "string",
1456
+ # max_results: 1,
1457
+ # }
1458
+ #
1459
+ # @!attribute [rw] name
1460
+ # The name.
1461
+ # @return [String]
1462
+ #
1463
+ # @!attribute [rw] next_token
1464
+ # The next token for the subsequent request.
1465
+ # @return [String]
1466
+ #
1467
+ # @!attribute [rw] max_results
1468
+ # The maximum number of objects to return for the request.
1469
+ # @return [Integer]
1470
+ #
1471
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventTypesRequest AWS API Documentation
1472
+ #
1473
+ class GetEventTypesRequest < Struct.new(
1474
+ :name,
1475
+ :next_token,
1476
+ :max_results)
1477
+ SENSITIVE = []
1478
+ include Aws::Structure
1479
+ end
1480
+
1481
+ # @!attribute [rw] event_types
1482
+ # An array of event types.
1483
+ # @return [Array<Types::EventType>]
1484
+ #
1485
+ # @!attribute [rw] next_token
1486
+ # The next page token.
1487
+ # @return [String]
1488
+ #
1489
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventTypesResult AWS API Documentation
1490
+ #
1491
+ class GetEventTypesResult < Struct.new(
1492
+ :event_types,
1493
+ :next_token)
1494
+ SENSITIVE = []
1495
+ include Aws::Structure
1496
+ end
1497
+
1498
+ # @note When making an API call, you may pass GetExternalModelsRequest
1499
+ # data as a hash:
1500
+ #
1501
+ # {
1502
+ # model_endpoint: "string",
1503
+ # next_token: "string",
1504
+ # max_results: 1,
1505
+ # }
1506
+ #
1507
+ # @!attribute [rw] model_endpoint
1508
+ # The Amazon SageMaker model endpoint.
884
1509
  # @return [String]
885
1510
  #
886
1511
  # @!attribute [rw] next_token
@@ -897,6 +1522,7 @@ module Aws::FraudDetector
897
1522
  :model_endpoint,
898
1523
  :next_token,
899
1524
  :max_results)
1525
+ SENSITIVE = []
900
1526
  include Aws::Structure
901
1527
  end
902
1528
 
@@ -913,6 +1539,67 @@ module Aws::FraudDetector
913
1539
  class GetExternalModelsResult < Struct.new(
914
1540
  :external_models,
915
1541
  :next_token)
1542
+ SENSITIVE = []
1543
+ include Aws::Structure
1544
+ end
1545
+
1546
+ # @!attribute [rw] kms_key
1547
+ # The KMS encryption key.
1548
+ # @return [Types::KMSKey]
1549
+ #
1550
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetKMSEncryptionKeyResult AWS API Documentation
1551
+ #
1552
+ class GetKMSEncryptionKeyResult < Struct.new(
1553
+ :kms_key)
1554
+ SENSITIVE = []
1555
+ include Aws::Structure
1556
+ end
1557
+
1558
+ # @note When making an API call, you may pass GetLabelsRequest
1559
+ # data as a hash:
1560
+ #
1561
+ # {
1562
+ # name: "identifier",
1563
+ # next_token: "string",
1564
+ # max_results: 1,
1565
+ # }
1566
+ #
1567
+ # @!attribute [rw] name
1568
+ # The name of the label or labels to get.
1569
+ # @return [String]
1570
+ #
1571
+ # @!attribute [rw] next_token
1572
+ # The next token for the subsequent request.
1573
+ # @return [String]
1574
+ #
1575
+ # @!attribute [rw] max_results
1576
+ # The maximum number of objects to return for the request.
1577
+ # @return [Integer]
1578
+ #
1579
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetLabelsRequest AWS API Documentation
1580
+ #
1581
+ class GetLabelsRequest < Struct.new(
1582
+ :name,
1583
+ :next_token,
1584
+ :max_results)
1585
+ SENSITIVE = []
1586
+ include Aws::Structure
1587
+ end
1588
+
1589
+ # @!attribute [rw] labels
1590
+ # An array of labels.
1591
+ # @return [Array<Types::Label>]
1592
+ #
1593
+ # @!attribute [rw] next_token
1594
+ # The next page token.
1595
+ # @return [String]
1596
+ #
1597
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetLabelsResult AWS API Documentation
1598
+ #
1599
+ class GetLabelsResult < Struct.new(
1600
+ :labels,
1601
+ :next_token)
1602
+ SENSITIVE = []
916
1603
  include Aws::Structure
917
1604
  end
918
1605
 
@@ -920,9 +1607,9 @@ module Aws::FraudDetector
920
1607
  # data as a hash:
921
1608
  #
922
1609
  # {
923
- # model_id: "identifier", # required
1610
+ # model_id: "modelIdentifier", # required
924
1611
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
925
- # model_version_number: "nonEmptyString", # required
1612
+ # model_version_number: "floatVersionString", # required
926
1613
  # }
927
1614
  #
928
1615
  # @!attribute [rw] model_id
@@ -934,7 +1621,7 @@ module Aws::FraudDetector
934
1621
  # @return [String]
935
1622
  #
936
1623
  # @!attribute [rw] model_version_number
937
- # The model version.
1624
+ # The model version number.
938
1625
  # @return [String]
939
1626
  #
940
1627
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModelVersionRequest AWS API Documentation
@@ -943,6 +1630,7 @@ module Aws::FraudDetector
943
1630
  :model_id,
944
1631
  :model_type,
945
1632
  :model_version_number)
1633
+ SENSITIVE = []
946
1634
  include Aws::Structure
947
1635
  end
948
1636
 
@@ -955,25 +1643,41 @@ module Aws::FraudDetector
955
1643
  # @return [String]
956
1644
  #
957
1645
  # @!attribute [rw] model_version_number
958
- # The model version.
1646
+ # The model version number.
959
1647
  # @return [String]
960
1648
  #
961
- # @!attribute [rw] description
962
- # The model version description.
1649
+ # @!attribute [rw] training_data_source
1650
+ # The training data source.
963
1651
  # @return [String]
964
1652
  #
1653
+ # @!attribute [rw] training_data_schema
1654
+ # The training data schema.
1655
+ # @return [Types::TrainingDataSchema]
1656
+ #
1657
+ # @!attribute [rw] external_events_detail
1658
+ # The event details.
1659
+ # @return [Types::ExternalEventsDetail]
1660
+ #
965
1661
  # @!attribute [rw] status
966
1662
  # The model version status.
967
1663
  # @return [String]
968
1664
  #
1665
+ # @!attribute [rw] arn
1666
+ # The model version ARN.
1667
+ # @return [String]
1668
+ #
969
1669
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModelVersionResult AWS API Documentation
970
1670
  #
971
1671
  class GetModelVersionResult < Struct.new(
972
1672
  :model_id,
973
1673
  :model_type,
974
1674
  :model_version_number,
975
- :description,
976
- :status)
1675
+ :training_data_source,
1676
+ :training_data_schema,
1677
+ :external_events_detail,
1678
+ :status,
1679
+ :arn)
1680
+ SENSITIVE = []
977
1681
  include Aws::Structure
978
1682
  end
979
1683
 
@@ -981,44 +1685,45 @@ module Aws::FraudDetector
981
1685
  # data as a hash:
982
1686
  #
983
1687
  # {
1688
+ # model_id: "modelIdentifier",
984
1689
  # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
985
- # model_id: "identifier",
986
1690
  # next_token: "string",
987
1691
  # max_results: 1,
988
1692
  # }
989
1693
  #
990
- # @!attribute [rw] model_type
991
- # The model type.
992
- # @return [String]
993
- #
994
1694
  # @!attribute [rw] model_id
995
1695
  # The model ID.
996
1696
  # @return [String]
997
1697
  #
1698
+ # @!attribute [rw] model_type
1699
+ # The model type.
1700
+ # @return [String]
1701
+ #
998
1702
  # @!attribute [rw] next_token
999
- # The next token for the request.
1703
+ # The next token for the subsequent request.
1000
1704
  # @return [String]
1001
1705
  #
1002
1706
  # @!attribute [rw] max_results
1003
- # The maximum results to return for the request.
1707
+ # The maximum number of objects to return for the request.
1004
1708
  # @return [Integer]
1005
1709
  #
1006
1710
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModelsRequest AWS API Documentation
1007
1711
  #
1008
1712
  class GetModelsRequest < Struct.new(
1009
- :model_type,
1010
1713
  :model_id,
1714
+ :model_type,
1011
1715
  :next_token,
1012
1716
  :max_results)
1717
+ SENSITIVE = []
1013
1718
  include Aws::Structure
1014
1719
  end
1015
1720
 
1016
1721
  # @!attribute [rw] next_token
1017
- # The next token for subsequent requests.
1722
+ # The next page token to be used in subsequent requests.
1018
1723
  # @return [String]
1019
1724
  #
1020
1725
  # @!attribute [rw] models
1021
- # The returned models.
1726
+ # The array of models.
1022
1727
  # @return [Array<Types::Model>]
1023
1728
  #
1024
1729
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModelsResult AWS API Documentation
@@ -1026,6 +1731,7 @@ module Aws::FraudDetector
1026
1731
  class GetModelsResult < Struct.new(
1027
1732
  :next_token,
1028
1733
  :models)
1734
+ SENSITIVE = []
1029
1735
  include Aws::Structure
1030
1736
  end
1031
1737
 
@@ -1056,6 +1762,7 @@ module Aws::FraudDetector
1056
1762
  :name,
1057
1763
  :next_token,
1058
1764
  :max_results)
1765
+ SENSITIVE = []
1059
1766
  include Aws::Structure
1060
1767
  end
1061
1768
 
@@ -1072,78 +1779,7 @@ module Aws::FraudDetector
1072
1779
  class GetOutcomesResult < Struct.new(
1073
1780
  :outcomes,
1074
1781
  :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)
1782
+ SENSITIVE = []
1147
1783
  include Aws::Structure
1148
1784
  end
1149
1785
 
@@ -1153,7 +1789,7 @@ module Aws::FraudDetector
1153
1789
  # {
1154
1790
  # rule_id: "identifier",
1155
1791
  # detector_id: "identifier", # required
1156
- # rule_version: "nonEmptyString",
1792
+ # rule_version: "wholeNumberVersionString",
1157
1793
  # next_token: "string",
1158
1794
  # max_results: 1,
1159
1795
  # }
@@ -1186,6 +1822,7 @@ module Aws::FraudDetector
1186
1822
  :rule_version,
1187
1823
  :next_token,
1188
1824
  :max_results)
1825
+ SENSITIVE = []
1189
1826
  include Aws::Structure
1190
1827
  end
1191
1828
 
@@ -1202,6 +1839,7 @@ module Aws::FraudDetector
1202
1839
  class GetRulesResult < Struct.new(
1203
1840
  :rule_details,
1204
1841
  :next_token)
1842
+ SENSITIVE = []
1205
1843
  include Aws::Structure
1206
1844
  end
1207
1845
 
@@ -1232,6 +1870,7 @@ module Aws::FraudDetector
1232
1870
  :name,
1233
1871
  :next_token,
1234
1872
  :max_results)
1873
+ SENSITIVE = []
1235
1874
  include Aws::Structure
1236
1875
  end
1237
1876
 
@@ -1248,6 +1887,7 @@ module Aws::FraudDetector
1248
1887
  class GetVariablesResult < Struct.new(
1249
1888
  :variables,
1250
1889
  :next_token)
1890
+ SENSITIVE = []
1251
1891
  include Aws::Structure
1252
1892
  end
1253
1893
 
@@ -1260,6 +1900,55 @@ module Aws::FraudDetector
1260
1900
  #
1261
1901
  class InternalServerException < Struct.new(
1262
1902
  :message)
1903
+ SENSITIVE = []
1904
+ include Aws::Structure
1905
+ end
1906
+
1907
+ # The KMS key details.
1908
+ #
1909
+ # @!attribute [rw] kms_encryption_key_arn
1910
+ # The encryption key ARN.
1911
+ # @return [String]
1912
+ #
1913
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/KMSKey AWS API Documentation
1914
+ #
1915
+ class KMSKey < Struct.new(
1916
+ :kms_encryption_key_arn)
1917
+ SENSITIVE = []
1918
+ include Aws::Structure
1919
+ end
1920
+
1921
+ # The label details.
1922
+ #
1923
+ # @!attribute [rw] name
1924
+ # The label name.
1925
+ # @return [String]
1926
+ #
1927
+ # @!attribute [rw] description
1928
+ # The label description.
1929
+ # @return [String]
1930
+ #
1931
+ # @!attribute [rw] last_updated_time
1932
+ # Timestamp of when the label was last updated.
1933
+ # @return [String]
1934
+ #
1935
+ # @!attribute [rw] created_time
1936
+ # Timestamp of when the event type was created.
1937
+ # @return [String]
1938
+ #
1939
+ # @!attribute [rw] arn
1940
+ # The label ARN.
1941
+ # @return [String]
1942
+ #
1943
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Label AWS API Documentation
1944
+ #
1945
+ class Label < Struct.new(
1946
+ :name,
1947
+ :description,
1948
+ :last_updated_time,
1949
+ :created_time,
1950
+ :arn)
1951
+ SENSITIVE = []
1263
1952
  include Aws::Structure
1264
1953
  end
1265
1954
 
@@ -1269,32 +1958,110 @@ module Aws::FraudDetector
1269
1958
  # data as a hash:
1270
1959
  #
1271
1960
  # {
1272
- # label_key: "string", # required
1273
1961
  # label_mapper: { # required
1274
1962
  # "string" => ["string"],
1275
1963
  # },
1276
1964
  # }
1277
1965
  #
1278
- # @!attribute [rw] label_key
1279
- # The label key.
1280
- # @return [String]
1281
- #
1282
1966
  # @!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.
1967
+ # The label mapper maps the Amazon Fraud Detector supported model
1968
+ # classification labels (`FRAUD`, `LEGIT`) to the appropriate event
1969
+ # type labels. For example, if "`FRAUD`" and "`LEGIT`" are Amazon
1970
+ # Fraud Detector supported labels, this mapper could be: `\{"FRAUD" =>
1971
+ # ["0"]`, `"LEGIT" => ["1"]\}` or `\{"FRAUD" => ["false"]`, `"LEGIT"
1972
+ # => ["true"]\}` or `\{"FRAUD" => ["fraud", "abuse"]`, `"LEGIT" =>
1973
+ # ["legit", "safe"]\}`. The value part of the mapper is a list,
1974
+ # because you may have multiple label variants from your event type
1975
+ # for a single Amazon Fraud Detector label.
1291
1976
  # @return [Hash<String,Array<String>>]
1292
1977
  #
1293
1978
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/LabelSchema AWS API Documentation
1294
1979
  #
1295
1980
  class LabelSchema < Struct.new(
1296
- :label_key,
1297
1981
  :label_mapper)
1982
+ SENSITIVE = []
1983
+ include Aws::Structure
1984
+ end
1985
+
1986
+ # @note When making an API call, you may pass ListTagsForResourceRequest
1987
+ # data as a hash:
1988
+ #
1989
+ # {
1990
+ # resource_arn: "fraudDetectorArn", # required
1991
+ # next_token: "string",
1992
+ # max_results: 1,
1993
+ # }
1994
+ #
1995
+ # @!attribute [rw] resource_arn
1996
+ # The ARN that specifies the resource whose tags you want to list.
1997
+ # @return [String]
1998
+ #
1999
+ # @!attribute [rw] next_token
2000
+ # The next token from the previous results.
2001
+ # @return [String]
2002
+ #
2003
+ # @!attribute [rw] max_results
2004
+ # The maximum number of objects to return for the request.
2005
+ # @return [Integer]
2006
+ #
2007
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ListTagsForResourceRequest AWS API Documentation
2008
+ #
2009
+ class ListTagsForResourceRequest < Struct.new(
2010
+ :resource_arn,
2011
+ :next_token,
2012
+ :max_results)
2013
+ SENSITIVE = []
2014
+ include Aws::Structure
2015
+ end
2016
+
2017
+ # @!attribute [rw] tags
2018
+ # A collection of key and value pairs.
2019
+ # @return [Array<Types::Tag>]
2020
+ #
2021
+ # @!attribute [rw] next_token
2022
+ # The next token for subsequent requests.
2023
+ # @return [String]
2024
+ #
2025
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ListTagsForResourceResult AWS API Documentation
2026
+ #
2027
+ class ListTagsForResourceResult < Struct.new(
2028
+ :tags,
2029
+ :next_token)
2030
+ SENSITIVE = []
2031
+ include Aws::Structure
2032
+ end
2033
+
2034
+ # Model performance metrics data points.
2035
+ #
2036
+ # @!attribute [rw] fpr
2037
+ # The false positive rate. This is the percentage of total legitimate
2038
+ # events that are incorrectly predicted as fraud.
2039
+ # @return [Float]
2040
+ #
2041
+ # @!attribute [rw] precision
2042
+ # The percentage of fraud events correctly predicted as fraudulent as
2043
+ # compared to all events predicted as fraudulent.
2044
+ # @return [Float]
2045
+ #
2046
+ # @!attribute [rw] tpr
2047
+ # The true positive rate. This is the percentage of total fraud the
2048
+ # model detects. Also known as capture rate.
2049
+ # @return [Float]
2050
+ #
2051
+ # @!attribute [rw] threshold
2052
+ # The model threshold that specifies an acceptable fraud capture rate.
2053
+ # For example, a threshold of 500 means any model score 500 or above
2054
+ # is labeled as fraud.
2055
+ # @return [Float]
2056
+ #
2057
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/MetricDataPoint AWS API Documentation
2058
+ #
2059
+ class MetricDataPoint < Struct.new(
2060
+ :fpr,
2061
+ :precision,
2062
+ :tpr,
2063
+ :threshold)
2064
+ SENSITIVE = []
1298
2065
  include Aws::Structure
1299
2066
  end
1300
2067
 
@@ -1312,24 +2079,20 @@ module Aws::FraudDetector
1312
2079
  # The model description.
1313
2080
  # @return [String]
1314
2081
  #
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>]
2082
+ # @!attribute [rw] event_type_name
2083
+ # The name of the event type.
2084
+ # @return [String]
1322
2085
  #
1323
- # @!attribute [rw] label_schema
1324
- # The model label schema.
1325
- # @return [Types::LabelSchema]
2086
+ # @!attribute [rw] created_time
2087
+ # Timestamp of when the model was created.
2088
+ # @return [String]
1326
2089
  #
1327
2090
  # @!attribute [rw] last_updated_time
1328
2091
  # Timestamp of last time the model was updated.
1329
2092
  # @return [String]
1330
2093
  #
1331
- # @!attribute [rw] created_time
1332
- # Timestamp of when the model was created.
2094
+ # @!attribute [rw] arn
2095
+ # The ARN of the model.
1333
2096
  # @return [String]
1334
2097
  #
1335
2098
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Model AWS API Documentation
@@ -1338,11 +2101,11 @@ module Aws::FraudDetector
1338
2101
  :model_id,
1339
2102
  :model_type,
1340
2103
  :description,
1341
- :training_data_source,
1342
- :model_variables,
1343
- :label_schema,
2104
+ :event_type_name,
2105
+ :created_time,
1344
2106
  :last_updated_time,
1345
- :created_time)
2107
+ :arn)
2108
+ SENSITIVE = []
1346
2109
  include Aws::Structure
1347
2110
  end
1348
2111
 
@@ -1373,33 +2136,35 @@ module Aws::FraudDetector
1373
2136
  class ModelEndpointDataBlob < Struct.new(
1374
2137
  :byte_buffer,
1375
2138
  :content_type)
2139
+ SENSITIVE = []
1376
2140
  include Aws::Structure
1377
2141
  end
1378
2142
 
1379
- # The model input configuration.
2143
+ # The Amazon SageMaker model input configuration.
1380
2144
  #
1381
2145
  # @note When making an API call, you may pass ModelInputConfiguration
1382
2146
  # data as a hash:
1383
2147
  #
1384
2148
  # {
2149
+ # event_type_name: "identifier",
1385
2150
  # format: "TEXT_CSV", # accepts TEXT_CSV, APPLICATION_JSON
1386
- # is_opaque: false, # required
2151
+ # use_event_variables: false, # required
1387
2152
  # json_input_template: "string",
1388
2153
  # csv_input_template: "string",
1389
2154
  # }
1390
2155
  #
2156
+ # @!attribute [rw] event_type_name
2157
+ # The event type name.
2158
+ # @return [String]
2159
+ #
1391
2160
  # @!attribute [rw] format
1392
2161
  # The format of the model input configuration. The format differs
1393
2162
  # depending on if it is passed through to SageMaker or constructed by
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
@@ -1419,14 +2184,16 @@ module Aws::FraudDetector
1419
2184
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ModelInputConfiguration AWS API Documentation
1420
2185
  #
1421
2186
  class ModelInputConfiguration < Struct.new(
2187
+ :event_type_name,
1422
2188
  :format,
1423
- :is_opaque,
2189
+ :use_event_variables,
1424
2190
  :json_input_template,
1425
2191
  :csv_input_template)
2192
+ SENSITIVE = []
1426
2193
  include Aws::Structure
1427
2194
  end
1428
2195
 
1429
- # Provides the model output configuration.
2196
+ # Provides the Amazon Sagemaker model output configuration.
1430
2197
  #
1431
2198
  # @note When making an API call, you may pass ModelOutputConfiguration
1432
2199
  # data as a hash:
@@ -1461,6 +2228,7 @@ module Aws::FraudDetector
1461
2228
  :format,
1462
2229
  :json_key_to_variable_map,
1463
2230
  :csv_index_to_variable_map)
2231
+ SENSITIVE = []
1464
2232
  include Aws::Structure
1465
2233
  end
1466
2234
 
@@ -1479,32 +2247,7 @@ module Aws::FraudDetector
1479
2247
  class ModelScores < Struct.new(
1480
2248
  :model_version,
1481
2249
  :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)
2250
+ SENSITIVE = []
1508
2251
  include Aws::Structure
1509
2252
  end
1510
2253
 
@@ -1514,13 +2257,14 @@ module Aws::FraudDetector
1514
2257
  # data as a hash:
1515
2258
  #
1516
2259
  # {
1517
- # model_id: "identifier", # required
2260
+ # model_id: "modelIdentifier", # required
1518
2261
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1519
2262
  # model_version_number: "nonEmptyString", # required
2263
+ # arn: "fraudDetectorArn",
1520
2264
  # }
1521
2265
  #
1522
2266
  # @!attribute [rw] model_id
1523
- # The parent model ID.
2267
+ # The model ID.
1524
2268
  # @return [String]
1525
2269
  #
1526
2270
  # @!attribute [rw] model_type
@@ -1528,7 +2272,11 @@ module Aws::FraudDetector
1528
2272
  # @return [String]
1529
2273
  #
1530
2274
  # @!attribute [rw] model_version_number
1531
- # The model version.
2275
+ # The model version number.
2276
+ # @return [String]
2277
+ #
2278
+ # @!attribute [rw] arn
2279
+ # The model version ARN.
1532
2280
  # @return [String]
1533
2281
  #
1534
2282
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ModelVersion AWS API Documentation
@@ -1536,11 +2284,13 @@ module Aws::FraudDetector
1536
2284
  class ModelVersion < Struct.new(
1537
2285
  :model_id,
1538
2286
  :model_type,
1539
- :model_version_number)
2287
+ :model_version_number,
2288
+ :arn)
2289
+ SENSITIVE = []
1540
2290
  include Aws::Structure
1541
2291
  end
1542
2292
 
1543
- # Provides the model version details.
2293
+ # The details of the model version.
1544
2294
  #
1545
2295
  # @!attribute [rw] model_id
1546
2296
  # The model ID.
@@ -1551,36 +2301,28 @@ module Aws::FraudDetector
1551
2301
  # @return [String]
1552
2302
  #
1553
2303
  # @!attribute [rw] model_version_number
1554
- # The model version.
1555
- # @return [String]
1556
- #
1557
- # @!attribute [rw] description
1558
- # The model description.
2304
+ # The model version number.
1559
2305
  # @return [String]
1560
2306
  #
1561
2307
  # @!attribute [rw] status
1562
- # The model status.
2308
+ # The status of the model version.
1563
2309
  # @return [String]
1564
2310
  #
1565
2311
  # @!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>]
2312
+ # The model version training data source.
2313
+ # @return [String]
1572
2314
  #
1573
- # @!attribute [rw] label_schema
1574
- # The model label schema.
1575
- # @return [Types::LabelSchema]
2315
+ # @!attribute [rw] training_data_schema
2316
+ # The training data schema.
2317
+ # @return [Types::TrainingDataSchema]
1576
2318
  #
1577
- # @!attribute [rw] validation_metrics
1578
- # The model validation metrics.
1579
- # @return [Hash<String,String>]
2319
+ # @!attribute [rw] external_events_detail
2320
+ # The event details.
2321
+ # @return [Types::ExternalEventsDetail]
1580
2322
  #
1581
- # @!attribute [rw] training_metrics
1582
- # The model training metrics.
1583
- # @return [Hash<String,String>]
2323
+ # @!attribute [rw] training_result
2324
+ # The training results.
2325
+ # @return [Types::TrainingResult]
1584
2326
  #
1585
2327
  # @!attribute [rw] last_updated_time
1586
2328
  # The timestamp when the model was last updated.
@@ -1590,21 +2332,25 @@ module Aws::FraudDetector
1590
2332
  # The timestamp when the model was created.
1591
2333
  # @return [String]
1592
2334
  #
2335
+ # @!attribute [rw] arn
2336
+ # The model version ARN.
2337
+ # @return [String]
2338
+ #
1593
2339
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ModelVersionDetail AWS API Documentation
1594
2340
  #
1595
2341
  class ModelVersionDetail < Struct.new(
1596
2342
  :model_id,
1597
2343
  :model_type,
1598
2344
  :model_version_number,
1599
- :description,
1600
2345
  :status,
1601
2346
  :training_data_source,
1602
- :model_variables,
1603
- :label_schema,
1604
- :validation_metrics,
1605
- :training_metrics,
2347
+ :training_data_schema,
2348
+ :external_events_detail,
2349
+ :training_result,
1606
2350
  :last_updated_time,
1607
- :created_time)
2351
+ :created_time,
2352
+ :arn)
2353
+ SENSITIVE = []
1608
2354
  include Aws::Structure
1609
2355
  end
1610
2356
 
@@ -1626,13 +2372,19 @@ module Aws::FraudDetector
1626
2372
  # The timestamp when the outcome was created.
1627
2373
  # @return [String]
1628
2374
  #
2375
+ # @!attribute [rw] arn
2376
+ # The outcome ARN.
2377
+ # @return [String]
2378
+ #
1629
2379
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Outcome AWS API Documentation
1630
2380
  #
1631
2381
  class Outcome < Struct.new(
1632
2382
  :name,
1633
2383
  :description,
1634
2384
  :last_updated_time,
1635
- :created_time)
2385
+ :created_time,
2386
+ :arn)
2387
+ SENSITIVE = []
1636
2388
  include Aws::Structure
1637
2389
  end
1638
2390
 
@@ -1642,6 +2394,13 @@ module Aws::FraudDetector
1642
2394
  # {
1643
2395
  # detector_id: "identifier", # required
1644
2396
  # description: "description",
2397
+ # event_type_name: "identifier", # required
2398
+ # tags: [
2399
+ # {
2400
+ # key: "tagKey", # required
2401
+ # value: "tagValue", # required
2402
+ # },
2403
+ # ],
1645
2404
  # }
1646
2405
  #
1647
2406
  # @!attribute [rw] detector_id
@@ -1652,11 +2411,22 @@ module Aws::FraudDetector
1652
2411
  # The description of the detector.
1653
2412
  # @return [String]
1654
2413
  #
2414
+ # @!attribute [rw] event_type_name
2415
+ # The name of the event type.
2416
+ # @return [String]
2417
+ #
2418
+ # @!attribute [rw] tags
2419
+ # A collection of key and value pairs.
2420
+ # @return [Array<Types::Tag>]
2421
+ #
1655
2422
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutDetectorRequest AWS API Documentation
1656
2423
  #
1657
2424
  class PutDetectorRequest < Struct.new(
1658
2425
  :detector_id,
1659
- :description)
2426
+ :description,
2427
+ :event_type_name,
2428
+ :tags)
2429
+ SENSITIVE = []
1660
2430
  include Aws::Structure
1661
2431
  end
1662
2432
 
@@ -1664,19 +2434,116 @@ module Aws::FraudDetector
1664
2434
  #
1665
2435
  class PutDetectorResult < Aws::EmptyStructure; end
1666
2436
 
2437
+ # @note When making an API call, you may pass PutEntityTypeRequest
2438
+ # data as a hash:
2439
+ #
2440
+ # {
2441
+ # name: "identifier", # required
2442
+ # description: "description",
2443
+ # tags: [
2444
+ # {
2445
+ # key: "tagKey", # required
2446
+ # value: "tagValue", # required
2447
+ # },
2448
+ # ],
2449
+ # }
2450
+ #
2451
+ # @!attribute [rw] name
2452
+ # The name of the entity type.
2453
+ # @return [String]
2454
+ #
2455
+ # @!attribute [rw] description
2456
+ # The description.
2457
+ # @return [String]
2458
+ #
2459
+ # @!attribute [rw] tags
2460
+ # A collection of key and value pairs.
2461
+ # @return [Array<Types::Tag>]
2462
+ #
2463
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutEntityTypeRequest AWS API Documentation
2464
+ #
2465
+ class PutEntityTypeRequest < Struct.new(
2466
+ :name,
2467
+ :description,
2468
+ :tags)
2469
+ SENSITIVE = []
2470
+ include Aws::Structure
2471
+ end
2472
+
2473
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutEntityTypeResult AWS API Documentation
2474
+ #
2475
+ class PutEntityTypeResult < Aws::EmptyStructure; end
2476
+
2477
+ # @note When making an API call, you may pass PutEventTypeRequest
2478
+ # data as a hash:
2479
+ #
2480
+ # {
2481
+ # name: "identifier", # required
2482
+ # description: "description",
2483
+ # event_variables: ["string"], # required
2484
+ # labels: ["string"],
2485
+ # entity_types: ["string"], # required
2486
+ # tags: [
2487
+ # {
2488
+ # key: "tagKey", # required
2489
+ # value: "tagValue", # required
2490
+ # },
2491
+ # ],
2492
+ # }
2493
+ #
2494
+ # @!attribute [rw] name
2495
+ # The name.
2496
+ # @return [String]
2497
+ #
2498
+ # @!attribute [rw] description
2499
+ # The description of the event type.
2500
+ # @return [String]
2501
+ #
2502
+ # @!attribute [rw] event_variables
2503
+ # The event type variables.
2504
+ # @return [Array<String>]
2505
+ #
2506
+ # @!attribute [rw] labels
2507
+ # The event type labels.
2508
+ # @return [Array<String>]
2509
+ #
2510
+ # @!attribute [rw] entity_types
2511
+ # The entity type for the event type. Example entity types: customer,
2512
+ # merchant, account.
2513
+ # @return [Array<String>]
2514
+ #
2515
+ # @!attribute [rw] tags
2516
+ # A collection of key and value pairs.
2517
+ # @return [Array<Types::Tag>]
2518
+ #
2519
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutEventTypeRequest AWS API Documentation
2520
+ #
2521
+ class PutEventTypeRequest < Struct.new(
2522
+ :name,
2523
+ :description,
2524
+ :event_variables,
2525
+ :labels,
2526
+ :entity_types,
2527
+ :tags)
2528
+ SENSITIVE = []
2529
+ include Aws::Structure
2530
+ end
2531
+
2532
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutEventTypeResult AWS API Documentation
2533
+ #
2534
+ class PutEventTypeResult < Aws::EmptyStructure; end
2535
+
1667
2536
  # @note When making an API call, you may pass PutExternalModelRequest
1668
2537
  # data as a hash:
1669
2538
  #
1670
2539
  # {
1671
- # model_endpoint: "string", # required
2540
+ # model_endpoint: "sageMakerEndpointIdentifier", # required
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
2544
+ # event_type_name: "identifier",
1678
2545
  # format: "TEXT_CSV", # accepts TEXT_CSV, APPLICATION_JSON
1679
- # is_opaque: false, # required
2546
+ # use_event_variables: false, # required
1680
2547
  # json_input_template: "string",
1681
2548
  # csv_input_template: "string",
1682
2549
  # },
@@ -1690,6 +2557,12 @@ module Aws::FraudDetector
1690
2557
  # },
1691
2558
  # },
1692
2559
  # model_endpoint_status: "ASSOCIATED", # required, accepts ASSOCIATED, DISSOCIATED
2560
+ # tags: [
2561
+ # {
2562
+ # key: "tagKey", # required
2563
+ # value: "tagValue", # required
2564
+ # },
2565
+ # ],
1693
2566
  # }
1694
2567
  #
1695
2568
  # @!attribute [rw] model_endpoint
@@ -1700,9 +2573,9 @@ module Aws::FraudDetector
1700
2573
  # The source of the model.
1701
2574
  # @return [String]
1702
2575
  #
1703
- # @!attribute [rw] role
2576
+ # @!attribute [rw] invoke_model_endpoint_role_arn
1704
2577
  # The IAM role used to invoke the model endpoint.
1705
- # @return [Types::Role]
2578
+ # @return [String]
1706
2579
  #
1707
2580
  # @!attribute [rw] input_configuration
1708
2581
  # The model endpoint input configuration.
@@ -1716,86 +2589,89 @@ module Aws::FraudDetector
1716
2589
  # The model endpoint’s status in Amazon Fraud Detector.
1717
2590
  # @return [String]
1718
2591
  #
2592
+ # @!attribute [rw] tags
2593
+ # A collection of key and value pairs.
2594
+ # @return [Array<Types::Tag>]
2595
+ #
1719
2596
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutExternalModelRequest AWS API Documentation
1720
2597
  #
1721
2598
  class PutExternalModelRequest < Struct.new(
1722
2599
  :model_endpoint,
1723
2600
  :model_source,
1724
- :role,
2601
+ :invoke_model_endpoint_role_arn,
1725
2602
  :input_configuration,
1726
2603
  :output_configuration,
1727
- :model_endpoint_status)
2604
+ :model_endpoint_status,
2605
+ :tags)
2606
+ SENSITIVE = []
2607
+ include Aws::Structure
2608
+ end
2609
+
2610
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutExternalModelResult AWS API Documentation
2611
+ #
2612
+ class PutExternalModelResult < Aws::EmptyStructure; end
2613
+
2614
+ # @note When making an API call, you may pass PutKMSEncryptionKeyRequest
2615
+ # data as a hash:
2616
+ #
2617
+ # {
2618
+ # kms_encryption_key_arn: "KmsEncryptionKeyArn", # required
2619
+ # }
2620
+ #
2621
+ # @!attribute [rw] kms_encryption_key_arn
2622
+ # The KMS encryption key ARN.
2623
+ # @return [String]
2624
+ #
2625
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutKMSEncryptionKeyRequest AWS API Documentation
2626
+ #
2627
+ class PutKMSEncryptionKeyRequest < Struct.new(
2628
+ :kms_encryption_key_arn)
2629
+ SENSITIVE = []
1728
2630
  include Aws::Structure
1729
2631
  end
1730
2632
 
1731
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutExternalModelResult AWS API Documentation
2633
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutKMSEncryptionKeyResult AWS API Documentation
1732
2634
  #
1733
- class PutExternalModelResult < Aws::EmptyStructure; end
2635
+ class PutKMSEncryptionKeyResult < Aws::EmptyStructure; end
1734
2636
 
1735
- # @note When making an API call, you may pass PutModelRequest
2637
+ # @note When making an API call, you may pass PutLabelRequest
1736
2638
  # data as a hash:
1737
2639
  #
1738
2640
  # {
1739
- # model_id: "identifier", # required
1740
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
2641
+ # name: "identifier", # required
1741
2642
  # description: "description",
1742
- # training_data_source: { # required
1743
- # data_location: "s3BucketLocation", # required
1744
- # data_access_role_arn: "iamRoleArn", # required
1745
- # },
1746
- # model_variables: [ # required
2643
+ # tags: [
1747
2644
  # {
1748
- # name: "string", # required
1749
- # index: 1,
2645
+ # key: "tagKey", # required
2646
+ # value: "tagValue", # required
1750
2647
  # },
1751
2648
  # ],
1752
- # label_schema: { # required
1753
- # label_key: "string", # required
1754
- # label_mapper: { # required
1755
- # "string" => ["string"],
1756
- # },
1757
- # },
1758
2649
  # }
1759
2650
  #
1760
- # @!attribute [rw] model_id
1761
- # The model ID.
1762
- # @return [String]
1763
- #
1764
- # @!attribute [rw] model_type
1765
- # The model type.
2651
+ # @!attribute [rw] name
2652
+ # The label name.
1766
2653
  # @return [String]
1767
2654
  #
1768
2655
  # @!attribute [rw] description
1769
- # The model description.
2656
+ # The label description.
1770
2657
  # @return [String]
1771
2658
  #
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]
2659
+ # @!attribute [rw] tags
2660
+ # @return [Array<Types::Tag>]
1783
2661
  #
1784
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutModelRequest AWS API Documentation
2662
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutLabelRequest AWS API Documentation
1785
2663
  #
1786
- class PutModelRequest < Struct.new(
1787
- :model_id,
1788
- :model_type,
2664
+ class PutLabelRequest < Struct.new(
2665
+ :name,
1789
2666
  :description,
1790
- :training_data_source,
1791
- :model_variables,
1792
- :label_schema)
2667
+ :tags)
2668
+ SENSITIVE = []
1793
2669
  include Aws::Structure
1794
2670
  end
1795
2671
 
1796
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutModelResult AWS API Documentation
2672
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutLabelResult AWS API Documentation
1797
2673
  #
1798
- class PutModelResult < Aws::EmptyStructure; end
2674
+ class PutLabelResult < Aws::EmptyStructure; end
1799
2675
 
1800
2676
  # @note When making an API call, you may pass PutOutcomeRequest
1801
2677
  # data as a hash:
@@ -1803,6 +2679,12 @@ module Aws::FraudDetector
1803
2679
  # {
1804
2680
  # name: "identifier", # required
1805
2681
  # description: "description",
2682
+ # tags: [
2683
+ # {
2684
+ # key: "tagKey", # required
2685
+ # value: "tagValue", # required
2686
+ # },
2687
+ # ],
1806
2688
  # }
1807
2689
  #
1808
2690
  # @!attribute [rw] name
@@ -1813,11 +2695,17 @@ module Aws::FraudDetector
1813
2695
  # The outcome description.
1814
2696
  # @return [String]
1815
2697
  #
2698
+ # @!attribute [rw] tags
2699
+ # A collection of key and value pairs.
2700
+ # @return [Array<Types::Tag>]
2701
+ #
1816
2702
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutOutcomeRequest AWS API Documentation
1817
2703
  #
1818
2704
  class PutOutcomeRequest < Struct.new(
1819
2705
  :name,
1820
- :description)
2706
+ :description,
2707
+ :tags)
2708
+ SENSITIVE = []
1821
2709
  include Aws::Structure
1822
2710
  end
1823
2711
 
@@ -1834,32 +2722,7 @@ module Aws::FraudDetector
1834
2722
  #
1835
2723
  class ResourceNotFoundException < Struct.new(
1836
2724
  :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)
2725
+ SENSITIVE = []
1863
2726
  include Aws::Structure
1864
2727
  end
1865
2728
 
@@ -1871,7 +2734,7 @@ module Aws::FraudDetector
1871
2734
  # {
1872
2735
  # detector_id: "identifier", # required
1873
2736
  # rule_id: "identifier", # required
1874
- # rule_version: "nonEmptyString", # required
2737
+ # rule_version: "wholeNumberVersionString", # required
1875
2738
  # }
1876
2739
  #
1877
2740
  # @!attribute [rw] detector_id
@@ -1892,6 +2755,7 @@ module Aws::FraudDetector
1892
2755
  :detector_id,
1893
2756
  :rule_id,
1894
2757
  :rule_version)
2758
+ SENSITIVE = []
1895
2759
  include Aws::Structure
1896
2760
  end
1897
2761
 
@@ -1933,6 +2797,10 @@ module Aws::FraudDetector
1933
2797
  # The timestamp of when the rule was created.
1934
2798
  # @return [String]
1935
2799
  #
2800
+ # @!attribute [rw] arn
2801
+ # The rule ARN.
2802
+ # @return [String]
2803
+ #
1936
2804
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/RuleDetail AWS API Documentation
1937
2805
  #
1938
2806
  class RuleDetail < Struct.new(
@@ -1944,7 +2812,9 @@ module Aws::FraudDetector
1944
2812
  :language,
1945
2813
  :outcomes,
1946
2814
  :last_updated_time,
1947
- :created_time)
2815
+ :created_time,
2816
+ :arn)
2817
+ SENSITIVE = [:expression]
1948
2818
  include Aws::Structure
1949
2819
  end
1950
2820
 
@@ -1963,9 +2833,71 @@ module Aws::FraudDetector
1963
2833
  class RuleResult < Struct.new(
1964
2834
  :rule_id,
1965
2835
  :outcomes)
2836
+ SENSITIVE = []
2837
+ include Aws::Structure
2838
+ end
2839
+
2840
+ # A key and value pair.
2841
+ #
2842
+ # @note When making an API call, you may pass Tag
2843
+ # data as a hash:
2844
+ #
2845
+ # {
2846
+ # key: "tagKey", # required
2847
+ # value: "tagValue", # required
2848
+ # }
2849
+ #
2850
+ # @!attribute [rw] key
2851
+ # A tag key.
2852
+ # @return [String]
2853
+ #
2854
+ # @!attribute [rw] value
2855
+ # A value assigned to a tag key.
2856
+ # @return [String]
2857
+ #
2858
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Tag AWS API Documentation
2859
+ #
2860
+ class Tag < Struct.new(
2861
+ :key,
2862
+ :value)
2863
+ SENSITIVE = []
2864
+ include Aws::Structure
2865
+ end
2866
+
2867
+ # @note When making an API call, you may pass TagResourceRequest
2868
+ # data as a hash:
2869
+ #
2870
+ # {
2871
+ # resource_arn: "fraudDetectorArn", # required
2872
+ # tags: [ # required
2873
+ # {
2874
+ # key: "tagKey", # required
2875
+ # value: "tagValue", # required
2876
+ # },
2877
+ # ],
2878
+ # }
2879
+ #
2880
+ # @!attribute [rw] resource_arn
2881
+ # The resource ARN.
2882
+ # @return [String]
2883
+ #
2884
+ # @!attribute [rw] tags
2885
+ # The tags to assign to the resource.
2886
+ # @return [Array<Types::Tag>]
2887
+ #
2888
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/TagResourceRequest AWS API Documentation
2889
+ #
2890
+ class TagResourceRequest < Struct.new(
2891
+ :resource_arn,
2892
+ :tags)
2893
+ SENSITIVE = []
1966
2894
  include Aws::Structure
1967
2895
  end
1968
2896
 
2897
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/TagResourceResult AWS API Documentation
2898
+ #
2899
+ class TagResourceResult < Aws::EmptyStructure; end
2900
+
1969
2901
  # An exception indicating a throttling error.
1970
2902
  #
1971
2903
  # @!attribute [rw] message
@@ -1975,41 +2907,117 @@ module Aws::FraudDetector
1975
2907
  #
1976
2908
  class ThrottlingException < Struct.new(
1977
2909
  :message)
2910
+ SENSITIVE = []
1978
2911
  include Aws::Structure
1979
2912
  end
1980
2913
 
1981
- # The training data source.
2914
+ # The training data schema.
1982
2915
  #
1983
- # @note When making an API call, you may pass TrainingDataSource
2916
+ # @note When making an API call, you may pass TrainingDataSchema
1984
2917
  # data as a hash:
1985
2918
  #
1986
2919
  # {
1987
- # data_location: "s3BucketLocation", # required
1988
- # data_access_role_arn: "iamRoleArn", # required
2920
+ # model_variables: ["string"], # required
2921
+ # label_schema: { # required
2922
+ # label_mapper: { # required
2923
+ # "string" => ["string"],
2924
+ # },
2925
+ # },
1989
2926
  # }
1990
2927
  #
1991
- # @!attribute [rw] data_location
1992
- # The data location of the training data source.
1993
- # @return [String]
2928
+ # @!attribute [rw] model_variables
2929
+ # The training data schema variables.
2930
+ # @return [Array<String>]
1994
2931
  #
1995
- # @!attribute [rw] data_access_role_arn
1996
- # The data access role ARN for the training data source.
2932
+ # @!attribute [rw] label_schema
2933
+ # The label schema.
2934
+ # @return [Types::LabelSchema]
2935
+ #
2936
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/TrainingDataSchema AWS API Documentation
2937
+ #
2938
+ class TrainingDataSchema < Struct.new(
2939
+ :model_variables,
2940
+ :label_schema)
2941
+ SENSITIVE = []
2942
+ include Aws::Structure
2943
+ end
2944
+
2945
+ # The training metric details.
2946
+ #
2947
+ # @!attribute [rw] auc
2948
+ # The area under the curve. This summarizes true positive rate (TPR)
2949
+ # and false positive rate (FPR) across all possible model score
2950
+ # thresholds. A model with no predictive power has an AUC of 0.5,
2951
+ # whereas a perfect model has a score of 1.0.
2952
+ # @return [Float]
2953
+ #
2954
+ # @!attribute [rw] metric_data_points
2955
+ # The data points details.
2956
+ # @return [Array<Types::MetricDataPoint>]
2957
+ #
2958
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/TrainingMetrics AWS API Documentation
2959
+ #
2960
+ class TrainingMetrics < Struct.new(
2961
+ :auc,
2962
+ :metric_data_points)
2963
+ SENSITIVE = []
2964
+ include Aws::Structure
2965
+ end
2966
+
2967
+ # The training result details.
2968
+ #
2969
+ # @!attribute [rw] data_validation_metrics
2970
+ # The validation metrics.
2971
+ # @return [Types::DataValidationMetrics]
2972
+ #
2973
+ # @!attribute [rw] training_metrics
2974
+ # The training metric details.
2975
+ # @return [Types::TrainingMetrics]
2976
+ #
2977
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/TrainingResult AWS API Documentation
2978
+ #
2979
+ class TrainingResult < Struct.new(
2980
+ :data_validation_metrics,
2981
+ :training_metrics)
2982
+ SENSITIVE = []
2983
+ include Aws::Structure
2984
+ end
2985
+
2986
+ # @note When making an API call, you may pass UntagResourceRequest
2987
+ # data as a hash:
2988
+ #
2989
+ # {
2990
+ # resource_arn: "fraudDetectorArn", # required
2991
+ # tag_keys: ["tagKey"], # required
2992
+ # }
2993
+ #
2994
+ # @!attribute [rw] resource_arn
2995
+ # The ARN of the resource from which to remove the tag.
1997
2996
  # @return [String]
1998
2997
  #
1999
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/TrainingDataSource AWS API Documentation
2998
+ # @!attribute [rw] tag_keys
2999
+ # The resource ARN.
3000
+ # @return [Array<String>]
2000
3001
  #
2001
- class TrainingDataSource < Struct.new(
2002
- :data_location,
2003
- :data_access_role_arn)
3002
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UntagResourceRequest AWS API Documentation
3003
+ #
3004
+ class UntagResourceRequest < Struct.new(
3005
+ :resource_arn,
3006
+ :tag_keys)
3007
+ SENSITIVE = []
2004
3008
  include Aws::Structure
2005
3009
  end
2006
3010
 
3011
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UntagResourceResult AWS API Documentation
3012
+ #
3013
+ class UntagResourceResult < Aws::EmptyStructure; end
3014
+
2007
3015
  # @note When making an API call, you may pass UpdateDetectorVersionMetadataRequest
2008
3016
  # data as a hash:
2009
3017
  #
2010
3018
  # {
2011
3019
  # detector_id: "identifier", # required
2012
- # detector_version_id: "nonEmptyString", # required
3020
+ # detector_version_id: "wholeNumberVersionString", # required
2013
3021
  # description: "description", # required
2014
3022
  # }
2015
3023
  #
@@ -2031,6 +3039,7 @@ module Aws::FraudDetector
2031
3039
  :detector_id,
2032
3040
  :detector_version_id,
2033
3041
  :description)
3042
+ SENSITIVE = []
2034
3043
  include Aws::Structure
2035
3044
  end
2036
3045
 
@@ -2043,21 +3052,22 @@ module Aws::FraudDetector
2043
3052
  #
2044
3053
  # {
2045
3054
  # detector_id: "identifier", # required
2046
- # detector_version_id: "nonEmptyString", # required
3055
+ # detector_version_id: "wholeNumberVersionString", # required
2047
3056
  # external_model_endpoints: ["string"], # required
2048
3057
  # rules: [ # required
2049
3058
  # {
2050
3059
  # detector_id: "identifier", # required
2051
3060
  # rule_id: "identifier", # required
2052
- # rule_version: "nonEmptyString", # required
3061
+ # rule_version: "wholeNumberVersionString", # required
2053
3062
  # },
2054
3063
  # ],
2055
3064
  # description: "description",
2056
3065
  # model_versions: [
2057
3066
  # {
2058
- # model_id: "identifier", # required
3067
+ # model_id: "modelIdentifier", # required
2059
3068
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
2060
3069
  # model_version_number: "nonEmptyString", # required
3070
+ # arn: "fraudDetectorArn",
2061
3071
  # },
2062
3072
  # ],
2063
3073
  # rule_execution_mode: "ALL_MATCHED", # accepts ALL_MATCHED, FIRST_MATCHED
@@ -2114,6 +3124,7 @@ module Aws::FraudDetector
2114
3124
  :description,
2115
3125
  :model_versions,
2116
3126
  :rule_execution_mode)
3127
+ SENSITIVE = []
2117
3128
  include Aws::Structure
2118
3129
  end
2119
3130
 
@@ -2126,7 +3137,7 @@ module Aws::FraudDetector
2126
3137
  #
2127
3138
  # {
2128
3139
  # detector_id: "identifier", # required
2129
- # detector_version_id: "nonEmptyString", # required
3140
+ # detector_version_id: "wholeNumberVersionString", # required
2130
3141
  # status: "DRAFT", # required, accepts DRAFT, ACTIVE, INACTIVE
2131
3142
  # }
2132
3143
  #
@@ -2148,6 +3159,7 @@ module Aws::FraudDetector
2148
3159
  :detector_id,
2149
3160
  :detector_version_id,
2150
3161
  :status)
3162
+ SENSITIVE = []
2151
3163
  include Aws::Structure
2152
3164
  end
2153
3165
 
@@ -2155,17 +3167,92 @@ module Aws::FraudDetector
2155
3167
  #
2156
3168
  class UpdateDetectorVersionStatusResult < Aws::EmptyStructure; end
2157
3169
 
3170
+ # @note When making an API call, you may pass UpdateModelRequest
3171
+ # data as a hash:
3172
+ #
3173
+ # {
3174
+ # model_id: "modelIdentifier", # required
3175
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
3176
+ # description: "description",
3177
+ # }
3178
+ #
3179
+ # @!attribute [rw] model_id
3180
+ # The model ID.
3181
+ # @return [String]
3182
+ #
3183
+ # @!attribute [rw] model_type
3184
+ # The model type.
3185
+ # @return [String]
3186
+ #
3187
+ # @!attribute [rw] description
3188
+ # The new model description.
3189
+ # @return [String]
3190
+ #
3191
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelRequest AWS API Documentation
3192
+ #
3193
+ class UpdateModelRequest < Struct.new(
3194
+ :model_id,
3195
+ :model_type,
3196
+ :description)
3197
+ SENSITIVE = []
3198
+ include Aws::Structure
3199
+ end
3200
+
3201
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelResult AWS API Documentation
3202
+ #
3203
+ class UpdateModelResult < Aws::EmptyStructure; end
3204
+
2158
3205
  # @note When making an API call, you may pass UpdateModelVersionRequest
2159
3206
  # data as a hash:
2160
3207
  #
2161
3208
  # {
2162
- # model_id: "identifier", # required
3209
+ # model_id: "modelIdentifier", # required
2163
3210
  # 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
3211
+ # major_version_number: "wholeNumberVersionString", # required
3212
+ # external_events_detail: {
3213
+ # data_location: "s3BucketLocation", # required
3214
+ # data_access_role_arn: "iamRoleArn", # required
3215
+ # },
3216
+ # tags: [
3217
+ # {
3218
+ # key: "tagKey", # required
3219
+ # value: "tagValue", # required
3220
+ # },
3221
+ # ],
2167
3222
  # }
2168
3223
  #
3224
+ # @!attribute [rw] model_id
3225
+ # The model ID.
3226
+ # @return [String]
3227
+ #
3228
+ # @!attribute [rw] model_type
3229
+ # The model type.
3230
+ # @return [String]
3231
+ #
3232
+ # @!attribute [rw] major_version_number
3233
+ # The major version number.
3234
+ # @return [String]
3235
+ #
3236
+ # @!attribute [rw] external_events_detail
3237
+ # The event details.
3238
+ # @return [Types::ExternalEventsDetail]
3239
+ #
3240
+ # @!attribute [rw] tags
3241
+ # A collection of key and value pairs.
3242
+ # @return [Array<Types::Tag>]
3243
+ #
3244
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelVersionRequest AWS API Documentation
3245
+ #
3246
+ class UpdateModelVersionRequest < Struct.new(
3247
+ :model_id,
3248
+ :model_type,
3249
+ :major_version_number,
3250
+ :external_events_detail,
3251
+ :tags)
3252
+ SENSITIVE = []
3253
+ include Aws::Structure
3254
+ end
3255
+
2169
3256
  # @!attribute [rw] model_id
2170
3257
  # The model ID.
2171
3258
  # @return [String]
@@ -2175,31 +3262,64 @@ module Aws::FraudDetector
2175
3262
  # @return [String]
2176
3263
  #
2177
3264
  # @!attribute [rw] model_version_number
2178
- # The model version.
3265
+ # The model version number of the model version updated.
2179
3266
  # @return [String]
2180
3267
  #
2181
- # @!attribute [rw] description
2182
- # The model description.
3268
+ # @!attribute [rw] status
3269
+ # The status of the updated model version.
3270
+ # @return [String]
3271
+ #
3272
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelVersionResult AWS API Documentation
3273
+ #
3274
+ class UpdateModelVersionResult < Struct.new(
3275
+ :model_id,
3276
+ :model_type,
3277
+ :model_version_number,
3278
+ :status)
3279
+ SENSITIVE = []
3280
+ include Aws::Structure
3281
+ end
3282
+
3283
+ # @note When making an API call, you may pass UpdateModelVersionStatusRequest
3284
+ # data as a hash:
3285
+ #
3286
+ # {
3287
+ # model_id: "modelIdentifier", # required
3288
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
3289
+ # model_version_number: "floatVersionString", # required
3290
+ # status: "ACTIVE", # required, accepts ACTIVE, INACTIVE
3291
+ # }
3292
+ #
3293
+ # @!attribute [rw] model_id
3294
+ # The model ID of the model version to update.
3295
+ # @return [String]
3296
+ #
3297
+ # @!attribute [rw] model_type
3298
+ # The model type.
3299
+ # @return [String]
3300
+ #
3301
+ # @!attribute [rw] model_version_number
3302
+ # The model version number.
2183
3303
  # @return [String]
2184
3304
  #
2185
3305
  # @!attribute [rw] status
2186
- # The new model status.
3306
+ # The model version status.
2187
3307
  # @return [String]
2188
3308
  #
2189
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelVersionRequest AWS API Documentation
3309
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelVersionStatusRequest AWS API Documentation
2190
3310
  #
2191
- class UpdateModelVersionRequest < Struct.new(
3311
+ class UpdateModelVersionStatusRequest < Struct.new(
2192
3312
  :model_id,
2193
3313
  :model_type,
2194
3314
  :model_version_number,
2195
- :description,
2196
3315
  :status)
3316
+ SENSITIVE = []
2197
3317
  include Aws::Structure
2198
3318
  end
2199
3319
 
2200
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelVersionResult AWS API Documentation
3320
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelVersionStatusResult AWS API Documentation
2201
3321
  #
2202
- class UpdateModelVersionResult < Aws::EmptyStructure; end
3322
+ class UpdateModelVersionStatusResult < Aws::EmptyStructure; end
2203
3323
 
2204
3324
  # @note When making an API call, you may pass UpdateRuleMetadataRequest
2205
3325
  # data as a hash:
@@ -2208,7 +3328,7 @@ module Aws::FraudDetector
2208
3328
  # rule: { # required
2209
3329
  # detector_id: "identifier", # required
2210
3330
  # rule_id: "identifier", # required
2211
- # rule_version: "nonEmptyString", # required
3331
+ # rule_version: "wholeNumberVersionString", # required
2212
3332
  # },
2213
3333
  # description: "description", # required
2214
3334
  # }
@@ -2226,6 +3346,7 @@ module Aws::FraudDetector
2226
3346
  class UpdateRuleMetadataRequest < Struct.new(
2227
3347
  :rule,
2228
3348
  :description)
3349
+ SENSITIVE = []
2229
3350
  include Aws::Structure
2230
3351
  end
2231
3352
 
@@ -2240,12 +3361,18 @@ module Aws::FraudDetector
2240
3361
  # rule: { # required
2241
3362
  # detector_id: "identifier", # required
2242
3363
  # rule_id: "identifier", # required
2243
- # rule_version: "nonEmptyString", # required
3364
+ # rule_version: "wholeNumberVersionString", # required
2244
3365
  # },
2245
3366
  # description: "description",
2246
3367
  # expression: "ruleExpression", # required
2247
3368
  # language: "DETECTORPL", # required, accepts DETECTORPL
2248
3369
  # outcomes: ["string"], # required
3370
+ # tags: [
3371
+ # {
3372
+ # key: "tagKey", # required
3373
+ # value: "tagValue", # required
3374
+ # },
3375
+ # ],
2249
3376
  # }
2250
3377
  #
2251
3378
  # @!attribute [rw] rule
@@ -2268,6 +3395,10 @@ module Aws::FraudDetector
2268
3395
  # The outcomes.
2269
3396
  # @return [Array<String>]
2270
3397
  #
3398
+ # @!attribute [rw] tags
3399
+ # The tags to assign to the rule version.
3400
+ # @return [Array<Types::Tag>]
3401
+ #
2271
3402
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateRuleVersionRequest AWS API Documentation
2272
3403
  #
2273
3404
  class UpdateRuleVersionRequest < Struct.new(
@@ -2275,7 +3406,9 @@ module Aws::FraudDetector
2275
3406
  :description,
2276
3407
  :expression,
2277
3408
  :language,
2278
- :outcomes)
3409
+ :outcomes,
3410
+ :tags)
3411
+ SENSITIVE = [:expression]
2279
3412
  include Aws::Structure
2280
3413
  end
2281
3414
 
@@ -2287,6 +3420,7 @@ module Aws::FraudDetector
2287
3420
  #
2288
3421
  class UpdateRuleVersionResult < Struct.new(
2289
3422
  :rule)
3423
+ SENSITIVE = []
2290
3424
  include Aws::Structure
2291
3425
  end
2292
3426
 
@@ -2313,7 +3447,11 @@ module Aws::FraudDetector
2313
3447
  # @return [String]
2314
3448
  #
2315
3449
  # @!attribute [rw] variable_type
2316
- # The variable type.
3450
+ # The variable type. For more information see [Variable types][1].
3451
+ #
3452
+ #
3453
+ #
3454
+ # [1]: https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types
2317
3455
  # @return [String]
2318
3456
  #
2319
3457
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateVariableRequest AWS API Documentation
@@ -2323,6 +3461,7 @@ module Aws::FraudDetector
2323
3461
  :default_value,
2324
3462
  :description,
2325
3463
  :variable_type)
3464
+ SENSITIVE = []
2326
3465
  include Aws::Structure
2327
3466
  end
2328
3467
 
@@ -2339,6 +3478,7 @@ module Aws::FraudDetector
2339
3478
  #
2340
3479
  class ValidationException < Struct.new(
2341
3480
  :message)
3481
+ SENSITIVE = []
2342
3482
  include Aws::Structure
2343
3483
  end
2344
3484
 
@@ -2349,7 +3489,12 @@ module Aws::FraudDetector
2349
3489
  # @return [String]
2350
3490
  #
2351
3491
  # @!attribute [rw] data_type
2352
- # The data type of the variable.
3492
+ # The data type of the variable. For more information see [Variable
3493
+ # types][1].
3494
+ #
3495
+ #
3496
+ #
3497
+ # [1]: https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types
2353
3498
  # @return [String]
2354
3499
  #
2355
3500
  # @!attribute [rw] data_source
@@ -2366,6 +3511,16 @@ module Aws::FraudDetector
2366
3511
  #
2367
3512
  # @!attribute [rw] variable_type
2368
3513
  # The variable type of the variable.
3514
+ #
3515
+ # Valid Values: `AUTH_CODE | AVS | BILLING_ADDRESS_L1 |
3516
+ # BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME |
3517
+ # BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL
3518
+ # | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL |
3519
+ # FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE |
3520
+ # PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 |
3521
+ # SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY |
3522
+ # SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP |
3523
+ # USERAGENT | SHIPPING_ZIP | USERAGENT`
2369
3524
  # @return [String]
2370
3525
  #
2371
3526
  # @!attribute [rw] last_updated_time
@@ -2376,6 +3531,10 @@ module Aws::FraudDetector
2376
3531
  # The time when the variable was created.
2377
3532
  # @return [String]
2378
3533
  #
3534
+ # @!attribute [rw] arn
3535
+ # The ARN of the variable.
3536
+ # @return [String]
3537
+ #
2379
3538
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Variable AWS API Documentation
2380
3539
  #
2381
3540
  class Variable < Struct.new(
@@ -2386,11 +3545,14 @@ module Aws::FraudDetector
2386
3545
  :description,
2387
3546
  :variable_type,
2388
3547
  :last_updated_time,
2389
- :created_time)
3548
+ :created_time,
3549
+ :arn)
3550
+ SENSITIVE = []
2390
3551
  include Aws::Structure
2391
3552
  end
2392
3553
 
2393
- # The variable entry in a list.
3554
+ # A variable in the list of variables for the batch create variable
3555
+ # request.
2394
3556
  #
2395
3557
  # @note When making an API call, you may pass VariableEntry
2396
3558
  # data as a hash:
@@ -2405,27 +3567,42 @@ module Aws::FraudDetector
2405
3567
  # }
2406
3568
  #
2407
3569
  # @!attribute [rw] name
2408
- # The name of the variable entry.
3570
+ # The name of the variable.
2409
3571
  # @return [String]
2410
3572
  #
2411
3573
  # @!attribute [rw] data_type
2412
- # The data type of the variable entry.
3574
+ # The data type of the variable.
2413
3575
  # @return [String]
2414
3576
  #
2415
3577
  # @!attribute [rw] data_source
2416
- # The data source of the variable entry.
3578
+ # The data source of the variable.
2417
3579
  # @return [String]
2418
3580
  #
2419
3581
  # @!attribute [rw] default_value
2420
- # The default value of the variable entry.
3582
+ # The default value of the variable.
2421
3583
  # @return [String]
2422
3584
  #
2423
3585
  # @!attribute [rw] description
2424
- # The description of the variable entry.
3586
+ # The description of the variable.
2425
3587
  # @return [String]
2426
3588
  #
2427
3589
  # @!attribute [rw] variable_type
2428
- # The type of the variable entry.
3590
+ # The type of the variable. For more information see [Variable
3591
+ # types][1].
3592
+ #
3593
+ # Valid Values: `AUTH_CODE | AVS | BILLING_ADDRESS_L1 |
3594
+ # BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME |
3595
+ # BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL
3596
+ # | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL |
3597
+ # FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE |
3598
+ # PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 |
3599
+ # SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY |
3600
+ # SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP |
3601
+ # USERAGENT | SHIPPING_ZIP | USERAGENT`
3602
+ #
3603
+ #
3604
+ #
3605
+ # [1]: https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types
2429
3606
  # @return [String]
2430
3607
  #
2431
3608
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/VariableEntry AWS API Documentation
@@ -2437,6 +3614,7 @@ module Aws::FraudDetector
2437
3614
  :default_value,
2438
3615
  :description,
2439
3616
  :variable_type)
3617
+ SENSITIVE = []
2440
3618
  include Aws::Structure
2441
3619
  end
2442
3620