aws-sdk-frauddetector 1.6.0 → 1.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-frauddetector.rb +3 -2
- data/lib/aws-sdk-frauddetector/client.rb +953 -237
- data/lib/aws-sdk-frauddetector/client_api.rb +595 -142
- data/lib/aws-sdk-frauddetector/errors.rb +16 -0
- data/lib/aws-sdk-frauddetector/types.rb +1484 -384
- metadata +2 -2
@@ -27,6 +27,7 @@ module Aws::FraudDetector
|
|
27
27
|
# See {Seahorse::Client::RequestContext} for more information.
|
28
28
|
#
|
29
29
|
# ## Error Classes
|
30
|
+
# * {AccessDeniedException}
|
30
31
|
# * {ConflictException}
|
31
32
|
# * {InternalServerException}
|
32
33
|
# * {ResourceNotFoundException}
|
@@ -39,6 +40,21 @@ module Aws::FraudDetector
|
|
39
40
|
|
40
41
|
extend Aws::Errors::DynamicErrors
|
41
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
|
+
|
42
58
|
class ConflictException < ServiceError
|
43
59
|
|
44
60
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -10,6 +10,21 @@
|
|
10
10
|
module Aws::FraudDetector
|
11
11
|
module Types
|
12
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
|
+
|
13
28
|
# Provides the error of the batch create variable API.
|
14
29
|
#
|
15
30
|
# @!attribute [rw] name
|
@@ -48,16 +63,27 @@ module Aws::FraudDetector
|
|
48
63
|
# variable_type: "string",
|
49
64
|
# },
|
50
65
|
# ],
|
66
|
+
# tags: [
|
67
|
+
# {
|
68
|
+
# key: "tagKey", # required
|
69
|
+
# value: "tagValue", # required
|
70
|
+
# },
|
71
|
+
# ],
|
51
72
|
# }
|
52
73
|
#
|
53
74
|
# @!attribute [rw] variable_entries
|
54
75
|
# The list of variables for the batch create variable request.
|
55
76
|
# @return [Array<Types::VariableEntry>]
|
56
77
|
#
|
78
|
+
# @!attribute [rw] tags
|
79
|
+
# A collection of key and value pairs.
|
80
|
+
# @return [Array<Types::Tag>]
|
81
|
+
#
|
57
82
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/BatchCreateVariableRequest AWS API Documentation
|
58
83
|
#
|
59
84
|
class BatchCreateVariableRequest < Struct.new(
|
60
|
-
:variable_entries
|
85
|
+
:variable_entries,
|
86
|
+
:tags)
|
61
87
|
SENSITIVE = []
|
62
88
|
include Aws::Structure
|
63
89
|
end
|
@@ -145,9 +171,8 @@ module Aws::FraudDetector
|
|
145
171
|
# * DeleteDetectorVersion: A conflict exception will occur if the
|
146
172
|
# `DetectorVersion` status is `ACTIVE`.
|
147
173
|
#
|
148
|
-
# *
|
149
|
-
#
|
150
|
-
# DetectorVersion`.
|
174
|
+
# * DeleteRule: A conflict exception will occur if the `RuleVersion` is
|
175
|
+
# in use by an associated `ACTIVE` or `INACTIVE DetectorVersion`.
|
151
176
|
#
|
152
177
|
# @!attribute [rw] message
|
153
178
|
# @return [String]
|
@@ -171,17 +196,24 @@ module Aws::FraudDetector
|
|
171
196
|
# {
|
172
197
|
# detector_id: "identifier", # required
|
173
198
|
# rule_id: "identifier", # required
|
174
|
-
# rule_version: "
|
199
|
+
# rule_version: "wholeNumberVersionString", # required
|
175
200
|
# },
|
176
201
|
# ],
|
177
202
|
# model_versions: [
|
178
203
|
# {
|
179
|
-
# model_id: "
|
204
|
+
# model_id: "modelIdentifier", # required
|
180
205
|
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
|
181
206
|
# model_version_number: "nonEmptyString", # required
|
207
|
+
# arn: "fraudDetectorArn",
|
182
208
|
# },
|
183
209
|
# ],
|
184
210
|
# rule_execution_mode: "ALL_MATCHED", # accepts ALL_MATCHED, FIRST_MATCHED
|
211
|
+
# tags: [
|
212
|
+
# {
|
213
|
+
# key: "tagKey", # required
|
214
|
+
# value: "tagValue", # required
|
215
|
+
# },
|
216
|
+
# ],
|
185
217
|
# }
|
186
218
|
#
|
187
219
|
# @!attribute [rw] detector_id
|
@@ -223,6 +255,10 @@ module Aws::FraudDetector
|
|
223
255
|
# The default behavior is `FIRST_MATCHED`.
|
224
256
|
# @return [String]
|
225
257
|
#
|
258
|
+
# @!attribute [rw] tags
|
259
|
+
# A collection of key and value pairs.
|
260
|
+
# @return [Array<Types::Tag>]
|
261
|
+
#
|
226
262
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateDetectorVersionRequest AWS API Documentation
|
227
263
|
#
|
228
264
|
class CreateDetectorVersionRequest < Struct.new(
|
@@ -231,7 +267,8 @@ module Aws::FraudDetector
|
|
231
267
|
:external_model_endpoints,
|
232
268
|
:rules,
|
233
269
|
:model_versions,
|
234
|
-
:rule_execution_mode
|
270
|
+
:rule_execution_mode,
|
271
|
+
:tags)
|
235
272
|
SENSITIVE = []
|
236
273
|
include Aws::Structure
|
237
274
|
end
|
@@ -258,13 +295,20 @@ module Aws::FraudDetector
|
|
258
295
|
include Aws::Structure
|
259
296
|
end
|
260
297
|
|
261
|
-
# @note When making an API call, you may pass
|
298
|
+
# @note When making an API call, you may pass CreateModelRequest
|
262
299
|
# data as a hash:
|
263
300
|
#
|
264
301
|
# {
|
265
|
-
# model_id: "
|
302
|
+
# model_id: "modelIdentifier", # required
|
266
303
|
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
|
267
304
|
# description: "description",
|
305
|
+
# event_type_name: "string", # required
|
306
|
+
# tags: [
|
307
|
+
# {
|
308
|
+
# key: "tagKey", # required
|
309
|
+
# value: "tagValue", # required
|
310
|
+
# },
|
311
|
+
# ],
|
268
312
|
# }
|
269
313
|
#
|
270
314
|
# @!attribute [rw] model_id
|
@@ -276,15 +320,94 @@ module Aws::FraudDetector
|
|
276
320
|
# @return [String]
|
277
321
|
#
|
278
322
|
# @!attribute [rw] description
|
279
|
-
# The model
|
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.
|
280
387
|
# @return [String]
|
281
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
|
+
#
|
282
402
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateModelVersionRequest AWS API Documentation
|
283
403
|
#
|
284
404
|
class CreateModelVersionRequest < Struct.new(
|
285
405
|
:model_id,
|
286
406
|
:model_type,
|
287
|
-
:
|
407
|
+
:training_data_source,
|
408
|
+
:training_data_schema,
|
409
|
+
:external_events_detail,
|
410
|
+
:tags)
|
288
411
|
SENSITIVE = []
|
289
412
|
include Aws::Structure
|
290
413
|
end
|
@@ -298,7 +421,7 @@ module Aws::FraudDetector
|
|
298
421
|
# @return [String]
|
299
422
|
#
|
300
423
|
# @!attribute [rw] model_version_number
|
301
|
-
# The version of the model.
|
424
|
+
# The model version number of the model version created.
|
302
425
|
# @return [String]
|
303
426
|
#
|
304
427
|
# @!attribute [rw] status
|
@@ -326,6 +449,12 @@ module Aws::FraudDetector
|
|
326
449
|
# expression: "ruleExpression", # required
|
327
450
|
# language: "DETECTORPL", # required, accepts DETECTORPL
|
328
451
|
# outcomes: ["string"], # required
|
452
|
+
# tags: [
|
453
|
+
# {
|
454
|
+
# key: "tagKey", # required
|
455
|
+
# value: "tagValue", # required
|
456
|
+
# },
|
457
|
+
# ],
|
329
458
|
# }
|
330
459
|
#
|
331
460
|
# @!attribute [rw] rule_id
|
@@ -352,6 +481,10 @@ module Aws::FraudDetector
|
|
352
481
|
# The outcome or outcomes returned when the rule expression matches.
|
353
482
|
# @return [Array<String>]
|
354
483
|
#
|
484
|
+
# @!attribute [rw] tags
|
485
|
+
# A collection of key and value pairs.
|
486
|
+
# @return [Array<Types::Tag>]
|
487
|
+
#
|
355
488
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateRuleRequest AWS API Documentation
|
356
489
|
#
|
357
490
|
class CreateRuleRequest < Struct.new(
|
@@ -360,8 +493,9 @@ module Aws::FraudDetector
|
|
360
493
|
:description,
|
361
494
|
:expression,
|
362
495
|
:language,
|
363
|
-
:outcomes
|
364
|
-
|
496
|
+
:outcomes,
|
497
|
+
:tags)
|
498
|
+
SENSITIVE = [:expression]
|
365
499
|
include Aws::Structure
|
366
500
|
end
|
367
501
|
|
@@ -387,6 +521,12 @@ module Aws::FraudDetector
|
|
387
521
|
# default_value: "string", # required
|
388
522
|
# description: "string",
|
389
523
|
# variable_type: "string",
|
524
|
+
# tags: [
|
525
|
+
# {
|
526
|
+
# key: "tagKey", # required
|
527
|
+
# value: "tagValue", # required
|
528
|
+
# },
|
529
|
+
# ],
|
390
530
|
# }
|
391
531
|
#
|
392
532
|
# @!attribute [rw] name
|
@@ -410,9 +550,27 @@ module Aws::FraudDetector
|
|
410
550
|
# @return [String]
|
411
551
|
#
|
412
552
|
# @!attribute [rw] variable_type
|
413
|
-
# 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
|
414
568
|
# @return [String]
|
415
569
|
#
|
570
|
+
# @!attribute [rw] tags
|
571
|
+
# A collection of key and value pairs.
|
572
|
+
# @return [Array<Types::Tag>]
|
573
|
+
#
|
416
574
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateVariableRequest AWS API Documentation
|
417
575
|
#
|
418
576
|
class CreateVariableRequest < Struct.new(
|
@@ -421,7 +579,8 @@ module Aws::FraudDetector
|
|
421
579
|
:data_source,
|
422
580
|
:default_value,
|
423
581
|
:description,
|
424
|
-
:variable_type
|
582
|
+
:variable_type,
|
583
|
+
:tags)
|
425
584
|
SENSITIVE = []
|
426
585
|
include Aws::Structure
|
427
586
|
end
|
@@ -430,6 +589,25 @@ module Aws::FraudDetector
|
|
430
589
|
#
|
431
590
|
class CreateVariableResult < Aws::EmptyStructure; end
|
432
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
|
+
|
433
611
|
# @note When making an API call, you may pass DeleteDetectorRequest
|
434
612
|
# data as a hash:
|
435
613
|
#
|
@@ -458,7 +636,7 @@ module Aws::FraudDetector
|
|
458
636
|
#
|
459
637
|
# {
|
460
638
|
# detector_id: "identifier", # required
|
461
|
-
# detector_version_id: "
|
639
|
+
# detector_version_id: "wholeNumberVersionString", # required
|
462
640
|
# }
|
463
641
|
#
|
464
642
|
# @!attribute [rw] detector_id
|
@@ -487,16 +665,22 @@ module Aws::FraudDetector
|
|
487
665
|
#
|
488
666
|
# {
|
489
667
|
# event_id: "string", # required
|
668
|
+
# event_type_name: "string", # required
|
490
669
|
# }
|
491
670
|
#
|
492
671
|
# @!attribute [rw] event_id
|
493
672
|
# The ID of the event to delete.
|
494
673
|
# @return [String]
|
495
674
|
#
|
675
|
+
# @!attribute [rw] event_type_name
|
676
|
+
# The name of the event type.
|
677
|
+
# @return [String]
|
678
|
+
#
|
496
679
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteEventRequest AWS API Documentation
|
497
680
|
#
|
498
681
|
class DeleteEventRequest < Struct.new(
|
499
|
-
:event_id
|
682
|
+
:event_id,
|
683
|
+
:event_type_name)
|
500
684
|
SENSITIVE = []
|
501
685
|
include Aws::Structure
|
502
686
|
end
|
@@ -505,40 +689,32 @@ module Aws::FraudDetector
|
|
505
689
|
#
|
506
690
|
class DeleteEventResult < Aws::EmptyStructure; end
|
507
691
|
|
508
|
-
# @note When making an API call, you may pass
|
692
|
+
# @note When making an API call, you may pass DeleteRuleRequest
|
509
693
|
# data as a hash:
|
510
694
|
#
|
511
695
|
# {
|
512
|
-
#
|
513
|
-
#
|
514
|
-
#
|
696
|
+
# rule: { # required
|
697
|
+
# detector_id: "identifier", # required
|
698
|
+
# rule_id: "identifier", # required
|
699
|
+
# rule_version: "wholeNumberVersionString", # required
|
700
|
+
# },
|
515
701
|
# }
|
516
702
|
#
|
517
|
-
# @!attribute [rw]
|
518
|
-
#
|
519
|
-
# @return [
|
520
|
-
#
|
521
|
-
# @!attribute [rw] rule_id
|
522
|
-
# The rule ID of the rule version to delete.
|
523
|
-
# @return [String]
|
524
|
-
#
|
525
|
-
# @!attribute [rw] rule_version
|
526
|
-
# The rule version to delete.
|
527
|
-
# @return [String]
|
703
|
+
# @!attribute [rw] rule
|
704
|
+
# A rule.
|
705
|
+
# @return [Types::Rule]
|
528
706
|
#
|
529
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/
|
707
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteRuleRequest AWS API Documentation
|
530
708
|
#
|
531
|
-
class
|
532
|
-
:
|
533
|
-
:rule_id,
|
534
|
-
:rule_version)
|
709
|
+
class DeleteRuleRequest < Struct.new(
|
710
|
+
:rule)
|
535
711
|
SENSITIVE = []
|
536
712
|
include Aws::Structure
|
537
713
|
end
|
538
714
|
|
539
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/
|
715
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteRuleResult AWS API Documentation
|
540
716
|
#
|
541
|
-
class
|
717
|
+
class DeleteRuleResult < Aws::EmptyStructure; end
|
542
718
|
|
543
719
|
# @note When making an API call, you may pass DescribeDetectorRequest
|
544
720
|
# data as a hash:
|
@@ -583,12 +759,17 @@ module Aws::FraudDetector
|
|
583
759
|
# The next token to be used for subsequent requests.
|
584
760
|
# @return [String]
|
585
761
|
#
|
762
|
+
# @!attribute [rw] arn
|
763
|
+
# The detector ARN.
|
764
|
+
# @return [String]
|
765
|
+
#
|
586
766
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DescribeDetectorResult AWS API Documentation
|
587
767
|
#
|
588
768
|
class DescribeDetectorResult < Struct.new(
|
589
769
|
:detector_id,
|
590
770
|
:detector_version_summaries,
|
591
|
-
:next_token
|
771
|
+
:next_token,
|
772
|
+
:arn)
|
592
773
|
SENSITIVE = []
|
593
774
|
include Aws::Structure
|
594
775
|
end
|
@@ -597,8 +778,8 @@ module Aws::FraudDetector
|
|
597
778
|
# data as a hash:
|
598
779
|
#
|
599
780
|
# {
|
600
|
-
# model_id: "
|
601
|
-
# model_version_number: "
|
781
|
+
# model_id: "modelIdentifier",
|
782
|
+
# model_version_number: "floatVersionString",
|
602
783
|
# model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
|
603
784
|
# next_token: "string",
|
604
785
|
# max_results: 1,
|
@@ -609,7 +790,7 @@ module Aws::FraudDetector
|
|
609
790
|
# @return [String]
|
610
791
|
#
|
611
792
|
# @!attribute [rw] model_version_number
|
612
|
-
# The model version.
|
793
|
+
# The model version number.
|
613
794
|
# @return [String]
|
614
795
|
#
|
615
796
|
# @!attribute [rw] model_type
|
@@ -663,6 +844,10 @@ module Aws::FraudDetector
|
|
663
844
|
# The detector description.
|
664
845
|
# @return [String]
|
665
846
|
#
|
847
|
+
# @!attribute [rw] event_type_name
|
848
|
+
# The name of the event type.
|
849
|
+
# @return [String]
|
850
|
+
#
|
666
851
|
# @!attribute [rw] last_updated_time
|
667
852
|
# Timestamp of when the detector was last updated.
|
668
853
|
# @return [String]
|
@@ -671,13 +856,19 @@ module Aws::FraudDetector
|
|
671
856
|
# Timestamp of when the detector was created.
|
672
857
|
# @return [String]
|
673
858
|
#
|
859
|
+
# @!attribute [rw] arn
|
860
|
+
# The detector ARN.
|
861
|
+
# @return [String]
|
862
|
+
#
|
674
863
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Detector AWS API Documentation
|
675
864
|
#
|
676
865
|
class Detector < Struct.new(
|
677
866
|
:detector_id,
|
678
867
|
:description,
|
868
|
+
:event_type_name,
|
679
869
|
:last_updated_time,
|
680
|
-
:created_time
|
870
|
+
:created_time,
|
871
|
+
:arn)
|
681
872
|
SENSITIVE = []
|
682
873
|
include Aws::Structure
|
683
874
|
end
|
@@ -711,6 +902,145 @@ module Aws::FraudDetector
|
|
711
902
|
include Aws::Structure
|
712
903
|
end
|
713
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 = []
|
1041
|
+
include Aws::Structure
|
1042
|
+
end
|
1043
|
+
|
714
1044
|
# The Amazon SageMaker model.
|
715
1045
|
#
|
716
1046
|
# @!attribute [rw] model_endpoint
|
@@ -721,9 +1051,9 @@ module Aws::FraudDetector
|
|
721
1051
|
# The source of the model.
|
722
1052
|
# @return [String]
|
723
1053
|
#
|
724
|
-
# @!attribute [rw]
|
1054
|
+
# @!attribute [rw] invoke_model_endpoint_role_arn
|
725
1055
|
# The role used to invoke the model.
|
726
|
-
# @return [
|
1056
|
+
# @return [String]
|
727
1057
|
#
|
728
1058
|
# @!attribute [rw] input_configuration
|
729
1059
|
# The input configuration.
|
@@ -745,17 +1075,80 @@ module Aws::FraudDetector
|
|
745
1075
|
# Timestamp of when the model was last created.
|
746
1076
|
# @return [String]
|
747
1077
|
#
|
1078
|
+
# @!attribute [rw] arn
|
1079
|
+
# The model ARN.
|
1080
|
+
# @return [String]
|
1081
|
+
#
|
748
1082
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ExternalModel AWS API Documentation
|
749
1083
|
#
|
750
1084
|
class ExternalModel < Struct.new(
|
751
1085
|
:model_endpoint,
|
752
1086
|
:model_source,
|
753
|
-
:
|
1087
|
+
:invoke_model_endpoint_role_arn,
|
754
1088
|
:input_configuration,
|
755
1089
|
:output_configuration,
|
756
1090
|
:model_endpoint_status,
|
757
1091
|
:last_updated_time,
|
758
|
-
: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)
|
759
1152
|
SENSITIVE = []
|
760
1153
|
include Aws::Structure
|
761
1154
|
end
|
@@ -765,7 +1158,7 @@ module Aws::FraudDetector
|
|
765
1158
|
#
|
766
1159
|
# {
|
767
1160
|
# detector_id: "identifier", # required
|
768
|
-
# detector_version_id: "
|
1161
|
+
# detector_version_id: "wholeNumberVersionString", # required
|
769
1162
|
# }
|
770
1163
|
#
|
771
1164
|
# @!attribute [rw] detector_id
|
@@ -836,8 +1229,12 @@ module Aws::FraudDetector
|
|
836
1229
|
# draft status.
|
837
1230
|
# @return [String]
|
838
1231
|
#
|
839
|
-
#
|
840
|
-
#
|
1232
|
+
# @!attribute [rw] arn
|
1233
|
+
# The detector version ARN.
|
1234
|
+
# @return [String]
|
1235
|
+
#
|
1236
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetDetectorVersionResult AWS API Documentation
|
1237
|
+
#
|
841
1238
|
class GetDetectorVersionResult < Struct.new(
|
842
1239
|
:detector_id,
|
843
1240
|
:detector_version_id,
|
@@ -848,7 +1245,8 @@ module Aws::FraudDetector
|
|
848
1245
|
:status,
|
849
1246
|
:last_updated_time,
|
850
1247
|
:created_time,
|
851
|
-
:rule_execution_mode
|
1248
|
+
:rule_execution_mode,
|
1249
|
+
:arn)
|
852
1250
|
SENSITIVE = []
|
853
1251
|
include Aws::Structure
|
854
1252
|
end
|
@@ -901,6 +1299,202 @@ module Aws::FraudDetector
|
|
901
1299
|
include Aws::Structure
|
902
1300
|
end
|
903
1301
|
|
1302
|
+
# @note When making an API call, you may pass GetEntityTypesRequest
|
1303
|
+
# data as a hash:
|
1304
|
+
#
|
1305
|
+
# {
|
1306
|
+
# name: "identifier",
|
1307
|
+
# next_token: "string",
|
1308
|
+
# max_results: 1,
|
1309
|
+
# }
|
1310
|
+
#
|
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
|
+
|
904
1498
|
# @note When making an API call, you may pass GetExternalModelsRequest
|
905
1499
|
# data as a hash:
|
906
1500
|
#
|
@@ -949,13 +1543,73 @@ module Aws::FraudDetector
|
|
949
1543
|
include Aws::Structure
|
950
1544
|
end
|
951
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 = []
|
1603
|
+
include Aws::Structure
|
1604
|
+
end
|
1605
|
+
|
952
1606
|
# @note When making an API call, you may pass GetModelVersionRequest
|
953
1607
|
# data as a hash:
|
954
1608
|
#
|
955
1609
|
# {
|
956
|
-
# model_id: "
|
1610
|
+
# model_id: "modelIdentifier", # required
|
957
1611
|
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
|
958
|
-
# model_version_number: "
|
1612
|
+
# model_version_number: "floatVersionString", # required
|
959
1613
|
# }
|
960
1614
|
#
|
961
1615
|
# @!attribute [rw] model_id
|
@@ -967,7 +1621,7 @@ module Aws::FraudDetector
|
|
967
1621
|
# @return [String]
|
968
1622
|
#
|
969
1623
|
# @!attribute [rw] model_version_number
|
970
|
-
# The model version.
|
1624
|
+
# The model version number.
|
971
1625
|
# @return [String]
|
972
1626
|
#
|
973
1627
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModelVersionRequest AWS API Documentation
|
@@ -989,25 +1643,40 @@ module Aws::FraudDetector
|
|
989
1643
|
# @return [String]
|
990
1644
|
#
|
991
1645
|
# @!attribute [rw] model_version_number
|
992
|
-
# The model version.
|
1646
|
+
# The model version number.
|
993
1647
|
# @return [String]
|
994
1648
|
#
|
995
|
-
# @!attribute [rw]
|
996
|
-
# The
|
1649
|
+
# @!attribute [rw] training_data_source
|
1650
|
+
# The training data source.
|
997
1651
|
# @return [String]
|
998
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
|
+
#
|
999
1661
|
# @!attribute [rw] status
|
1000
1662
|
# The model version status.
|
1001
1663
|
# @return [String]
|
1002
1664
|
#
|
1665
|
+
# @!attribute [rw] arn
|
1666
|
+
# The model version ARN.
|
1667
|
+
# @return [String]
|
1668
|
+
#
|
1003
1669
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModelVersionResult AWS API Documentation
|
1004
1670
|
#
|
1005
1671
|
class GetModelVersionResult < Struct.new(
|
1006
1672
|
:model_id,
|
1007
1673
|
:model_type,
|
1008
1674
|
:model_version_number,
|
1009
|
-
:
|
1010
|
-
:
|
1675
|
+
:training_data_source,
|
1676
|
+
:training_data_schema,
|
1677
|
+
:external_events_detail,
|
1678
|
+
:status,
|
1679
|
+
:arn)
|
1011
1680
|
SENSITIVE = []
|
1012
1681
|
include Aws::Structure
|
1013
1682
|
end
|
@@ -1016,33 +1685,33 @@ module Aws::FraudDetector
|
|
1016
1685
|
# data as a hash:
|
1017
1686
|
#
|
1018
1687
|
# {
|
1688
|
+
# model_id: "modelIdentifier",
|
1019
1689
|
# model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
|
1020
|
-
# model_id: "identifier",
|
1021
1690
|
# next_token: "string",
|
1022
1691
|
# max_results: 1,
|
1023
1692
|
# }
|
1024
1693
|
#
|
1025
|
-
# @!attribute [rw] model_type
|
1026
|
-
# The model type.
|
1027
|
-
# @return [String]
|
1028
|
-
#
|
1029
1694
|
# @!attribute [rw] model_id
|
1030
1695
|
# The model ID.
|
1031
1696
|
# @return [String]
|
1032
1697
|
#
|
1698
|
+
# @!attribute [rw] model_type
|
1699
|
+
# The model type.
|
1700
|
+
# @return [String]
|
1701
|
+
#
|
1033
1702
|
# @!attribute [rw] next_token
|
1034
|
-
# The next token for the request.
|
1703
|
+
# The next token for the subsequent request.
|
1035
1704
|
# @return [String]
|
1036
1705
|
#
|
1037
1706
|
# @!attribute [rw] max_results
|
1038
|
-
# The maximum
|
1707
|
+
# The maximum number of objects to return for the request.
|
1039
1708
|
# @return [Integer]
|
1040
1709
|
#
|
1041
1710
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModelsRequest AWS API Documentation
|
1042
1711
|
#
|
1043
1712
|
class GetModelsRequest < Struct.new(
|
1044
|
-
:model_type,
|
1045
1713
|
:model_id,
|
1714
|
+
:model_type,
|
1046
1715
|
:next_token,
|
1047
1716
|
:max_results)
|
1048
1717
|
SENSITIVE = []
|
@@ -1050,11 +1719,11 @@ module Aws::FraudDetector
|
|
1050
1719
|
end
|
1051
1720
|
|
1052
1721
|
# @!attribute [rw] next_token
|
1053
|
-
# The next token
|
1722
|
+
# The next page token to be used in subsequent requests.
|
1054
1723
|
# @return [String]
|
1055
1724
|
#
|
1056
1725
|
# @!attribute [rw] models
|
1057
|
-
# The
|
1726
|
+
# The array of models.
|
1058
1727
|
# @return [Array<Types::Model>]
|
1059
1728
|
#
|
1060
1729
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModelsResult AWS API Documentation
|
@@ -1099,91 +1768,17 @@ module Aws::FraudDetector
|
|
1099
1768
|
|
1100
1769
|
# @!attribute [rw] outcomes
|
1101
1770
|
# The outcomes.
|
1102
|
-
# @return [Array<Types::Outcome>]
|
1103
|
-
#
|
1104
|
-
# @!attribute [rw] next_token
|
1105
|
-
# The next page token for subsequent requests.
|
1106
|
-
# @return [String]
|
1107
|
-
#
|
1108
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetOutcomesResult AWS API Documentation
|
1109
|
-
#
|
1110
|
-
class GetOutcomesResult < Struct.new(
|
1111
|
-
:outcomes,
|
1112
|
-
:next_token)
|
1113
|
-
SENSITIVE = []
|
1114
|
-
include Aws::Structure
|
1115
|
-
end
|
1116
|
-
|
1117
|
-
# @note When making an API call, you may pass GetPredictionRequest
|
1118
|
-
# data as a hash:
|
1119
|
-
#
|
1120
|
-
# {
|
1121
|
-
# detector_id: "string", # required
|
1122
|
-
# detector_version_id: "string",
|
1123
|
-
# event_id: "string", # required
|
1124
|
-
# event_attributes: {
|
1125
|
-
# "attributeKey" => "attributeValue",
|
1126
|
-
# },
|
1127
|
-
# external_model_endpoint_data_blobs: {
|
1128
|
-
# "string" => {
|
1129
|
-
# byte_buffer: "data",
|
1130
|
-
# content_type: "contentType",
|
1131
|
-
# },
|
1132
|
-
# },
|
1133
|
-
# }
|
1134
|
-
#
|
1135
|
-
# @!attribute [rw] detector_id
|
1136
|
-
# The detector ID.
|
1137
|
-
# @return [String]
|
1138
|
-
#
|
1139
|
-
# @!attribute [rw] detector_version_id
|
1140
|
-
# The detector version ID.
|
1141
|
-
# @return [String]
|
1142
|
-
#
|
1143
|
-
# @!attribute [rw] event_id
|
1144
|
-
# The unique ID used to identify the event.
|
1145
|
-
# @return [String]
|
1146
|
-
#
|
1147
|
-
# @!attribute [rw] event_attributes
|
1148
|
-
# Names of variables you defined in Amazon Fraud Detector to represent
|
1149
|
-
# event data elements and their corresponding values for the event you
|
1150
|
-
# are sending for evaluation.
|
1151
|
-
# @return [Hash<String,String>]
|
1152
|
-
#
|
1153
|
-
# @!attribute [rw] external_model_endpoint_data_blobs
|
1154
|
-
# The Amazon SageMaker model endpoint input data blobs.
|
1155
|
-
# @return [Hash<String,Types::ModelEndpointDataBlob>]
|
1156
|
-
#
|
1157
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetPredictionRequest AWS API Documentation
|
1158
|
-
#
|
1159
|
-
class GetPredictionRequest < Struct.new(
|
1160
|
-
:detector_id,
|
1161
|
-
:detector_version_id,
|
1162
|
-
:event_id,
|
1163
|
-
:event_attributes,
|
1164
|
-
:external_model_endpoint_data_blobs)
|
1165
|
-
SENSITIVE = [:external_model_endpoint_data_blobs]
|
1166
|
-
include Aws::Structure
|
1167
|
-
end
|
1168
|
-
|
1169
|
-
# @!attribute [rw] outcomes
|
1170
|
-
# The prediction outcomes.
|
1171
|
-
# @return [Array<String>]
|
1172
|
-
#
|
1173
|
-
# @!attribute [rw] model_scores
|
1174
|
-
# The model scores for models used in the detector version.
|
1175
|
-
# @return [Array<Types::ModelScores>]
|
1771
|
+
# @return [Array<Types::Outcome>]
|
1176
1772
|
#
|
1177
|
-
# @!attribute [rw]
|
1178
|
-
# The
|
1179
|
-
# @return [
|
1773
|
+
# @!attribute [rw] next_token
|
1774
|
+
# The next page token for subsequent requests.
|
1775
|
+
# @return [String]
|
1180
1776
|
#
|
1181
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/
|
1777
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetOutcomesResult AWS API Documentation
|
1182
1778
|
#
|
1183
|
-
class
|
1779
|
+
class GetOutcomesResult < Struct.new(
|
1184
1780
|
:outcomes,
|
1185
|
-
:
|
1186
|
-
:rule_results)
|
1781
|
+
:next_token)
|
1187
1782
|
SENSITIVE = []
|
1188
1783
|
include Aws::Structure
|
1189
1784
|
end
|
@@ -1194,7 +1789,7 @@ module Aws::FraudDetector
|
|
1194
1789
|
# {
|
1195
1790
|
# rule_id: "identifier",
|
1196
1791
|
# detector_id: "identifier", # required
|
1197
|
-
# rule_version: "
|
1792
|
+
# rule_version: "wholeNumberVersionString",
|
1198
1793
|
# next_token: "string",
|
1199
1794
|
# max_results: 1,
|
1200
1795
|
# }
|
@@ -1309,42 +1904,167 @@ module Aws::FraudDetector
|
|
1309
1904
|
include Aws::Structure
|
1310
1905
|
end
|
1311
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 = []
|
1952
|
+
include Aws::Structure
|
1953
|
+
end
|
1954
|
+
|
1312
1955
|
# The label schema.
|
1313
1956
|
#
|
1314
1957
|
# @note When making an API call, you may pass LabelSchema
|
1315
1958
|
# data as a hash:
|
1316
1959
|
#
|
1317
1960
|
# {
|
1318
|
-
# label_key: "string", # required
|
1319
1961
|
# label_mapper: { # required
|
1320
1962
|
# "string" => ["string"],
|
1321
1963
|
# },
|
1322
1964
|
# }
|
1323
1965
|
#
|
1324
|
-
# @!attribute [rw] label_key
|
1325
|
-
# The label key.
|
1326
|
-
# @return [String]
|
1327
|
-
#
|
1328
1966
|
# @!attribute [rw] label_mapper
|
1329
|
-
# The label mapper maps the Amazon Fraud Detector supported
|
1330
|
-
#
|
1331
|
-
# `"LEGIT"
|
1332
|
-
# could be: `\{"FRAUD" =>
|
1333
|
-
#
|
1334
|
-
# ["
|
1335
|
-
# of the mapper is a list,
|
1336
|
-
#
|
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.
|
1337
1976
|
# @return [Hash<String,Array<String>>]
|
1338
1977
|
#
|
1339
1978
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/LabelSchema AWS API Documentation
|
1340
1979
|
#
|
1341
1980
|
class LabelSchema < Struct.new(
|
1342
|
-
:label_key,
|
1343
1981
|
:label_mapper)
|
1344
1982
|
SENSITIVE = []
|
1345
1983
|
include Aws::Structure
|
1346
1984
|
end
|
1347
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 = []
|
2065
|
+
include Aws::Structure
|
2066
|
+
end
|
2067
|
+
|
1348
2068
|
# The model.
|
1349
2069
|
#
|
1350
2070
|
# @!attribute [rw] model_id
|
@@ -1359,24 +2079,20 @@ module Aws::FraudDetector
|
|
1359
2079
|
# The model description.
|
1360
2080
|
# @return [String]
|
1361
2081
|
#
|
1362
|
-
# @!attribute [rw]
|
1363
|
-
# The
|
1364
|
-
# @return [
|
1365
|
-
#
|
1366
|
-
# @!attribute [rw] model_variables
|
1367
|
-
# The model input variables.
|
1368
|
-
# @return [Array<Types::ModelVariable>]
|
2082
|
+
# @!attribute [rw] event_type_name
|
2083
|
+
# The name of the event type.
|
2084
|
+
# @return [String]
|
1369
2085
|
#
|
1370
|
-
# @!attribute [rw]
|
1371
|
-
#
|
1372
|
-
# @return [
|
2086
|
+
# @!attribute [rw] created_time
|
2087
|
+
# Timestamp of when the model was created.
|
2088
|
+
# @return [String]
|
1373
2089
|
#
|
1374
2090
|
# @!attribute [rw] last_updated_time
|
1375
2091
|
# Timestamp of last time the model was updated.
|
1376
2092
|
# @return [String]
|
1377
2093
|
#
|
1378
|
-
# @!attribute [rw]
|
1379
|
-
#
|
2094
|
+
# @!attribute [rw] arn
|
2095
|
+
# The ARN of the model.
|
1380
2096
|
# @return [String]
|
1381
2097
|
#
|
1382
2098
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Model AWS API Documentation
|
@@ -1385,11 +2101,10 @@ module Aws::FraudDetector
|
|
1385
2101
|
:model_id,
|
1386
2102
|
:model_type,
|
1387
2103
|
:description,
|
1388
|
-
:
|
1389
|
-
:
|
1390
|
-
:label_schema,
|
2104
|
+
:event_type_name,
|
2105
|
+
:created_time,
|
1391
2106
|
:last_updated_time,
|
1392
|
-
:
|
2107
|
+
:arn)
|
1393
2108
|
SENSITIVE = []
|
1394
2109
|
include Aws::Structure
|
1395
2110
|
end
|
@@ -1425,30 +2140,31 @@ module Aws::FraudDetector
|
|
1425
2140
|
include Aws::Structure
|
1426
2141
|
end
|
1427
2142
|
|
1428
|
-
# The model input configuration.
|
2143
|
+
# The Amazon SageMaker model input configuration.
|
1429
2144
|
#
|
1430
2145
|
# @note When making an API call, you may pass ModelInputConfiguration
|
1431
2146
|
# data as a hash:
|
1432
2147
|
#
|
1433
2148
|
# {
|
2149
|
+
# event_type_name: "identifier",
|
1434
2150
|
# format: "TEXT_CSV", # accepts TEXT_CSV, APPLICATION_JSON
|
1435
|
-
#
|
2151
|
+
# use_event_variables: false, # required
|
1436
2152
|
# json_input_template: "string",
|
1437
2153
|
# csv_input_template: "string",
|
1438
2154
|
# }
|
1439
2155
|
#
|
2156
|
+
# @!attribute [rw] event_type_name
|
2157
|
+
# The event type name.
|
2158
|
+
# @return [String]
|
2159
|
+
#
|
1440
2160
|
# @!attribute [rw] format
|
1441
2161
|
# The format of the model input configuration. The format differs
|
1442
2162
|
# depending on if it is passed through to SageMaker or constructed by
|
1443
2163
|
# Amazon Fraud Detector.
|
1444
2164
|
# @return [String]
|
1445
2165
|
#
|
1446
|
-
# @!attribute [rw]
|
1447
|
-
#
|
1448
|
-
# blob provided in the getPrediction request, and will be passed to
|
1449
|
-
# SageMaker as-is. For non-opaque models, the input will be
|
1450
|
-
# constructed by Amazon Fraud Detector based on the
|
1451
|
-
# model-configuration.
|
2166
|
+
# @!attribute [rw] use_event_variables
|
2167
|
+
# The event variables.
|
1452
2168
|
# @return [Boolean]
|
1453
2169
|
#
|
1454
2170
|
# @!attribute [rw] json_input_template
|
@@ -1468,15 +2184,16 @@ module Aws::FraudDetector
|
|
1468
2184
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ModelInputConfiguration AWS API Documentation
|
1469
2185
|
#
|
1470
2186
|
class ModelInputConfiguration < Struct.new(
|
2187
|
+
:event_type_name,
|
1471
2188
|
:format,
|
1472
|
-
:
|
2189
|
+
:use_event_variables,
|
1473
2190
|
:json_input_template,
|
1474
2191
|
:csv_input_template)
|
1475
2192
|
SENSITIVE = []
|
1476
2193
|
include Aws::Structure
|
1477
2194
|
end
|
1478
2195
|
|
1479
|
-
# Provides the model output configuration.
|
2196
|
+
# Provides the Amazon Sagemaker model output configuration.
|
1480
2197
|
#
|
1481
2198
|
# @note When making an API call, you may pass ModelOutputConfiguration
|
1482
2199
|
# data as a hash:
|
@@ -1534,46 +2251,20 @@ module Aws::FraudDetector
|
|
1534
2251
|
include Aws::Structure
|
1535
2252
|
end
|
1536
2253
|
|
1537
|
-
# The model variable.>
|
1538
|
-
#
|
1539
|
-
# @note When making an API call, you may pass ModelVariable
|
1540
|
-
# data as a hash:
|
1541
|
-
#
|
1542
|
-
# {
|
1543
|
-
# name: "string", # required
|
1544
|
-
# index: 1,
|
1545
|
-
# }
|
1546
|
-
#
|
1547
|
-
# @!attribute [rw] name
|
1548
|
-
# The model variable's name.>
|
1549
|
-
# @return [String]
|
1550
|
-
#
|
1551
|
-
# @!attribute [rw] index
|
1552
|
-
# The model variable's index.>
|
1553
|
-
# @return [Integer]
|
1554
|
-
#
|
1555
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ModelVariable AWS API Documentation
|
1556
|
-
#
|
1557
|
-
class ModelVariable < Struct.new(
|
1558
|
-
:name,
|
1559
|
-
:index)
|
1560
|
-
SENSITIVE = []
|
1561
|
-
include Aws::Structure
|
1562
|
-
end
|
1563
|
-
|
1564
2254
|
# The model version.
|
1565
2255
|
#
|
1566
2256
|
# @note When making an API call, you may pass ModelVersion
|
1567
2257
|
# data as a hash:
|
1568
2258
|
#
|
1569
2259
|
# {
|
1570
|
-
# model_id: "
|
2260
|
+
# model_id: "modelIdentifier", # required
|
1571
2261
|
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
|
1572
2262
|
# model_version_number: "nonEmptyString", # required
|
2263
|
+
# arn: "fraudDetectorArn",
|
1573
2264
|
# }
|
1574
2265
|
#
|
1575
2266
|
# @!attribute [rw] model_id
|
1576
|
-
# The
|
2267
|
+
# The model ID.
|
1577
2268
|
# @return [String]
|
1578
2269
|
#
|
1579
2270
|
# @!attribute [rw] model_type
|
@@ -1581,7 +2272,11 @@ module Aws::FraudDetector
|
|
1581
2272
|
# @return [String]
|
1582
2273
|
#
|
1583
2274
|
# @!attribute [rw] model_version_number
|
1584
|
-
# The model version.
|
2275
|
+
# The model version number.
|
2276
|
+
# @return [String]
|
2277
|
+
#
|
2278
|
+
# @!attribute [rw] arn
|
2279
|
+
# The model version ARN.
|
1585
2280
|
# @return [String]
|
1586
2281
|
#
|
1587
2282
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ModelVersion AWS API Documentation
|
@@ -1589,12 +2284,13 @@ module Aws::FraudDetector
|
|
1589
2284
|
class ModelVersion < Struct.new(
|
1590
2285
|
:model_id,
|
1591
2286
|
:model_type,
|
1592
|
-
:model_version_number
|
2287
|
+
:model_version_number,
|
2288
|
+
:arn)
|
1593
2289
|
SENSITIVE = []
|
1594
2290
|
include Aws::Structure
|
1595
2291
|
end
|
1596
2292
|
|
1597
|
-
#
|
2293
|
+
# The details of the model version.
|
1598
2294
|
#
|
1599
2295
|
# @!attribute [rw] model_id
|
1600
2296
|
# The model ID.
|
@@ -1605,36 +2301,28 @@ module Aws::FraudDetector
|
|
1605
2301
|
# @return [String]
|
1606
2302
|
#
|
1607
2303
|
# @!attribute [rw] model_version_number
|
1608
|
-
# The model version.
|
1609
|
-
# @return [String]
|
1610
|
-
#
|
1611
|
-
# @!attribute [rw] description
|
1612
|
-
# The model description.
|
2304
|
+
# The model version number.
|
1613
2305
|
# @return [String]
|
1614
2306
|
#
|
1615
2307
|
# @!attribute [rw] status
|
1616
|
-
# The model
|
2308
|
+
# The status of the model version.
|
1617
2309
|
# @return [String]
|
1618
2310
|
#
|
1619
2311
|
# @!attribute [rw] training_data_source
|
1620
|
-
# The model training data source.
|
1621
|
-
# @return [
|
1622
|
-
#
|
1623
|
-
# @!attribute [rw] model_variables
|
1624
|
-
# The model variables.
|
1625
|
-
# @return [Array<Types::ModelVariable>]
|
2312
|
+
# The model version training data source.
|
2313
|
+
# @return [String]
|
1626
2314
|
#
|
1627
|
-
# @!attribute [rw]
|
1628
|
-
# The
|
1629
|
-
# @return [Types::
|
2315
|
+
# @!attribute [rw] training_data_schema
|
2316
|
+
# The training data schema.
|
2317
|
+
# @return [Types::TrainingDataSchema]
|
1630
2318
|
#
|
1631
|
-
# @!attribute [rw]
|
1632
|
-
# The
|
1633
|
-
# @return [
|
2319
|
+
# @!attribute [rw] external_events_detail
|
2320
|
+
# The event details.
|
2321
|
+
# @return [Types::ExternalEventsDetail]
|
1634
2322
|
#
|
1635
|
-
# @!attribute [rw]
|
1636
|
-
# The
|
1637
|
-
# @return [
|
2323
|
+
# @!attribute [rw] training_result
|
2324
|
+
# The training results.
|
2325
|
+
# @return [Types::TrainingResult]
|
1638
2326
|
#
|
1639
2327
|
# @!attribute [rw] last_updated_time
|
1640
2328
|
# The timestamp when the model was last updated.
|
@@ -1644,21 +2332,24 @@ module Aws::FraudDetector
|
|
1644
2332
|
# The timestamp when the model was created.
|
1645
2333
|
# @return [String]
|
1646
2334
|
#
|
2335
|
+
# @!attribute [rw] arn
|
2336
|
+
# The model version ARN.
|
2337
|
+
# @return [String]
|
2338
|
+
#
|
1647
2339
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ModelVersionDetail AWS API Documentation
|
1648
2340
|
#
|
1649
2341
|
class ModelVersionDetail < Struct.new(
|
1650
2342
|
:model_id,
|
1651
2343
|
:model_type,
|
1652
2344
|
:model_version_number,
|
1653
|
-
:description,
|
1654
2345
|
:status,
|
1655
2346
|
:training_data_source,
|
1656
|
-
:
|
1657
|
-
:
|
1658
|
-
:
|
1659
|
-
:training_metrics,
|
2347
|
+
:training_data_schema,
|
2348
|
+
:external_events_detail,
|
2349
|
+
:training_result,
|
1660
2350
|
:last_updated_time,
|
1661
|
-
:created_time
|
2351
|
+
:created_time,
|
2352
|
+
:arn)
|
1662
2353
|
SENSITIVE = []
|
1663
2354
|
include Aws::Structure
|
1664
2355
|
end
|
@@ -1681,13 +2372,18 @@ module Aws::FraudDetector
|
|
1681
2372
|
# The timestamp when the outcome was created.
|
1682
2373
|
# @return [String]
|
1683
2374
|
#
|
2375
|
+
# @!attribute [rw] arn
|
2376
|
+
# The outcome ARN.
|
2377
|
+
# @return [String]
|
2378
|
+
#
|
1684
2379
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Outcome AWS API Documentation
|
1685
2380
|
#
|
1686
2381
|
class Outcome < Struct.new(
|
1687
2382
|
:name,
|
1688
2383
|
:description,
|
1689
2384
|
:last_updated_time,
|
1690
|
-
:created_time
|
2385
|
+
:created_time,
|
2386
|
+
:arn)
|
1691
2387
|
SENSITIVE = []
|
1692
2388
|
include Aws::Structure
|
1693
2389
|
end
|
@@ -1698,6 +2394,13 @@ module Aws::FraudDetector
|
|
1698
2394
|
# {
|
1699
2395
|
# detector_id: "identifier", # required
|
1700
2396
|
# description: "description",
|
2397
|
+
# event_type_name: "identifier", # required
|
2398
|
+
# tags: [
|
2399
|
+
# {
|
2400
|
+
# key: "tagKey", # required
|
2401
|
+
# value: "tagValue", # required
|
2402
|
+
# },
|
2403
|
+
# ],
|
1701
2404
|
# }
|
1702
2405
|
#
|
1703
2406
|
# @!attribute [rw] detector_id
|
@@ -1708,11 +2411,21 @@ module Aws::FraudDetector
|
|
1708
2411
|
# The description of the detector.
|
1709
2412
|
# @return [String]
|
1710
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
|
+
#
|
1711
2422
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutDetectorRequest AWS API Documentation
|
1712
2423
|
#
|
1713
2424
|
class PutDetectorRequest < Struct.new(
|
1714
2425
|
:detector_id,
|
1715
|
-
:description
|
2426
|
+
:description,
|
2427
|
+
:event_type_name,
|
2428
|
+
:tags)
|
1716
2429
|
SENSITIVE = []
|
1717
2430
|
include Aws::Structure
|
1718
2431
|
end
|
@@ -1721,19 +2434,116 @@ module Aws::FraudDetector
|
|
1721
2434
|
#
|
1722
2435
|
class PutDetectorResult < Aws::EmptyStructure; end
|
1723
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
|
+
|
1724
2536
|
# @note When making an API call, you may pass PutExternalModelRequest
|
1725
2537
|
# data as a hash:
|
1726
2538
|
#
|
1727
2539
|
# {
|
1728
|
-
# model_endpoint: "
|
2540
|
+
# model_endpoint: "sageMakerEndpointIdentifier", # required
|
1729
2541
|
# model_source: "SAGEMAKER", # required, accepts SAGEMAKER
|
1730
|
-
#
|
1731
|
-
# arn: "string", # required
|
1732
|
-
# name: "string", # required
|
1733
|
-
# },
|
2542
|
+
# invoke_model_endpoint_role_arn: "string", # required
|
1734
2543
|
# input_configuration: { # required
|
2544
|
+
# event_type_name: "identifier",
|
1735
2545
|
# format: "TEXT_CSV", # accepts TEXT_CSV, APPLICATION_JSON
|
1736
|
-
#
|
2546
|
+
# use_event_variables: false, # required
|
1737
2547
|
# json_input_template: "string",
|
1738
2548
|
# csv_input_template: "string",
|
1739
2549
|
# },
|
@@ -1747,6 +2557,12 @@ module Aws::FraudDetector
|
|
1747
2557
|
# },
|
1748
2558
|
# },
|
1749
2559
|
# model_endpoint_status: "ASSOCIATED", # required, accepts ASSOCIATED, DISSOCIATED
|
2560
|
+
# tags: [
|
2561
|
+
# {
|
2562
|
+
# key: "tagKey", # required
|
2563
|
+
# value: "tagValue", # required
|
2564
|
+
# },
|
2565
|
+
# ],
|
1750
2566
|
# }
|
1751
2567
|
#
|
1752
2568
|
# @!attribute [rw] model_endpoint
|
@@ -1757,9 +2573,9 @@ module Aws::FraudDetector
|
|
1757
2573
|
# The source of the model.
|
1758
2574
|
# @return [String]
|
1759
2575
|
#
|
1760
|
-
# @!attribute [rw]
|
2576
|
+
# @!attribute [rw] invoke_model_endpoint_role_arn
|
1761
2577
|
# The IAM role used to invoke the model endpoint.
|
1762
|
-
# @return [
|
2578
|
+
# @return [String]
|
1763
2579
|
#
|
1764
2580
|
# @!attribute [rw] input_configuration
|
1765
2581
|
# The model endpoint input configuration.
|
@@ -1773,15 +2589,20 @@ module Aws::FraudDetector
|
|
1773
2589
|
# The model endpoint’s status in Amazon Fraud Detector.
|
1774
2590
|
# @return [String]
|
1775
2591
|
#
|
2592
|
+
# @!attribute [rw] tags
|
2593
|
+
# A collection of key and value pairs.
|
2594
|
+
# @return [Array<Types::Tag>]
|
2595
|
+
#
|
1776
2596
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutExternalModelRequest AWS API Documentation
|
1777
2597
|
#
|
1778
2598
|
class PutExternalModelRequest < Struct.new(
|
1779
2599
|
:model_endpoint,
|
1780
2600
|
:model_source,
|
1781
|
-
:
|
2601
|
+
:invoke_model_endpoint_role_arn,
|
1782
2602
|
:input_configuration,
|
1783
2603
|
:output_configuration,
|
1784
|
-
:model_endpoint_status
|
2604
|
+
:model_endpoint_status,
|
2605
|
+
:tags)
|
1785
2606
|
SENSITIVE = []
|
1786
2607
|
include Aws::Structure
|
1787
2608
|
end
|
@@ -1790,71 +2611,67 @@ module Aws::FraudDetector
|
|
1790
2611
|
#
|
1791
2612
|
class PutExternalModelResult < Aws::EmptyStructure; end
|
1792
2613
|
|
1793
|
-
# @note When making an API call, you may pass
|
2614
|
+
# @note When making an API call, you may pass PutKMSEncryptionKeyRequest
|
1794
2615
|
# data as a hash:
|
1795
2616
|
#
|
1796
2617
|
# {
|
1797
|
-
#
|
1798
|
-
#
|
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 = []
|
2630
|
+
include Aws::Structure
|
2631
|
+
end
|
2632
|
+
|
2633
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutKMSEncryptionKeyResult AWS API Documentation
|
2634
|
+
#
|
2635
|
+
class PutKMSEncryptionKeyResult < Aws::EmptyStructure; end
|
2636
|
+
|
2637
|
+
# @note When making an API call, you may pass PutLabelRequest
|
2638
|
+
# data as a hash:
|
2639
|
+
#
|
2640
|
+
# {
|
2641
|
+
# name: "identifier", # required
|
1799
2642
|
# description: "description",
|
1800
|
-
#
|
1801
|
-
# data_location: "s3BucketLocation", # required
|
1802
|
-
# data_access_role_arn: "iamRoleArn", # required
|
1803
|
-
# },
|
1804
|
-
# model_variables: [ # required
|
2643
|
+
# tags: [
|
1805
2644
|
# {
|
1806
|
-
#
|
1807
|
-
#
|
1808
|
-
# },
|
1809
|
-
# ],
|
1810
|
-
# label_schema: { # required
|
1811
|
-
# label_key: "string", # required
|
1812
|
-
# label_mapper: { # required
|
1813
|
-
# "string" => ["string"],
|
2645
|
+
# key: "tagKey", # required
|
2646
|
+
# value: "tagValue", # required
|
1814
2647
|
# },
|
1815
|
-
#
|
2648
|
+
# ],
|
1816
2649
|
# }
|
1817
2650
|
#
|
1818
|
-
# @!attribute [rw]
|
1819
|
-
# The
|
1820
|
-
# @return [String]
|
1821
|
-
#
|
1822
|
-
# @!attribute [rw] model_type
|
1823
|
-
# The model type.
|
2651
|
+
# @!attribute [rw] name
|
2652
|
+
# The label name.
|
1824
2653
|
# @return [String]
|
1825
2654
|
#
|
1826
2655
|
# @!attribute [rw] description
|
1827
|
-
# The
|
2656
|
+
# The label description.
|
1828
2657
|
# @return [String]
|
1829
2658
|
#
|
1830
|
-
# @!attribute [rw]
|
1831
|
-
#
|
1832
|
-
# @return [Types::TrainingDataSource]
|
1833
|
-
#
|
1834
|
-
# @!attribute [rw] model_variables
|
1835
|
-
# The model input variables.
|
1836
|
-
# @return [Array<Types::ModelVariable>]
|
1837
|
-
#
|
1838
|
-
# @!attribute [rw] label_schema
|
1839
|
-
# The label schema.
|
1840
|
-
# @return [Types::LabelSchema]
|
2659
|
+
# @!attribute [rw] tags
|
2660
|
+
# @return [Array<Types::Tag>]
|
1841
2661
|
#
|
1842
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/
|
2662
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutLabelRequest AWS API Documentation
|
1843
2663
|
#
|
1844
|
-
class
|
1845
|
-
:
|
1846
|
-
:model_type,
|
2664
|
+
class PutLabelRequest < Struct.new(
|
2665
|
+
:name,
|
1847
2666
|
:description,
|
1848
|
-
:
|
1849
|
-
:model_variables,
|
1850
|
-
:label_schema)
|
2667
|
+
:tags)
|
1851
2668
|
SENSITIVE = []
|
1852
2669
|
include Aws::Structure
|
1853
2670
|
end
|
1854
2671
|
|
1855
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/
|
2672
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutLabelResult AWS API Documentation
|
1856
2673
|
#
|
1857
|
-
class
|
2674
|
+
class PutLabelResult < Aws::EmptyStructure; end
|
1858
2675
|
|
1859
2676
|
# @note When making an API call, you may pass PutOutcomeRequest
|
1860
2677
|
# data as a hash:
|
@@ -1862,6 +2679,12 @@ module Aws::FraudDetector
|
|
1862
2679
|
# {
|
1863
2680
|
# name: "identifier", # required
|
1864
2681
|
# description: "description",
|
2682
|
+
# tags: [
|
2683
|
+
# {
|
2684
|
+
# key: "tagKey", # required
|
2685
|
+
# value: "tagValue", # required
|
2686
|
+
# },
|
2687
|
+
# ],
|
1865
2688
|
# }
|
1866
2689
|
#
|
1867
2690
|
# @!attribute [rw] name
|
@@ -1872,11 +2695,16 @@ module Aws::FraudDetector
|
|
1872
2695
|
# The outcome description.
|
1873
2696
|
# @return [String]
|
1874
2697
|
#
|
2698
|
+
# @!attribute [rw] tags
|
2699
|
+
# A collection of key and value pairs.
|
2700
|
+
# @return [Array<Types::Tag>]
|
2701
|
+
#
|
1875
2702
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutOutcomeRequest AWS API Documentation
|
1876
2703
|
#
|
1877
2704
|
class PutOutcomeRequest < Struct.new(
|
1878
2705
|
:name,
|
1879
|
-
:description
|
2706
|
+
:description,
|
2707
|
+
:tags)
|
1880
2708
|
SENSITIVE = []
|
1881
2709
|
include Aws::Structure
|
1882
2710
|
end
|
@@ -1898,33 +2726,6 @@ module Aws::FraudDetector
|
|
1898
2726
|
include Aws::Structure
|
1899
2727
|
end
|
1900
2728
|
|
1901
|
-
# The role used to invoke external model endpoints.
|
1902
|
-
#
|
1903
|
-
# @note When making an API call, you may pass Role
|
1904
|
-
# data as a hash:
|
1905
|
-
#
|
1906
|
-
# {
|
1907
|
-
# arn: "string", # required
|
1908
|
-
# name: "string", # required
|
1909
|
-
# }
|
1910
|
-
#
|
1911
|
-
# @!attribute [rw] arn
|
1912
|
-
# The role ARN.
|
1913
|
-
# @return [String]
|
1914
|
-
#
|
1915
|
-
# @!attribute [rw] name
|
1916
|
-
# The role name.
|
1917
|
-
# @return [String]
|
1918
|
-
#
|
1919
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Role AWS API Documentation
|
1920
|
-
#
|
1921
|
-
class Role < Struct.new(
|
1922
|
-
:arn,
|
1923
|
-
:name)
|
1924
|
-
SENSITIVE = []
|
1925
|
-
include Aws::Structure
|
1926
|
-
end
|
1927
|
-
|
1928
2729
|
# A rule.
|
1929
2730
|
#
|
1930
2731
|
# @note When making an API call, you may pass Rule
|
@@ -1933,7 +2734,7 @@ module Aws::FraudDetector
|
|
1933
2734
|
# {
|
1934
2735
|
# detector_id: "identifier", # required
|
1935
2736
|
# rule_id: "identifier", # required
|
1936
|
-
# rule_version: "
|
2737
|
+
# rule_version: "wholeNumberVersionString", # required
|
1937
2738
|
# }
|
1938
2739
|
#
|
1939
2740
|
# @!attribute [rw] detector_id
|
@@ -1996,6 +2797,10 @@ module Aws::FraudDetector
|
|
1996
2797
|
# The timestamp of when the rule was created.
|
1997
2798
|
# @return [String]
|
1998
2799
|
#
|
2800
|
+
# @!attribute [rw] arn
|
2801
|
+
# The rule ARN.
|
2802
|
+
# @return [String]
|
2803
|
+
#
|
1999
2804
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/RuleDetail AWS API Documentation
|
2000
2805
|
#
|
2001
2806
|
class RuleDetail < Struct.new(
|
@@ -2007,8 +2812,9 @@ module Aws::FraudDetector
|
|
2007
2812
|
:language,
|
2008
2813
|
:outcomes,
|
2009
2814
|
:last_updated_time,
|
2010
|
-
:created_time
|
2011
|
-
|
2815
|
+
:created_time,
|
2816
|
+
:arn)
|
2817
|
+
SENSITIVE = [:expression]
|
2012
2818
|
include Aws::Structure
|
2013
2819
|
end
|
2014
2820
|
|
@@ -2031,6 +2837,67 @@ module Aws::FraudDetector
|
|
2031
2837
|
include Aws::Structure
|
2032
2838
|
end
|
2033
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 = []
|
2894
|
+
include Aws::Structure
|
2895
|
+
end
|
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
|
+
|
2034
2901
|
# An exception indicating a throttling error.
|
2035
2902
|
#
|
2036
2903
|
# @!attribute [rw] message
|
@@ -2044,39 +2911,113 @@ module Aws::FraudDetector
|
|
2044
2911
|
include Aws::Structure
|
2045
2912
|
end
|
2046
2913
|
|
2047
|
-
# The training data
|
2914
|
+
# The training data schema.
|
2048
2915
|
#
|
2049
|
-
# @note When making an API call, you may pass
|
2916
|
+
# @note When making an API call, you may pass TrainingDataSchema
|
2050
2917
|
# data as a hash:
|
2051
2918
|
#
|
2052
2919
|
# {
|
2053
|
-
#
|
2054
|
-
#
|
2920
|
+
# model_variables: ["string"], # required
|
2921
|
+
# label_schema: { # required
|
2922
|
+
# label_mapper: { # required
|
2923
|
+
# "string" => ["string"],
|
2924
|
+
# },
|
2925
|
+
# },
|
2055
2926
|
# }
|
2056
2927
|
#
|
2057
|
-
# @!attribute [rw]
|
2058
|
-
# The
|
2059
|
-
# @return [String]
|
2928
|
+
# @!attribute [rw] model_variables
|
2929
|
+
# The training data schema variables.
|
2930
|
+
# @return [Array<String>]
|
2060
2931
|
#
|
2061
|
-
# @!attribute [rw]
|
2062
|
-
# The
|
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.
|
2063
2996
|
# @return [String]
|
2064
2997
|
#
|
2065
|
-
#
|
2998
|
+
# @!attribute [rw] tag_keys
|
2999
|
+
# The resource ARN.
|
3000
|
+
# @return [Array<String>]
|
2066
3001
|
#
|
2067
|
-
|
2068
|
-
|
2069
|
-
|
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)
|
2070
3007
|
SENSITIVE = []
|
2071
3008
|
include Aws::Structure
|
2072
3009
|
end
|
2073
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
|
+
|
2074
3015
|
# @note When making an API call, you may pass UpdateDetectorVersionMetadataRequest
|
2075
3016
|
# data as a hash:
|
2076
3017
|
#
|
2077
3018
|
# {
|
2078
3019
|
# detector_id: "identifier", # required
|
2079
|
-
# detector_version_id: "
|
3020
|
+
# detector_version_id: "wholeNumberVersionString", # required
|
2080
3021
|
# description: "description", # required
|
2081
3022
|
# }
|
2082
3023
|
#
|
@@ -2111,21 +3052,22 @@ module Aws::FraudDetector
|
|
2111
3052
|
#
|
2112
3053
|
# {
|
2113
3054
|
# detector_id: "identifier", # required
|
2114
|
-
# detector_version_id: "
|
3055
|
+
# detector_version_id: "wholeNumberVersionString", # required
|
2115
3056
|
# external_model_endpoints: ["string"], # required
|
2116
3057
|
# rules: [ # required
|
2117
3058
|
# {
|
2118
3059
|
# detector_id: "identifier", # required
|
2119
3060
|
# rule_id: "identifier", # required
|
2120
|
-
# rule_version: "
|
3061
|
+
# rule_version: "wholeNumberVersionString", # required
|
2121
3062
|
# },
|
2122
3063
|
# ],
|
2123
3064
|
# description: "description",
|
2124
3065
|
# model_versions: [
|
2125
3066
|
# {
|
2126
|
-
# model_id: "
|
3067
|
+
# model_id: "modelIdentifier", # required
|
2127
3068
|
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
|
2128
3069
|
# model_version_number: "nonEmptyString", # required
|
3070
|
+
# arn: "fraudDetectorArn",
|
2129
3071
|
# },
|
2130
3072
|
# ],
|
2131
3073
|
# rule_execution_mode: "ALL_MATCHED", # accepts ALL_MATCHED, FIRST_MATCHED
|
@@ -2195,7 +3137,7 @@ module Aws::FraudDetector
|
|
2195
3137
|
#
|
2196
3138
|
# {
|
2197
3139
|
# detector_id: "identifier", # required
|
2198
|
-
# detector_version_id: "
|
3140
|
+
# detector_version_id: "wholeNumberVersionString", # required
|
2199
3141
|
# status: "DRAFT", # required, accepts DRAFT, ACTIVE, INACTIVE
|
2200
3142
|
# }
|
2201
3143
|
#
|
@@ -2225,17 +3167,92 @@ module Aws::FraudDetector
|
|
2225
3167
|
#
|
2226
3168
|
class UpdateDetectorVersionStatusResult < Aws::EmptyStructure; end
|
2227
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
|
+
|
2228
3205
|
# @note When making an API call, you may pass UpdateModelVersionRequest
|
2229
3206
|
# data as a hash:
|
2230
3207
|
#
|
2231
3208
|
# {
|
2232
|
-
# model_id: "
|
3209
|
+
# model_id: "modelIdentifier", # required
|
2233
3210
|
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
|
2234
|
-
#
|
2235
|
-
#
|
2236
|
-
#
|
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
|
+
# ],
|
2237
3222
|
# }
|
2238
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
|
+
|
2239
3256
|
# @!attribute [rw] model_id
|
2240
3257
|
# The model ID.
|
2241
3258
|
# @return [String]
|
@@ -2245,32 +3262,64 @@ module Aws::FraudDetector
|
|
2245
3262
|
# @return [String]
|
2246
3263
|
#
|
2247
3264
|
# @!attribute [rw] model_version_number
|
2248
|
-
# The model version.
|
3265
|
+
# The model version number of the model version updated.
|
2249
3266
|
# @return [String]
|
2250
3267
|
#
|
2251
|
-
# @!attribute [rw]
|
2252
|
-
# The model
|
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.
|
2253
3303
|
# @return [String]
|
2254
3304
|
#
|
2255
3305
|
# @!attribute [rw] status
|
2256
|
-
# The
|
3306
|
+
# The model version status.
|
2257
3307
|
# @return [String]
|
2258
3308
|
#
|
2259
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/
|
3309
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelVersionStatusRequest AWS API Documentation
|
2260
3310
|
#
|
2261
|
-
class
|
3311
|
+
class UpdateModelVersionStatusRequest < Struct.new(
|
2262
3312
|
:model_id,
|
2263
3313
|
:model_type,
|
2264
3314
|
:model_version_number,
|
2265
|
-
:description,
|
2266
3315
|
:status)
|
2267
3316
|
SENSITIVE = []
|
2268
3317
|
include Aws::Structure
|
2269
3318
|
end
|
2270
3319
|
|
2271
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/
|
3320
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelVersionStatusResult AWS API Documentation
|
2272
3321
|
#
|
2273
|
-
class
|
3322
|
+
class UpdateModelVersionStatusResult < Aws::EmptyStructure; end
|
2274
3323
|
|
2275
3324
|
# @note When making an API call, you may pass UpdateRuleMetadataRequest
|
2276
3325
|
# data as a hash:
|
@@ -2279,7 +3328,7 @@ module Aws::FraudDetector
|
|
2279
3328
|
# rule: { # required
|
2280
3329
|
# detector_id: "identifier", # required
|
2281
3330
|
# rule_id: "identifier", # required
|
2282
|
-
# rule_version: "
|
3331
|
+
# rule_version: "wholeNumberVersionString", # required
|
2283
3332
|
# },
|
2284
3333
|
# description: "description", # required
|
2285
3334
|
# }
|
@@ -2312,12 +3361,18 @@ module Aws::FraudDetector
|
|
2312
3361
|
# rule: { # required
|
2313
3362
|
# detector_id: "identifier", # required
|
2314
3363
|
# rule_id: "identifier", # required
|
2315
|
-
# rule_version: "
|
3364
|
+
# rule_version: "wholeNumberVersionString", # required
|
2316
3365
|
# },
|
2317
3366
|
# description: "description",
|
2318
3367
|
# expression: "ruleExpression", # required
|
2319
3368
|
# language: "DETECTORPL", # required, accepts DETECTORPL
|
2320
3369
|
# outcomes: ["string"], # required
|
3370
|
+
# tags: [
|
3371
|
+
# {
|
3372
|
+
# key: "tagKey", # required
|
3373
|
+
# value: "tagValue", # required
|
3374
|
+
# },
|
3375
|
+
# ],
|
2321
3376
|
# }
|
2322
3377
|
#
|
2323
3378
|
# @!attribute [rw] rule
|
@@ -2340,6 +3395,10 @@ module Aws::FraudDetector
|
|
2340
3395
|
# The outcomes.
|
2341
3396
|
# @return [Array<String>]
|
2342
3397
|
#
|
3398
|
+
# @!attribute [rw] tags
|
3399
|
+
# The tags to assign to the rule version.
|
3400
|
+
# @return [Array<Types::Tag>]
|
3401
|
+
#
|
2343
3402
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateRuleVersionRequest AWS API Documentation
|
2344
3403
|
#
|
2345
3404
|
class UpdateRuleVersionRequest < Struct.new(
|
@@ -2347,8 +3406,9 @@ module Aws::FraudDetector
|
|
2347
3406
|
:description,
|
2348
3407
|
:expression,
|
2349
3408
|
:language,
|
2350
|
-
:outcomes
|
2351
|
-
|
3409
|
+
:outcomes,
|
3410
|
+
:tags)
|
3411
|
+
SENSITIVE = [:expression]
|
2352
3412
|
include Aws::Structure
|
2353
3413
|
end
|
2354
3414
|
|
@@ -2387,7 +3447,11 @@ module Aws::FraudDetector
|
|
2387
3447
|
# @return [String]
|
2388
3448
|
#
|
2389
3449
|
# @!attribute [rw] variable_type
|
2390
|
-
# 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
|
2391
3455
|
# @return [String]
|
2392
3456
|
#
|
2393
3457
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateVariableRequest AWS API Documentation
|
@@ -2425,7 +3489,12 @@ module Aws::FraudDetector
|
|
2425
3489
|
# @return [String]
|
2426
3490
|
#
|
2427
3491
|
# @!attribute [rw] data_type
|
2428
|
-
# 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
|
2429
3498
|
# @return [String]
|
2430
3499
|
#
|
2431
3500
|
# @!attribute [rw] data_source
|
@@ -2442,6 +3511,16 @@ module Aws::FraudDetector
|
|
2442
3511
|
#
|
2443
3512
|
# @!attribute [rw] variable_type
|
2444
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`
|
2445
3524
|
# @return [String]
|
2446
3525
|
#
|
2447
3526
|
# @!attribute [rw] last_updated_time
|
@@ -2452,6 +3531,10 @@ module Aws::FraudDetector
|
|
2452
3531
|
# The time when the variable was created.
|
2453
3532
|
# @return [String]
|
2454
3533
|
#
|
3534
|
+
# @!attribute [rw] arn
|
3535
|
+
# The ARN of the variable.
|
3536
|
+
# @return [String]
|
3537
|
+
#
|
2455
3538
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Variable AWS API Documentation
|
2456
3539
|
#
|
2457
3540
|
class Variable < Struct.new(
|
@@ -2462,12 +3545,14 @@ module Aws::FraudDetector
|
|
2462
3545
|
:description,
|
2463
3546
|
:variable_type,
|
2464
3547
|
:last_updated_time,
|
2465
|
-
:created_time
|
3548
|
+
:created_time,
|
3549
|
+
:arn)
|
2466
3550
|
SENSITIVE = []
|
2467
3551
|
include Aws::Structure
|
2468
3552
|
end
|
2469
3553
|
|
2470
|
-
#
|
3554
|
+
# A variable in the list of variables for the batch create variable
|
3555
|
+
# request.
|
2471
3556
|
#
|
2472
3557
|
# @note When making an API call, you may pass VariableEntry
|
2473
3558
|
# data as a hash:
|
@@ -2482,27 +3567,42 @@ module Aws::FraudDetector
|
|
2482
3567
|
# }
|
2483
3568
|
#
|
2484
3569
|
# @!attribute [rw] name
|
2485
|
-
# The name of the variable
|
3570
|
+
# The name of the variable.
|
2486
3571
|
# @return [String]
|
2487
3572
|
#
|
2488
3573
|
# @!attribute [rw] data_type
|
2489
|
-
# The data type of the variable
|
3574
|
+
# The data type of the variable.
|
2490
3575
|
# @return [String]
|
2491
3576
|
#
|
2492
3577
|
# @!attribute [rw] data_source
|
2493
|
-
# The data source of the variable
|
3578
|
+
# The data source of the variable.
|
2494
3579
|
# @return [String]
|
2495
3580
|
#
|
2496
3581
|
# @!attribute [rw] default_value
|
2497
|
-
# The default value of the variable
|
3582
|
+
# The default value of the variable.
|
2498
3583
|
# @return [String]
|
2499
3584
|
#
|
2500
3585
|
# @!attribute [rw] description
|
2501
|
-
# The description of the variable
|
3586
|
+
# The description of the variable.
|
2502
3587
|
# @return [String]
|
2503
3588
|
#
|
2504
3589
|
# @!attribute [rw] variable_type
|
2505
|
-
# The type of the variable
|
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
|
2506
3606
|
# @return [String]
|
2507
3607
|
#
|
2508
3608
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/VariableEntry AWS API Documentation
|