aws-sdk-frauddetector 1.28.0 → 1.46.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +93 -1
- data/VERSION +1 -1
- data/lib/aws-sdk-frauddetector/client.rb +601 -41
- data/lib/aws-sdk-frauddetector/client_api.rb +424 -3
- data/lib/aws-sdk-frauddetector/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-frauddetector/endpoint_provider.rb +54 -0
- data/lib/aws-sdk-frauddetector/endpoints.rb +1038 -0
- data/lib/aws-sdk-frauddetector/plugins/endpoints.rb +214 -0
- data/lib/aws-sdk-frauddetector/types.rb +1221 -950
- data/lib/aws-sdk-frauddetector.rb +5 -1
- metadata +8 -4
@@ -10,6 +10,89 @@
|
|
10
10
|
module Aws::FraudDetector
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# The Account Takeover Insights (ATI) model performance metrics data
|
14
|
+
# points.
|
15
|
+
#
|
16
|
+
# @!attribute [rw] cr
|
17
|
+
# The challenge rate. This indicates the percentage of login events
|
18
|
+
# that the model recommends to challenge such as one-time password,
|
19
|
+
# multi-factor authentication, and investigations.
|
20
|
+
# @return [Float]
|
21
|
+
#
|
22
|
+
# @!attribute [rw] adr
|
23
|
+
# The anomaly discovery rate. This metric quantifies the percentage of
|
24
|
+
# anomalies that can be detected by the model at the selected score
|
25
|
+
# threshold. A lower score threshold increases the percentage of
|
26
|
+
# anomalies captured by the model, but would also require challenging
|
27
|
+
# a larger percentage of login events, leading to a higher customer
|
28
|
+
# friction.
|
29
|
+
# @return [Float]
|
30
|
+
#
|
31
|
+
# @!attribute [rw] threshold
|
32
|
+
# The model's threshold that specifies an acceptable fraud capture
|
33
|
+
# rate. For example, a threshold of 500 means any model score 500 or
|
34
|
+
# above is labeled as fraud.
|
35
|
+
# @return [Float]
|
36
|
+
#
|
37
|
+
# @!attribute [rw] atodr
|
38
|
+
# The account takeover discovery rate. This metric quantifies the
|
39
|
+
# percentage of account compromise events that can be detected by the
|
40
|
+
# model at the selected score threshold. This metric is only available
|
41
|
+
# if 50 or more entities with at-least one labeled account takeover
|
42
|
+
# event is present in the ingested dataset.
|
43
|
+
# @return [Float]
|
44
|
+
#
|
45
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ATIMetricDataPoint AWS API Documentation
|
46
|
+
#
|
47
|
+
class ATIMetricDataPoint < Struct.new(
|
48
|
+
:cr,
|
49
|
+
:adr,
|
50
|
+
:threshold,
|
51
|
+
:atodr)
|
52
|
+
SENSITIVE = []
|
53
|
+
include Aws::Structure
|
54
|
+
end
|
55
|
+
|
56
|
+
# The Account Takeover Insights (ATI) model performance score.
|
57
|
+
#
|
58
|
+
# @!attribute [rw] asi
|
59
|
+
# The anomaly separation index (ASI) score. This metric summarizes the
|
60
|
+
# overall ability of the model to separate anomalous activities from
|
61
|
+
# the normal behavior. Depending on the business, a large fraction of
|
62
|
+
# these anomalous activities can be malicious and correspond to the
|
63
|
+
# account takeover attacks. A model with no separability power will
|
64
|
+
# have the lowest possible ASI score of 0.5, whereas the a model with
|
65
|
+
# a high separability power will have the highest possible ASI score
|
66
|
+
# of 1.0
|
67
|
+
# @return [Float]
|
68
|
+
#
|
69
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ATIModelPerformance AWS API Documentation
|
70
|
+
#
|
71
|
+
class ATIModelPerformance < Struct.new(
|
72
|
+
:asi)
|
73
|
+
SENSITIVE = []
|
74
|
+
include Aws::Structure
|
75
|
+
end
|
76
|
+
|
77
|
+
# The Account Takeover Insights (ATI) model training metric details.
|
78
|
+
#
|
79
|
+
# @!attribute [rw] metric_data_points
|
80
|
+
# The model's performance metrics data points.
|
81
|
+
# @return [Array<Types::ATIMetricDataPoint>]
|
82
|
+
#
|
83
|
+
# @!attribute [rw] model_performance
|
84
|
+
# The model's overall performance scores.
|
85
|
+
# @return [Types::ATIModelPerformance]
|
86
|
+
#
|
87
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ATITrainingMetricsValue AWS API Documentation
|
88
|
+
#
|
89
|
+
class ATITrainingMetricsValue < Struct.new(
|
90
|
+
:metric_data_points,
|
91
|
+
:model_performance)
|
92
|
+
SENSITIVE = []
|
93
|
+
include Aws::Structure
|
94
|
+
end
|
95
|
+
|
13
96
|
# An exception indicating Amazon Fraud Detector does not have the needed
|
14
97
|
# permissions. This can occur if you submit a request, such as
|
15
98
|
# `PutExternalModel`, that specifies a role that is not in your account.
|
@@ -25,6 +108,135 @@ module Aws::FraudDetector
|
|
25
108
|
include Aws::Structure
|
26
109
|
end
|
27
110
|
|
111
|
+
# The log odds metric details.
|
112
|
+
#
|
113
|
+
# Account Takeover Insights (ATI) model uses event variables from the
|
114
|
+
# login data you provide to continuously calculate a set of variables
|
115
|
+
# (aggregated variables) based on historical events. For example, your
|
116
|
+
# ATI model might calculate the number of times an user has logged in
|
117
|
+
# using the same IP address. In this case, event variables used to
|
118
|
+
# derive the aggregated variables are `IP address` and `user`.
|
119
|
+
#
|
120
|
+
# @!attribute [rw] variable_names
|
121
|
+
# The names of all the variables.
|
122
|
+
# @return [Array<String>]
|
123
|
+
#
|
124
|
+
# @!attribute [rw] aggregated_variables_importance
|
125
|
+
# The relative importance of the variables in the list to the other
|
126
|
+
# event variable.
|
127
|
+
# @return [Float]
|
128
|
+
#
|
129
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/AggregatedLogOddsMetric AWS API Documentation
|
130
|
+
#
|
131
|
+
class AggregatedLogOddsMetric < Struct.new(
|
132
|
+
:variable_names,
|
133
|
+
:aggregated_variables_importance)
|
134
|
+
SENSITIVE = []
|
135
|
+
include Aws::Structure
|
136
|
+
end
|
137
|
+
|
138
|
+
# The details of the impact of aggregated variables on the prediction
|
139
|
+
# score.
|
140
|
+
#
|
141
|
+
# Account Takeover Insights (ATI) model uses the login data you provide
|
142
|
+
# to continuously calculate a set of variables (aggregated variables)
|
143
|
+
# based on historical events. For example, the model might calculate the
|
144
|
+
# number of times an user has logged in using the same IP address. In
|
145
|
+
# this case, event variables used to derive the aggregated variables are
|
146
|
+
# `IP address` and `user`.
|
147
|
+
#
|
148
|
+
# @!attribute [rw] event_variable_names
|
149
|
+
# The names of all the event variables that were used to derive the
|
150
|
+
# aggregated variables.
|
151
|
+
# @return [Array<String>]
|
152
|
+
#
|
153
|
+
# @!attribute [rw] relative_impact
|
154
|
+
# The relative impact of the aggregated variables in terms of
|
155
|
+
# magnitude on the prediction scores.
|
156
|
+
# @return [String]
|
157
|
+
#
|
158
|
+
# @!attribute [rw] log_odds_impact
|
159
|
+
# The raw, uninterpreted value represented as log-odds of the fraud.
|
160
|
+
# These values are usually between -10 to +10, but range from
|
161
|
+
# -infinity to +infinity.
|
162
|
+
#
|
163
|
+
# * A positive value indicates that the variables drove the risk score
|
164
|
+
# up.
|
165
|
+
#
|
166
|
+
# * A negative value indicates that the variables drove the risk score
|
167
|
+
# down.
|
168
|
+
# @return [Float]
|
169
|
+
#
|
170
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/AggregatedVariablesImpactExplanation AWS API Documentation
|
171
|
+
#
|
172
|
+
class AggregatedVariablesImpactExplanation < Struct.new(
|
173
|
+
:event_variable_names,
|
174
|
+
:relative_impact,
|
175
|
+
:log_odds_impact)
|
176
|
+
SENSITIVE = []
|
177
|
+
include Aws::Structure
|
178
|
+
end
|
179
|
+
|
180
|
+
# The details of the relative importance of the aggregated variables.
|
181
|
+
#
|
182
|
+
# Account Takeover Insights (ATI) model uses event variables from the
|
183
|
+
# login data you provide to continuously calculate a set of variables
|
184
|
+
# (aggregated variables) based on historical events. For example, your
|
185
|
+
# ATI model might calculate the number of times an user has logged in
|
186
|
+
# using the same IP address. In this case, event variables used to
|
187
|
+
# derive the aggregated variables are `IP address` and `user`.
|
188
|
+
#
|
189
|
+
# @!attribute [rw] log_odds_metrics
|
190
|
+
# List of variables' metrics.
|
191
|
+
# @return [Array<Types::AggregatedLogOddsMetric>]
|
192
|
+
#
|
193
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/AggregatedVariablesImportanceMetrics AWS API Documentation
|
194
|
+
#
|
195
|
+
class AggregatedVariablesImportanceMetrics < Struct.new(
|
196
|
+
:log_odds_metrics)
|
197
|
+
SENSITIVE = []
|
198
|
+
include Aws::Structure
|
199
|
+
end
|
200
|
+
|
201
|
+
# The metadata of a list.
|
202
|
+
#
|
203
|
+
# @!attribute [rw] name
|
204
|
+
# The name of the list.
|
205
|
+
# @return [String]
|
206
|
+
#
|
207
|
+
# @!attribute [rw] description
|
208
|
+
# The description of the list.
|
209
|
+
# @return [String]
|
210
|
+
#
|
211
|
+
# @!attribute [rw] variable_type
|
212
|
+
# The variable type of the list.
|
213
|
+
# @return [String]
|
214
|
+
#
|
215
|
+
# @!attribute [rw] created_time
|
216
|
+
# The time the list was created.
|
217
|
+
# @return [String]
|
218
|
+
#
|
219
|
+
# @!attribute [rw] updated_time
|
220
|
+
# The time the list was last updated.
|
221
|
+
# @return [String]
|
222
|
+
#
|
223
|
+
# @!attribute [rw] arn
|
224
|
+
# The ARN of the list.
|
225
|
+
# @return [String]
|
226
|
+
#
|
227
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/AllowDenyList AWS API Documentation
|
228
|
+
#
|
229
|
+
class AllowDenyList < Struct.new(
|
230
|
+
:name,
|
231
|
+
:description,
|
232
|
+
:variable_type,
|
233
|
+
:created_time,
|
234
|
+
:updated_time,
|
235
|
+
:arn)
|
236
|
+
SENSITIVE = []
|
237
|
+
include Aws::Structure
|
238
|
+
end
|
239
|
+
|
28
240
|
# Provides the error of the batch create variable API.
|
29
241
|
#
|
30
242
|
# @!attribute [rw] name
|
@@ -49,28 +261,6 @@ module Aws::FraudDetector
|
|
49
261
|
include Aws::Structure
|
50
262
|
end
|
51
263
|
|
52
|
-
# @note When making an API call, you may pass BatchCreateVariableRequest
|
53
|
-
# data as a hash:
|
54
|
-
#
|
55
|
-
# {
|
56
|
-
# variable_entries: [ # required
|
57
|
-
# {
|
58
|
-
# name: "string",
|
59
|
-
# data_type: "string",
|
60
|
-
# data_source: "string",
|
61
|
-
# default_value: "string",
|
62
|
-
# description: "string",
|
63
|
-
# variable_type: "string",
|
64
|
-
# },
|
65
|
-
# ],
|
66
|
-
# tags: [
|
67
|
-
# {
|
68
|
-
# key: "tagKey", # required
|
69
|
-
# value: "tagValue", # required
|
70
|
-
# },
|
71
|
-
# ],
|
72
|
-
# }
|
73
|
-
#
|
74
264
|
# @!attribute [rw] variable_entries
|
75
265
|
# The list of variables for the batch create variable request.
|
76
266
|
# @return [Array<Types::VariableEntry>]
|
@@ -124,13 +314,6 @@ module Aws::FraudDetector
|
|
124
314
|
include Aws::Structure
|
125
315
|
end
|
126
316
|
|
127
|
-
# @note When making an API call, you may pass BatchGetVariableRequest
|
128
|
-
# data as a hash:
|
129
|
-
#
|
130
|
-
# {
|
131
|
-
# names: ["string"], # required
|
132
|
-
# }
|
133
|
-
#
|
134
317
|
# @!attribute [rw] names
|
135
318
|
# The list of variable names to get.
|
136
319
|
# @return [Array<String>]
|
@@ -319,13 +502,6 @@ module Aws::FraudDetector
|
|
319
502
|
include Aws::Structure
|
320
503
|
end
|
321
504
|
|
322
|
-
# @note When making an API call, you may pass CancelBatchImportJobRequest
|
323
|
-
# data as a hash:
|
324
|
-
#
|
325
|
-
# {
|
326
|
-
# job_id: "identifier", # required
|
327
|
-
# }
|
328
|
-
#
|
329
505
|
# @!attribute [rw] job_id
|
330
506
|
# The ID of an in-progress batch import job to cancel.
|
331
507
|
#
|
@@ -345,13 +521,6 @@ module Aws::FraudDetector
|
|
345
521
|
#
|
346
522
|
class CancelBatchImportJobResult < Aws::EmptyStructure; end
|
347
523
|
|
348
|
-
# @note When making an API call, you may pass CancelBatchPredictionJobRequest
|
349
|
-
# data as a hash:
|
350
|
-
#
|
351
|
-
# {
|
352
|
-
# job_id: "identifier", # required
|
353
|
-
# }
|
354
|
-
#
|
355
524
|
# @!attribute [rw] job_id
|
356
525
|
# The ID of the batch prediction job to cancel.
|
357
526
|
# @return [String]
|
@@ -382,23 +551,6 @@ module Aws::FraudDetector
|
|
382
551
|
include Aws::Structure
|
383
552
|
end
|
384
553
|
|
385
|
-
# @note When making an API call, you may pass CreateBatchImportJobRequest
|
386
|
-
# data as a hash:
|
387
|
-
#
|
388
|
-
# {
|
389
|
-
# job_id: "identifier", # required
|
390
|
-
# input_path: "s3BucketLocation", # required
|
391
|
-
# output_path: "s3BucketLocation", # required
|
392
|
-
# event_type_name: "identifier", # required
|
393
|
-
# iam_role_arn: "iamRoleArn", # required
|
394
|
-
# tags: [
|
395
|
-
# {
|
396
|
-
# key: "tagKey", # required
|
397
|
-
# value: "tagValue", # required
|
398
|
-
# },
|
399
|
-
# ],
|
400
|
-
# }
|
401
|
-
#
|
402
554
|
# @!attribute [rw] job_id
|
403
555
|
# The ID of the batch import job. The ID cannot be of a past job,
|
404
556
|
# unless the job exists in `CREATE_FAILED` state.
|
@@ -419,8 +571,16 @@ module Aws::FraudDetector
|
|
419
571
|
#
|
420
572
|
# @!attribute [rw] iam_role_arn
|
421
573
|
# The ARN of the IAM role created for Amazon S3 bucket that holds your
|
422
|
-
# data file.
|
423
|
-
#
|
574
|
+
# data file.
|
575
|
+
#
|
576
|
+
# The IAM role must have read permissions to your input S3 bucket and
|
577
|
+
# write permissions to your output S3 bucket. For more information
|
578
|
+
# about bucket permissions, see [User policy examples][1] in the
|
579
|
+
# *Amazon S3 User Guide*.
|
580
|
+
#
|
581
|
+
#
|
582
|
+
#
|
583
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-policies-s3.html
|
424
584
|
# @return [String]
|
425
585
|
#
|
426
586
|
# @!attribute [rw] tags
|
@@ -444,25 +604,6 @@ module Aws::FraudDetector
|
|
444
604
|
#
|
445
605
|
class CreateBatchImportJobResult < Aws::EmptyStructure; end
|
446
606
|
|
447
|
-
# @note When making an API call, you may pass CreateBatchPredictionJobRequest
|
448
|
-
# data as a hash:
|
449
|
-
#
|
450
|
-
# {
|
451
|
-
# job_id: "identifier", # required
|
452
|
-
# input_path: "s3BucketLocation", # required
|
453
|
-
# output_path: "s3BucketLocation", # required
|
454
|
-
# event_type_name: "identifier", # required
|
455
|
-
# detector_name: "identifier", # required
|
456
|
-
# detector_version: "wholeNumberVersionString",
|
457
|
-
# iam_role_arn: "iamRoleArn", # required
|
458
|
-
# tags: [
|
459
|
-
# {
|
460
|
-
# key: "tagKey", # required
|
461
|
-
# value: "tagValue", # required
|
462
|
-
# },
|
463
|
-
# ],
|
464
|
-
# }
|
465
|
-
#
|
466
607
|
# @!attribute [rw] job_id
|
467
608
|
# The ID of the batch prediction job.
|
468
609
|
# @return [String]
|
@@ -489,6 +630,15 @@ module Aws::FraudDetector
|
|
489
630
|
#
|
490
631
|
# @!attribute [rw] iam_role_arn
|
491
632
|
# The ARN of the IAM role to use for this job request.
|
633
|
+
#
|
634
|
+
# The IAM Role must have read permissions to your input S3 bucket and
|
635
|
+
# write permissions to your output S3 bucket. For more information
|
636
|
+
# about bucket permissions, see [User policy examples][1] in the
|
637
|
+
# *Amazon S3 User Guide*.
|
638
|
+
#
|
639
|
+
#
|
640
|
+
#
|
641
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-policies-s3.html
|
492
642
|
# @return [String]
|
493
643
|
#
|
494
644
|
# @!attribute [rw] tags
|
@@ -514,37 +664,6 @@ module Aws::FraudDetector
|
|
514
664
|
#
|
515
665
|
class CreateBatchPredictionJobResult < Aws::EmptyStructure; end
|
516
666
|
|
517
|
-
# @note When making an API call, you may pass CreateDetectorVersionRequest
|
518
|
-
# data as a hash:
|
519
|
-
#
|
520
|
-
# {
|
521
|
-
# detector_id: "identifier", # required
|
522
|
-
# description: "description",
|
523
|
-
# external_model_endpoints: ["string"],
|
524
|
-
# rules: [ # required
|
525
|
-
# {
|
526
|
-
# detector_id: "identifier", # required
|
527
|
-
# rule_id: "identifier", # required
|
528
|
-
# rule_version: "wholeNumberVersionString", # required
|
529
|
-
# },
|
530
|
-
# ],
|
531
|
-
# model_versions: [
|
532
|
-
# {
|
533
|
-
# model_id: "modelIdentifier", # required
|
534
|
-
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
|
535
|
-
# model_version_number: "floatVersionString", # required
|
536
|
-
# arn: "fraudDetectorArn",
|
537
|
-
# },
|
538
|
-
# ],
|
539
|
-
# rule_execution_mode: "ALL_MATCHED", # accepts ALL_MATCHED, FIRST_MATCHED
|
540
|
-
# tags: [
|
541
|
-
# {
|
542
|
-
# key: "tagKey", # required
|
543
|
-
# value: "tagValue", # required
|
544
|
-
# },
|
545
|
-
# ],
|
546
|
-
# }
|
547
|
-
#
|
548
667
|
# @!attribute [rw] detector_id
|
549
668
|
# The ID of the detector under which you want to create a new version.
|
550
669
|
# @return [String]
|
@@ -624,22 +743,53 @@ module Aws::FraudDetector
|
|
624
743
|
include Aws::Structure
|
625
744
|
end
|
626
745
|
|
627
|
-
#
|
628
|
-
#
|
746
|
+
# @!attribute [rw] name
|
747
|
+
# The name of the list.
|
748
|
+
# @return [String]
|
749
|
+
#
|
750
|
+
# @!attribute [rw] elements
|
751
|
+
# The names of the elements, if providing. You can also create an
|
752
|
+
# empty list and add elements later using the [UpdateList][1] API.
|
753
|
+
#
|
754
|
+
#
|
755
|
+
#
|
756
|
+
# [1]: https://docs.aws.amazon.com/frauddetector/latest/api/API_Updatelist.html
|
757
|
+
# @return [Array<String>]
|
758
|
+
#
|
759
|
+
# @!attribute [rw] variable_type
|
760
|
+
# The variable type of the list. You can only assign the variable type
|
761
|
+
# with String data type. For more information, see [Variable
|
762
|
+
# types][1].
|
763
|
+
#
|
629
764
|
#
|
630
|
-
# {
|
631
|
-
# model_id: "modelIdentifier", # required
|
632
|
-
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
|
633
|
-
# description: "description",
|
634
|
-
# event_type_name: "string", # required
|
635
|
-
# tags: [
|
636
|
-
# {
|
637
|
-
# key: "tagKey", # required
|
638
|
-
# value: "tagValue", # required
|
639
|
-
# },
|
640
|
-
# ],
|
641
|
-
# }
|
642
765
|
#
|
766
|
+
# [1]: https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types
|
767
|
+
# @return [String]
|
768
|
+
#
|
769
|
+
# @!attribute [rw] description
|
770
|
+
# The description of the list.
|
771
|
+
# @return [String]
|
772
|
+
#
|
773
|
+
# @!attribute [rw] tags
|
774
|
+
# A collection of the key and value pairs.
|
775
|
+
# @return [Array<Types::Tag>]
|
776
|
+
#
|
777
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateListRequest AWS API Documentation
|
778
|
+
#
|
779
|
+
class CreateListRequest < Struct.new(
|
780
|
+
:name,
|
781
|
+
:elements,
|
782
|
+
:variable_type,
|
783
|
+
:description,
|
784
|
+
:tags)
|
785
|
+
SENSITIVE = []
|
786
|
+
include Aws::Structure
|
787
|
+
end
|
788
|
+
|
789
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateListResult AWS API Documentation
|
790
|
+
#
|
791
|
+
class CreateListResult < Aws::EmptyStructure; end
|
792
|
+
|
643
793
|
# @!attribute [rw] model_id
|
644
794
|
# The model ID.
|
645
795
|
# @return [String]
|
@@ -676,40 +826,6 @@ module Aws::FraudDetector
|
|
676
826
|
#
|
677
827
|
class CreateModelResult < Aws::EmptyStructure; end
|
678
828
|
|
679
|
-
# @note When making an API call, you may pass CreateModelVersionRequest
|
680
|
-
# data as a hash:
|
681
|
-
#
|
682
|
-
# {
|
683
|
-
# model_id: "modelIdentifier", # required
|
684
|
-
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
|
685
|
-
# training_data_source: "EXTERNAL_EVENTS", # required, accepts EXTERNAL_EVENTS, INGESTED_EVENTS
|
686
|
-
# training_data_schema: { # required
|
687
|
-
# model_variables: ["string"], # required
|
688
|
-
# label_schema: { # required
|
689
|
-
# label_mapper: { # required
|
690
|
-
# "string" => ["string"],
|
691
|
-
# },
|
692
|
-
# unlabeled_events_treatment: "IGNORE", # accepts IGNORE, FRAUD, LEGIT
|
693
|
-
# },
|
694
|
-
# },
|
695
|
-
# external_events_detail: {
|
696
|
-
# data_location: "s3BucketLocation", # required
|
697
|
-
# data_access_role_arn: "iamRoleArn", # required
|
698
|
-
# },
|
699
|
-
# ingested_events_detail: {
|
700
|
-
# ingested_events_time_window: { # required
|
701
|
-
# start_time: "time", # required
|
702
|
-
# end_time: "time", # required
|
703
|
-
# },
|
704
|
-
# },
|
705
|
-
# tags: [
|
706
|
-
# {
|
707
|
-
# key: "tagKey", # required
|
708
|
-
# value: "tagValue", # required
|
709
|
-
# },
|
710
|
-
# ],
|
711
|
-
# }
|
712
|
-
#
|
713
829
|
# @!attribute [rw] model_id
|
714
830
|
# The model ID.
|
715
831
|
# @return [String]
|
@@ -781,24 +897,6 @@ module Aws::FraudDetector
|
|
781
897
|
include Aws::Structure
|
782
898
|
end
|
783
899
|
|
784
|
-
# @note When making an API call, you may pass CreateRuleRequest
|
785
|
-
# data as a hash:
|
786
|
-
#
|
787
|
-
# {
|
788
|
-
# rule_id: "identifier", # required
|
789
|
-
# detector_id: "identifier", # required
|
790
|
-
# description: "description",
|
791
|
-
# expression: "ruleExpression", # required
|
792
|
-
# language: "DETECTORPL", # required, accepts DETECTORPL
|
793
|
-
# outcomes: ["string"], # required
|
794
|
-
# tags: [
|
795
|
-
# {
|
796
|
-
# key: "tagKey", # required
|
797
|
-
# value: "tagValue", # required
|
798
|
-
# },
|
799
|
-
# ],
|
800
|
-
# }
|
801
|
-
#
|
802
900
|
# @!attribute [rw] rule_id
|
803
901
|
# The rule ID.
|
804
902
|
# @return [String]
|
@@ -853,30 +951,12 @@ module Aws::FraudDetector
|
|
853
951
|
include Aws::Structure
|
854
952
|
end
|
855
953
|
|
856
|
-
# @note When making an API call, you may pass CreateVariableRequest
|
857
|
-
# data as a hash:
|
858
|
-
#
|
859
|
-
# {
|
860
|
-
# name: "string", # required
|
861
|
-
# data_type: "STRING", # required, accepts STRING, INTEGER, FLOAT, BOOLEAN
|
862
|
-
# data_source: "EVENT", # required, accepts EVENT, MODEL_SCORE, EXTERNAL_MODEL_SCORE
|
863
|
-
# default_value: "string", # required
|
864
|
-
# description: "string",
|
865
|
-
# variable_type: "string",
|
866
|
-
# tags: [
|
867
|
-
# {
|
868
|
-
# key: "tagKey", # required
|
869
|
-
# value: "tagValue", # required
|
870
|
-
# },
|
871
|
-
# ],
|
872
|
-
# }
|
873
|
-
#
|
874
954
|
# @!attribute [rw] name
|
875
955
|
# The name of the variable.
|
876
956
|
# @return [String]
|
877
957
|
#
|
878
958
|
# @!attribute [rw] data_type
|
879
|
-
# The data type.
|
959
|
+
# The data type of the variable.
|
880
960
|
# @return [String]
|
881
961
|
#
|
882
962
|
# @!attribute [rw] data_source
|
@@ -931,10 +1011,10 @@ module Aws::FraudDetector
|
|
931
1011
|
#
|
932
1012
|
class CreateVariableResult < Aws::EmptyStructure; end
|
933
1013
|
|
934
|
-
# The model training validation
|
1014
|
+
# The model training data validation metrics.
|
935
1015
|
#
|
936
1016
|
# @!attribute [rw] file_level_messages
|
937
|
-
# The file-specific model training validation messages.
|
1017
|
+
# The file-specific model training data validation messages.
|
938
1018
|
# @return [Array<Types::FileValidationMessage>]
|
939
1019
|
#
|
940
1020
|
# @!attribute [rw] field_level_messages
|
@@ -950,13 +1030,6 @@ module Aws::FraudDetector
|
|
950
1030
|
include Aws::Structure
|
951
1031
|
end
|
952
1032
|
|
953
|
-
# @note When making an API call, you may pass DeleteBatchImportJobRequest
|
954
|
-
# data as a hash:
|
955
|
-
#
|
956
|
-
# {
|
957
|
-
# job_id: "identifier", # required
|
958
|
-
# }
|
959
|
-
#
|
960
1033
|
# @!attribute [rw] job_id
|
961
1034
|
# The ID of the batch import job to delete.
|
962
1035
|
# @return [String]
|
@@ -973,13 +1046,6 @@ module Aws::FraudDetector
|
|
973
1046
|
#
|
974
1047
|
class DeleteBatchImportJobResult < Aws::EmptyStructure; end
|
975
1048
|
|
976
|
-
# @note When making an API call, you may pass DeleteBatchPredictionJobRequest
|
977
|
-
# data as a hash:
|
978
|
-
#
|
979
|
-
# {
|
980
|
-
# job_id: "identifier", # required
|
981
|
-
# }
|
982
|
-
#
|
983
1049
|
# @!attribute [rw] job_id
|
984
1050
|
# The ID of the batch prediction job to delete.
|
985
1051
|
# @return [String]
|
@@ -996,13 +1062,6 @@ module Aws::FraudDetector
|
|
996
1062
|
#
|
997
1063
|
class DeleteBatchPredictionJobResult < Aws::EmptyStructure; end
|
998
1064
|
|
999
|
-
# @note When making an API call, you may pass DeleteDetectorRequest
|
1000
|
-
# data as a hash:
|
1001
|
-
#
|
1002
|
-
# {
|
1003
|
-
# detector_id: "identifier", # required
|
1004
|
-
# }
|
1005
|
-
#
|
1006
1065
|
# @!attribute [rw] detector_id
|
1007
1066
|
# The ID of the detector to delete.
|
1008
1067
|
# @return [String]
|
@@ -1019,14 +1078,6 @@ module Aws::FraudDetector
|
|
1019
1078
|
#
|
1020
1079
|
class DeleteDetectorResult < Aws::EmptyStructure; end
|
1021
1080
|
|
1022
|
-
# @note When making an API call, you may pass DeleteDetectorVersionRequest
|
1023
|
-
# data as a hash:
|
1024
|
-
#
|
1025
|
-
# {
|
1026
|
-
# detector_id: "identifier", # required
|
1027
|
-
# detector_version_id: "wholeNumberVersionString", # required
|
1028
|
-
# }
|
1029
|
-
#
|
1030
1081
|
# @!attribute [rw] detector_id
|
1031
1082
|
# The ID of the parent detector for the detector version to delete.
|
1032
1083
|
# @return [String]
|
@@ -1048,13 +1099,6 @@ module Aws::FraudDetector
|
|
1048
1099
|
#
|
1049
1100
|
class DeleteDetectorVersionResult < Aws::EmptyStructure; end
|
1050
1101
|
|
1051
|
-
# @note When making an API call, you may pass DeleteEntityTypeRequest
|
1052
|
-
# data as a hash:
|
1053
|
-
#
|
1054
|
-
# {
|
1055
|
-
# name: "identifier", # required
|
1056
|
-
# }
|
1057
|
-
#
|
1058
1102
|
# @!attribute [rw] name
|
1059
1103
|
# The name of the entity type to delete.
|
1060
1104
|
# @return [String]
|
@@ -1071,15 +1115,6 @@ module Aws::FraudDetector
|
|
1071
1115
|
#
|
1072
1116
|
class DeleteEntityTypeResult < Aws::EmptyStructure; end
|
1073
1117
|
|
1074
|
-
# @note When making an API call, you may pass DeleteEventRequest
|
1075
|
-
# data as a hash:
|
1076
|
-
#
|
1077
|
-
# {
|
1078
|
-
# event_id: "identifier", # required
|
1079
|
-
# event_type_name: "identifier", # required
|
1080
|
-
# delete_audit_history: false,
|
1081
|
-
# }
|
1082
|
-
#
|
1083
1118
|
# @!attribute [rw] event_id
|
1084
1119
|
# The ID of the event to delete.
|
1085
1120
|
# @return [String]
|
@@ -1090,7 +1125,7 @@ module Aws::FraudDetector
|
|
1090
1125
|
#
|
1091
1126
|
# @!attribute [rw] delete_audit_history
|
1092
1127
|
# Specifies whether or not to delete any predictions associated with
|
1093
|
-
# the event.
|
1128
|
+
# the event. If set to `True`,
|
1094
1129
|
# @return [Boolean]
|
1095
1130
|
#
|
1096
1131
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteEventRequest AWS API Documentation
|
@@ -1107,13 +1142,6 @@ module Aws::FraudDetector
|
|
1107
1142
|
#
|
1108
1143
|
class DeleteEventResult < Aws::EmptyStructure; end
|
1109
1144
|
|
1110
|
-
# @note When making an API call, you may pass DeleteEventTypeRequest
|
1111
|
-
# data as a hash:
|
1112
|
-
#
|
1113
|
-
# {
|
1114
|
-
# name: "identifier", # required
|
1115
|
-
# }
|
1116
|
-
#
|
1117
1145
|
# @!attribute [rw] name
|
1118
1146
|
# The name of the event type to delete.
|
1119
1147
|
# @return [String]
|
@@ -1130,13 +1158,6 @@ module Aws::FraudDetector
|
|
1130
1158
|
#
|
1131
1159
|
class DeleteEventTypeResult < Aws::EmptyStructure; end
|
1132
1160
|
|
1133
|
-
# @note When making an API call, you may pass DeleteEventsByEventTypeRequest
|
1134
|
-
# data as a hash:
|
1135
|
-
#
|
1136
|
-
# {
|
1137
|
-
# event_type_name: "identifier", # required
|
1138
|
-
# }
|
1139
|
-
#
|
1140
1161
|
# @!attribute [rw] event_type_name
|
1141
1162
|
# The name of the event type.
|
1142
1163
|
# @return [String]
|
@@ -1166,13 +1187,6 @@ module Aws::FraudDetector
|
|
1166
1187
|
include Aws::Structure
|
1167
1188
|
end
|
1168
1189
|
|
1169
|
-
# @note When making an API call, you may pass DeleteExternalModelRequest
|
1170
|
-
# data as a hash:
|
1171
|
-
#
|
1172
|
-
# {
|
1173
|
-
# model_endpoint: "sageMakerEndpointIdentifier", # required
|
1174
|
-
# }
|
1175
|
-
#
|
1176
1190
|
# @!attribute [rw] model_endpoint
|
1177
1191
|
# The endpoint of the Amazon Sagemaker model to delete.
|
1178
1192
|
# @return [String]
|
@@ -1189,13 +1203,6 @@ module Aws::FraudDetector
|
|
1189
1203
|
#
|
1190
1204
|
class DeleteExternalModelResult < Aws::EmptyStructure; end
|
1191
1205
|
|
1192
|
-
# @note When making an API call, you may pass DeleteLabelRequest
|
1193
|
-
# data as a hash:
|
1194
|
-
#
|
1195
|
-
# {
|
1196
|
-
# name: "identifier", # required
|
1197
|
-
# }
|
1198
|
-
#
|
1199
1206
|
# @!attribute [rw] name
|
1200
1207
|
# The name of the label to delete.
|
1201
1208
|
# @return [String]
|
@@ -1212,14 +1219,22 @@ module Aws::FraudDetector
|
|
1212
1219
|
#
|
1213
1220
|
class DeleteLabelResult < Aws::EmptyStructure; end
|
1214
1221
|
|
1215
|
-
#
|
1216
|
-
#
|
1222
|
+
# @!attribute [rw] name
|
1223
|
+
# The name of the list to delete.
|
1224
|
+
# @return [String]
|
1217
1225
|
#
|
1218
|
-
#
|
1219
|
-
# model_id: "modelIdentifier", # required
|
1220
|
-
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
|
1221
|
-
# }
|
1226
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteListRequest AWS API Documentation
|
1222
1227
|
#
|
1228
|
+
class DeleteListRequest < Struct.new(
|
1229
|
+
:name)
|
1230
|
+
SENSITIVE = []
|
1231
|
+
include Aws::Structure
|
1232
|
+
end
|
1233
|
+
|
1234
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteListResult AWS API Documentation
|
1235
|
+
#
|
1236
|
+
class DeleteListResult < Aws::EmptyStructure; end
|
1237
|
+
|
1223
1238
|
# @!attribute [rw] model_id
|
1224
1239
|
# The model ID of the model to delete.
|
1225
1240
|
# @return [String]
|
@@ -1241,15 +1256,6 @@ module Aws::FraudDetector
|
|
1241
1256
|
#
|
1242
1257
|
class DeleteModelResult < Aws::EmptyStructure; end
|
1243
1258
|
|
1244
|
-
# @note When making an API call, you may pass DeleteModelVersionRequest
|
1245
|
-
# data as a hash:
|
1246
|
-
#
|
1247
|
-
# {
|
1248
|
-
# model_id: "modelIdentifier", # required
|
1249
|
-
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
|
1250
|
-
# model_version_number: "floatVersionString", # required
|
1251
|
-
# }
|
1252
|
-
#
|
1253
1259
|
# @!attribute [rw] model_id
|
1254
1260
|
# The model ID of the model version to delete.
|
1255
1261
|
# @return [String]
|
@@ -1276,13 +1282,6 @@ module Aws::FraudDetector
|
|
1276
1282
|
#
|
1277
1283
|
class DeleteModelVersionResult < Aws::EmptyStructure; end
|
1278
1284
|
|
1279
|
-
# @note When making an API call, you may pass DeleteOutcomeRequest
|
1280
|
-
# data as a hash:
|
1281
|
-
#
|
1282
|
-
# {
|
1283
|
-
# name: "identifier", # required
|
1284
|
-
# }
|
1285
|
-
#
|
1286
1285
|
# @!attribute [rw] name
|
1287
1286
|
# The name of the outcome to delete.
|
1288
1287
|
# @return [String]
|
@@ -1299,17 +1298,6 @@ module Aws::FraudDetector
|
|
1299
1298
|
#
|
1300
1299
|
class DeleteOutcomeResult < Aws::EmptyStructure; end
|
1301
1300
|
|
1302
|
-
# @note When making an API call, you may pass DeleteRuleRequest
|
1303
|
-
# data as a hash:
|
1304
|
-
#
|
1305
|
-
# {
|
1306
|
-
# rule: { # required
|
1307
|
-
# detector_id: "identifier", # required
|
1308
|
-
# rule_id: "identifier", # required
|
1309
|
-
# rule_version: "wholeNumberVersionString", # required
|
1310
|
-
# },
|
1311
|
-
# }
|
1312
|
-
#
|
1313
1301
|
# @!attribute [rw] rule
|
1314
1302
|
# A rule.
|
1315
1303
|
# @return [Types::Rule]
|
@@ -1326,13 +1314,6 @@ module Aws::FraudDetector
|
|
1326
1314
|
#
|
1327
1315
|
class DeleteRuleResult < Aws::EmptyStructure; end
|
1328
1316
|
|
1329
|
-
# @note When making an API call, you may pass DeleteVariableRequest
|
1330
|
-
# data as a hash:
|
1331
|
-
#
|
1332
|
-
# {
|
1333
|
-
# name: "string", # required
|
1334
|
-
# }
|
1335
|
-
#
|
1336
1317
|
# @!attribute [rw] name
|
1337
1318
|
# The name of the variable to delete.
|
1338
1319
|
# @return [String]
|
@@ -1349,15 +1330,6 @@ module Aws::FraudDetector
|
|
1349
1330
|
#
|
1350
1331
|
class DeleteVariableResult < Aws::EmptyStructure; end
|
1351
1332
|
|
1352
|
-
# @note When making an API call, you may pass DescribeDetectorRequest
|
1353
|
-
# data as a hash:
|
1354
|
-
#
|
1355
|
-
# {
|
1356
|
-
# detector_id: "identifier", # required
|
1357
|
-
# next_token: "string",
|
1358
|
-
# max_results: 1,
|
1359
|
-
# }
|
1360
|
-
#
|
1361
1333
|
# @!attribute [rw] detector_id
|
1362
1334
|
# The detector ID.
|
1363
1335
|
# @return [String]
|
@@ -1407,17 +1379,6 @@ module Aws::FraudDetector
|
|
1407
1379
|
include Aws::Structure
|
1408
1380
|
end
|
1409
1381
|
|
1410
|
-
# @note When making an API call, you may pass DescribeModelVersionsRequest
|
1411
|
-
# data as a hash:
|
1412
|
-
#
|
1413
|
-
# {
|
1414
|
-
# model_id: "modelIdentifier",
|
1415
|
-
# model_version_number: "floatVersionString",
|
1416
|
-
# model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
|
1417
|
-
# next_token: "string",
|
1418
|
-
# max_results: 1,
|
1419
|
-
# }
|
1420
|
-
#
|
1421
1382
|
# @!attribute [rw] model_id
|
1422
1383
|
# The model ID.
|
1423
1384
|
# @return [String]
|
@@ -1537,14 +1498,6 @@ module Aws::FraudDetector
|
|
1537
1498
|
|
1538
1499
|
# The entity details.
|
1539
1500
|
#
|
1540
|
-
# @note When making an API call, you may pass Entity
|
1541
|
-
# data as a hash:
|
1542
|
-
#
|
1543
|
-
# {
|
1544
|
-
# entity_type: "string", # required
|
1545
|
-
# entity_id: "entityRestrictedString", # required
|
1546
|
-
# }
|
1547
|
-
#
|
1548
1501
|
# @!attribute [rw] entity_type
|
1549
1502
|
# The entity type.
|
1550
1503
|
# @return [String]
|
@@ -1597,58 +1550,218 @@ module Aws::FraudDetector
|
|
1597
1550
|
include Aws::Structure
|
1598
1551
|
end
|
1599
1552
|
|
1600
|
-
# The
|
1553
|
+
# The details of the external (Amazon Sagemaker) model evaluated for
|
1554
|
+
# generating predictions.
|
1601
1555
|
#
|
1602
|
-
# @!attribute [rw]
|
1603
|
-
# The
|
1556
|
+
# @!attribute [rw] model_endpoint
|
1557
|
+
# The endpoint of the external (Amazon Sagemaker) model.
|
1604
1558
|
# @return [String]
|
1605
1559
|
#
|
1606
|
-
# @!attribute [rw]
|
1607
|
-
#
|
1608
|
-
# @return [
|
1560
|
+
# @!attribute [rw] use_event_variables
|
1561
|
+
# Indicates whether event variables were used to generate predictions.
|
1562
|
+
# @return [Boolean]
|
1609
1563
|
#
|
1610
|
-
# @!attribute [rw]
|
1611
|
-
#
|
1612
|
-
#
|
1613
|
-
# @return [String]
|
1564
|
+
# @!attribute [rw] input_variables
|
1565
|
+
# Input variables use for generating predictions.
|
1566
|
+
# @return [Hash<String,String>]
|
1614
1567
|
#
|
1615
|
-
# @!attribute [rw]
|
1616
|
-
#
|
1617
|
-
# Detector to represent data elements and their corresponding values
|
1618
|
-
# for the event you are sending for evaluation.
|
1568
|
+
# @!attribute [rw] output_variables
|
1569
|
+
# Output variables.
|
1619
1570
|
# @return [Hash<String,String>]
|
1620
1571
|
#
|
1621
|
-
#
|
1622
|
-
#
|
1572
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/EvaluatedExternalModel AWS API Documentation
|
1573
|
+
#
|
1574
|
+
class EvaluatedExternalModel < Struct.new(
|
1575
|
+
:model_endpoint,
|
1576
|
+
:use_event_variables,
|
1577
|
+
:input_variables,
|
1578
|
+
:output_variables)
|
1579
|
+
SENSITIVE = [:input_variables, :output_variables]
|
1580
|
+
include Aws::Structure
|
1581
|
+
end
|
1582
|
+
|
1583
|
+
# The model version evaluated for generating prediction.
|
1584
|
+
#
|
1585
|
+
# @!attribute [rw] model_id
|
1586
|
+
# The model ID.
|
1623
1587
|
# @return [String]
|
1624
1588
|
#
|
1625
|
-
# @!attribute [rw]
|
1626
|
-
# The
|
1627
|
-
# must be specified using ISO 8601 standard in UTC.
|
1589
|
+
# @!attribute [rw] model_version
|
1590
|
+
# The model version.
|
1628
1591
|
# @return [String]
|
1629
1592
|
#
|
1630
|
-
# @!attribute [rw]
|
1631
|
-
# The
|
1632
|
-
# @return [Array<Types::Entity>]
|
1593
|
+
# @!attribute [rw] model_type
|
1594
|
+
# The model type.
|
1633
1595
|
#
|
1634
|
-
#
|
1596
|
+
# Valid values: `ONLINE_FRAUD_INSIGHTS` \|
|
1597
|
+
# `TRANSACTION_FRAUD_INSIGHTS`
|
1598
|
+
# @return [String]
|
1635
1599
|
#
|
1636
|
-
|
1637
|
-
|
1638
|
-
|
1639
|
-
|
1640
|
-
|
1641
|
-
|
1642
|
-
|
1643
|
-
:
|
1600
|
+
# @!attribute [rw] evaluations
|
1601
|
+
# Evaluations generated for the model version.
|
1602
|
+
# @return [Array<Types::ModelVersionEvaluation>]
|
1603
|
+
#
|
1604
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/EvaluatedModelVersion AWS API Documentation
|
1605
|
+
#
|
1606
|
+
class EvaluatedModelVersion < Struct.new(
|
1607
|
+
:model_id,
|
1608
|
+
:model_version,
|
1609
|
+
:model_type,
|
1610
|
+
:evaluations)
|
1644
1611
|
SENSITIVE = []
|
1645
1612
|
include Aws::Structure
|
1646
1613
|
end
|
1647
1614
|
|
1648
|
-
# The
|
1615
|
+
# The details of the rule used for evaluating variable values.
|
1649
1616
|
#
|
1650
|
-
# @!attribute [rw]
|
1651
|
-
# The
|
1617
|
+
# @!attribute [rw] rule_id
|
1618
|
+
# The rule ID.
|
1619
|
+
# @return [String]
|
1620
|
+
#
|
1621
|
+
# @!attribute [rw] rule_version
|
1622
|
+
# The rule version.
|
1623
|
+
# @return [String]
|
1624
|
+
#
|
1625
|
+
# @!attribute [rw] expression
|
1626
|
+
# The rule expression.
|
1627
|
+
# @return [String]
|
1628
|
+
#
|
1629
|
+
# @!attribute [rw] expression_with_values
|
1630
|
+
# The rule expression value.
|
1631
|
+
# @return [String]
|
1632
|
+
#
|
1633
|
+
# @!attribute [rw] outcomes
|
1634
|
+
# The rule outcome.
|
1635
|
+
# @return [Array<String>]
|
1636
|
+
#
|
1637
|
+
# @!attribute [rw] evaluated
|
1638
|
+
# Indicates whether the rule was evaluated.
|
1639
|
+
# @return [Boolean]
|
1640
|
+
#
|
1641
|
+
# @!attribute [rw] matched
|
1642
|
+
# Indicates whether the rule matched.
|
1643
|
+
# @return [Boolean]
|
1644
|
+
#
|
1645
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/EvaluatedRule AWS API Documentation
|
1646
|
+
#
|
1647
|
+
class EvaluatedRule < Struct.new(
|
1648
|
+
:rule_id,
|
1649
|
+
:rule_version,
|
1650
|
+
:expression,
|
1651
|
+
:expression_with_values,
|
1652
|
+
:outcomes,
|
1653
|
+
:evaluated,
|
1654
|
+
:matched)
|
1655
|
+
SENSITIVE = [:expression, :expression_with_values]
|
1656
|
+
include Aws::Structure
|
1657
|
+
end
|
1658
|
+
|
1659
|
+
# The event details.
|
1660
|
+
#
|
1661
|
+
# @!attribute [rw] event_id
|
1662
|
+
# The event ID.
|
1663
|
+
# @return [String]
|
1664
|
+
#
|
1665
|
+
# @!attribute [rw] event_type_name
|
1666
|
+
# The event type.
|
1667
|
+
# @return [String]
|
1668
|
+
#
|
1669
|
+
# @!attribute [rw] event_timestamp
|
1670
|
+
# The timestamp that defines when the event under evaluation occurred.
|
1671
|
+
# The timestamp must be specified using ISO 8601 standard in UTC.
|
1672
|
+
# @return [String]
|
1673
|
+
#
|
1674
|
+
# @!attribute [rw] event_variables
|
1675
|
+
# Names of the event type's variables you defined in Amazon Fraud
|
1676
|
+
# Detector to represent data elements and their corresponding values
|
1677
|
+
# for the event you are sending for evaluation.
|
1678
|
+
# @return [Hash<String,String>]
|
1679
|
+
#
|
1680
|
+
# @!attribute [rw] current_label
|
1681
|
+
# The label associated with the event.
|
1682
|
+
# @return [String]
|
1683
|
+
#
|
1684
|
+
# @!attribute [rw] label_timestamp
|
1685
|
+
# The timestamp associated with the label to update. The timestamp
|
1686
|
+
# must be specified using ISO 8601 standard in UTC.
|
1687
|
+
# @return [String]
|
1688
|
+
#
|
1689
|
+
# @!attribute [rw] entities
|
1690
|
+
# The event entities.
|
1691
|
+
# @return [Array<Types::Entity>]
|
1692
|
+
#
|
1693
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Event AWS API Documentation
|
1694
|
+
#
|
1695
|
+
class Event < Struct.new(
|
1696
|
+
:event_id,
|
1697
|
+
:event_type_name,
|
1698
|
+
:event_timestamp,
|
1699
|
+
:event_variables,
|
1700
|
+
:current_label,
|
1701
|
+
:label_timestamp,
|
1702
|
+
:entities)
|
1703
|
+
SENSITIVE = []
|
1704
|
+
include Aws::Structure
|
1705
|
+
end
|
1706
|
+
|
1707
|
+
# The event orchestration status.
|
1708
|
+
#
|
1709
|
+
# @!attribute [rw] event_bridge_enabled
|
1710
|
+
# Specifies if event orchestration is enabled through Amazon
|
1711
|
+
# EventBridge.
|
1712
|
+
# @return [Boolean]
|
1713
|
+
#
|
1714
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/EventOrchestration AWS API Documentation
|
1715
|
+
#
|
1716
|
+
class EventOrchestration < Struct.new(
|
1717
|
+
:event_bridge_enabled)
|
1718
|
+
SENSITIVE = []
|
1719
|
+
include Aws::Structure
|
1720
|
+
end
|
1721
|
+
|
1722
|
+
# Information about the summary of an event prediction.
|
1723
|
+
#
|
1724
|
+
# @!attribute [rw] event_id
|
1725
|
+
# The event ID.
|
1726
|
+
# @return [String]
|
1727
|
+
#
|
1728
|
+
# @!attribute [rw] event_type_name
|
1729
|
+
# The event type.
|
1730
|
+
# @return [String]
|
1731
|
+
#
|
1732
|
+
# @!attribute [rw] event_timestamp
|
1733
|
+
# The timestamp of the event.
|
1734
|
+
# @return [String]
|
1735
|
+
#
|
1736
|
+
# @!attribute [rw] prediction_timestamp
|
1737
|
+
# The timestamp when the prediction was generated.
|
1738
|
+
# @return [String]
|
1739
|
+
#
|
1740
|
+
# @!attribute [rw] detector_id
|
1741
|
+
# The detector ID.
|
1742
|
+
# @return [String]
|
1743
|
+
#
|
1744
|
+
# @!attribute [rw] detector_version_id
|
1745
|
+
# The detector version ID.
|
1746
|
+
# @return [String]
|
1747
|
+
#
|
1748
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/EventPredictionSummary AWS API Documentation
|
1749
|
+
#
|
1750
|
+
class EventPredictionSummary < Struct.new(
|
1751
|
+
:event_id,
|
1752
|
+
:event_type_name,
|
1753
|
+
:event_timestamp,
|
1754
|
+
:prediction_timestamp,
|
1755
|
+
:detector_id,
|
1756
|
+
:detector_version_id)
|
1757
|
+
SENSITIVE = []
|
1758
|
+
include Aws::Structure
|
1759
|
+
end
|
1760
|
+
|
1761
|
+
# The event type details.
|
1762
|
+
#
|
1763
|
+
# @!attribute [rw] name
|
1764
|
+
# The event type name.
|
1652
1765
|
# @return [String]
|
1653
1766
|
#
|
1654
1767
|
# @!attribute [rw] description
|
@@ -1691,6 +1804,10 @@ module Aws::FraudDetector
|
|
1691
1804
|
# The entity type ARN.
|
1692
1805
|
# @return [String]
|
1693
1806
|
#
|
1807
|
+
# @!attribute [rw] event_orchestration
|
1808
|
+
# The event orchestration status.
|
1809
|
+
# @return [Types::EventOrchestration]
|
1810
|
+
#
|
1694
1811
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/EventType AWS API Documentation
|
1695
1812
|
#
|
1696
1813
|
class EventType < Struct.new(
|
@@ -1703,20 +1820,38 @@ module Aws::FraudDetector
|
|
1703
1820
|
:ingested_event_statistics,
|
1704
1821
|
:last_updated_time,
|
1705
1822
|
:created_time,
|
1706
|
-
:arn
|
1823
|
+
:arn,
|
1824
|
+
:event_orchestration)
|
1707
1825
|
SENSITIVE = []
|
1708
1826
|
include Aws::Structure
|
1709
1827
|
end
|
1710
1828
|
|
1711
|
-
#
|
1829
|
+
# Information about the summary of an event variable that was evaluated
|
1830
|
+
# for generating prediction.
|
1831
|
+
#
|
1832
|
+
# @!attribute [rw] name
|
1833
|
+
# The event variable name.
|
1834
|
+
# @return [String]
|
1835
|
+
#
|
1836
|
+
# @!attribute [rw] value
|
1837
|
+
# The value of the event variable.
|
1838
|
+
# @return [String]
|
1712
1839
|
#
|
1713
|
-
#
|
1714
|
-
#
|
1840
|
+
# @!attribute [rw] source
|
1841
|
+
# The event variable source.
|
1842
|
+
# @return [String]
|
1715
1843
|
#
|
1716
|
-
#
|
1717
|
-
#
|
1718
|
-
|
1719
|
-
|
1844
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/EventVariableSummary AWS API Documentation
|
1845
|
+
#
|
1846
|
+
class EventVariableSummary < Struct.new(
|
1847
|
+
:name,
|
1848
|
+
:value,
|
1849
|
+
:source)
|
1850
|
+
SENSITIVE = [:name, :value, :source]
|
1851
|
+
include Aws::Structure
|
1852
|
+
end
|
1853
|
+
|
1854
|
+
# Details for the external events data used for model version training.
|
1720
1855
|
#
|
1721
1856
|
# @!attribute [rw] data_location
|
1722
1857
|
# The Amazon S3 bucket location for the data.
|
@@ -1886,15 +2021,21 @@ module Aws::FraudDetector
|
|
1886
2021
|
include Aws::Structure
|
1887
2022
|
end
|
1888
2023
|
|
1889
|
-
#
|
1890
|
-
# data as a hash:
|
2024
|
+
# A conditional statement for filtering a list of past predictions.
|
1891
2025
|
#
|
1892
|
-
#
|
1893
|
-
#
|
1894
|
-
#
|
1895
|
-
#
|
1896
|
-
#
|
2026
|
+
# @!attribute [rw] value
|
2027
|
+
# A statement containing a resource property and a value to specify
|
2028
|
+
# filter condition.
|
2029
|
+
# @return [String]
|
2030
|
+
#
|
2031
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/FilterCondition AWS API Documentation
|
1897
2032
|
#
|
2033
|
+
class FilterCondition < Struct.new(
|
2034
|
+
:value)
|
2035
|
+
SENSITIVE = []
|
2036
|
+
include Aws::Structure
|
2037
|
+
end
|
2038
|
+
|
1898
2039
|
# @!attribute [rw] job_id
|
1899
2040
|
# The ID of the batch import job to get.
|
1900
2041
|
# @return [String]
|
@@ -1934,15 +2075,6 @@ module Aws::FraudDetector
|
|
1934
2075
|
include Aws::Structure
|
1935
2076
|
end
|
1936
2077
|
|
1937
|
-
# @note When making an API call, you may pass GetBatchPredictionJobsRequest
|
1938
|
-
# data as a hash:
|
1939
|
-
#
|
1940
|
-
# {
|
1941
|
-
# job_id: "identifier",
|
1942
|
-
# max_results: 1,
|
1943
|
-
# next_token: "string",
|
1944
|
-
# }
|
1945
|
-
#
|
1946
2078
|
# @!attribute [rw] job_id
|
1947
2079
|
# The batch prediction job for which to get the details.
|
1948
2080
|
# @return [String]
|
@@ -1982,13 +2114,6 @@ module Aws::FraudDetector
|
|
1982
2114
|
include Aws::Structure
|
1983
2115
|
end
|
1984
2116
|
|
1985
|
-
# @note When making an API call, you may pass GetDeleteEventsByEventTypeStatusRequest
|
1986
|
-
# data as a hash:
|
1987
|
-
#
|
1988
|
-
# {
|
1989
|
-
# event_type_name: "identifier", # required
|
1990
|
-
# }
|
1991
|
-
#
|
1992
2117
|
# @!attribute [rw] event_type_name
|
1993
2118
|
# Name of event type for which to get the deletion status.
|
1994
2119
|
# @return [String]
|
@@ -2018,14 +2143,6 @@ module Aws::FraudDetector
|
|
2018
2143
|
include Aws::Structure
|
2019
2144
|
end
|
2020
2145
|
|
2021
|
-
# @note When making an API call, you may pass GetDetectorVersionRequest
|
2022
|
-
# data as a hash:
|
2023
|
-
#
|
2024
|
-
# {
|
2025
|
-
# detector_id: "identifier", # required
|
2026
|
-
# detector_version_id: "wholeNumberVersionString", # required
|
2027
|
-
# }
|
2028
|
-
#
|
2029
2146
|
# @!attribute [rw] detector_id
|
2030
2147
|
# The detector ID.
|
2031
2148
|
# @return [String]
|
@@ -2116,15 +2233,6 @@ module Aws::FraudDetector
|
|
2116
2233
|
include Aws::Structure
|
2117
2234
|
end
|
2118
2235
|
|
2119
|
-
# @note When making an API call, you may pass GetDetectorsRequest
|
2120
|
-
# data as a hash:
|
2121
|
-
#
|
2122
|
-
# {
|
2123
|
-
# detector_id: "identifier",
|
2124
|
-
# next_token: "string",
|
2125
|
-
# max_results: 1,
|
2126
|
-
# }
|
2127
|
-
#
|
2128
2236
|
# @!attribute [rw] detector_id
|
2129
2237
|
# The detector ID.
|
2130
2238
|
# @return [String]
|
@@ -2164,15 +2272,6 @@ module Aws::FraudDetector
|
|
2164
2272
|
include Aws::Structure
|
2165
2273
|
end
|
2166
2274
|
|
2167
|
-
# @note When making an API call, you may pass GetEntityTypesRequest
|
2168
|
-
# data as a hash:
|
2169
|
-
#
|
2170
|
-
# {
|
2171
|
-
# name: "identifier",
|
2172
|
-
# next_token: "string",
|
2173
|
-
# max_results: 1,
|
2174
|
-
# }
|
2175
|
-
#
|
2176
2275
|
# @!attribute [rw] name
|
2177
2276
|
# The name.
|
2178
2277
|
# @return [String]
|
@@ -2212,32 +2311,134 @@ module Aws::FraudDetector
|
|
2212
2311
|
include Aws::Structure
|
2213
2312
|
end
|
2214
2313
|
|
2215
|
-
#
|
2216
|
-
#
|
2217
|
-
#
|
2218
|
-
#
|
2219
|
-
#
|
2220
|
-
#
|
2221
|
-
#
|
2222
|
-
#
|
2223
|
-
# entities: [ # required
|
2224
|
-
# {
|
2225
|
-
# entity_type: "string", # required
|
2226
|
-
# entity_id: "entityRestrictedString", # required
|
2227
|
-
# },
|
2228
|
-
# ],
|
2229
|
-
# event_timestamp: "utcTimestampISO8601", # required
|
2230
|
-
# event_variables: { # required
|
2231
|
-
# "variableName" => "variableValue",
|
2232
|
-
# },
|
2233
|
-
# external_model_endpoint_data_blobs: {
|
2234
|
-
# "sageMakerEndpointIdentifier" => {
|
2235
|
-
# byte_buffer: "data",
|
2236
|
-
# content_type: "contentType",
|
2237
|
-
# },
|
2238
|
-
# },
|
2239
|
-
# }
|
2314
|
+
# @!attribute [rw] event_id
|
2315
|
+
# The event ID.
|
2316
|
+
# @return [String]
|
2317
|
+
#
|
2318
|
+
# @!attribute [rw] event_type_name
|
2319
|
+
# The event type associated with the detector specified for the
|
2320
|
+
# prediction.
|
2321
|
+
# @return [String]
|
2240
2322
|
#
|
2323
|
+
# @!attribute [rw] detector_id
|
2324
|
+
# The detector ID.
|
2325
|
+
# @return [String]
|
2326
|
+
#
|
2327
|
+
# @!attribute [rw] detector_version_id
|
2328
|
+
# The detector version ID.
|
2329
|
+
# @return [String]
|
2330
|
+
#
|
2331
|
+
# @!attribute [rw] prediction_timestamp
|
2332
|
+
# The timestamp that defines when the prediction was generated. The
|
2333
|
+
# timestamp must be specified using ISO 8601 standard in UTC.
|
2334
|
+
#
|
2335
|
+
# We recommend calling [ListEventPredictions][1] first, and using the
|
2336
|
+
# `predictionTimestamp` value in the response to provide an accurate
|
2337
|
+
# prediction timestamp value.
|
2338
|
+
#
|
2339
|
+
#
|
2340
|
+
#
|
2341
|
+
# [1]: https://docs.aws.amazon.com/frauddetector/latest/api/API_ListEventPredictions.html
|
2342
|
+
# @return [String]
|
2343
|
+
#
|
2344
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventPredictionMetadataRequest AWS API Documentation
|
2345
|
+
#
|
2346
|
+
class GetEventPredictionMetadataRequest < Struct.new(
|
2347
|
+
:event_id,
|
2348
|
+
:event_type_name,
|
2349
|
+
:detector_id,
|
2350
|
+
:detector_version_id,
|
2351
|
+
:prediction_timestamp)
|
2352
|
+
SENSITIVE = []
|
2353
|
+
include Aws::Structure
|
2354
|
+
end
|
2355
|
+
|
2356
|
+
# @!attribute [rw] event_id
|
2357
|
+
# The event ID.
|
2358
|
+
# @return [String]
|
2359
|
+
#
|
2360
|
+
# @!attribute [rw] event_type_name
|
2361
|
+
# The event type associated with the detector specified for this
|
2362
|
+
# prediction.
|
2363
|
+
# @return [String]
|
2364
|
+
#
|
2365
|
+
# @!attribute [rw] entity_id
|
2366
|
+
# The entity ID.
|
2367
|
+
# @return [String]
|
2368
|
+
#
|
2369
|
+
# @!attribute [rw] entity_type
|
2370
|
+
# The entity type.
|
2371
|
+
# @return [String]
|
2372
|
+
#
|
2373
|
+
# @!attribute [rw] event_timestamp
|
2374
|
+
# The timestamp for when the prediction was generated for the
|
2375
|
+
# associated event ID.
|
2376
|
+
# @return [String]
|
2377
|
+
#
|
2378
|
+
# @!attribute [rw] detector_id
|
2379
|
+
# The detector ID.
|
2380
|
+
# @return [String]
|
2381
|
+
#
|
2382
|
+
# @!attribute [rw] detector_version_id
|
2383
|
+
# The detector version ID.
|
2384
|
+
# @return [String]
|
2385
|
+
#
|
2386
|
+
# @!attribute [rw] detector_version_status
|
2387
|
+
# The status of the detector version.
|
2388
|
+
# @return [String]
|
2389
|
+
#
|
2390
|
+
# @!attribute [rw] event_variables
|
2391
|
+
# A list of event variables that influenced the prediction scores.
|
2392
|
+
# @return [Array<Types::EventVariableSummary>]
|
2393
|
+
#
|
2394
|
+
# @!attribute [rw] rules
|
2395
|
+
# List of rules associated with the detector version that were used
|
2396
|
+
# for evaluating variable values.
|
2397
|
+
# @return [Array<Types::EvaluatedRule>]
|
2398
|
+
#
|
2399
|
+
# @!attribute [rw] rule_execution_mode
|
2400
|
+
# The execution mode of the rule used for evaluating variable values.
|
2401
|
+
# @return [String]
|
2402
|
+
#
|
2403
|
+
# @!attribute [rw] outcomes
|
2404
|
+
# The outcomes of the matched rule, based on the rule execution mode.
|
2405
|
+
# @return [Array<String>]
|
2406
|
+
#
|
2407
|
+
# @!attribute [rw] evaluated_model_versions
|
2408
|
+
# Model versions that were evaluated for generating predictions.
|
2409
|
+
# @return [Array<Types::EvaluatedModelVersion>]
|
2410
|
+
#
|
2411
|
+
# @!attribute [rw] evaluated_external_models
|
2412
|
+
# External (Amazon SageMaker) models that were evaluated for
|
2413
|
+
# generating predictions.
|
2414
|
+
# @return [Array<Types::EvaluatedExternalModel>]
|
2415
|
+
#
|
2416
|
+
# @!attribute [rw] prediction_timestamp
|
2417
|
+
# The timestamp that defines when the prediction was generated.
|
2418
|
+
# @return [String]
|
2419
|
+
#
|
2420
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventPredictionMetadataResult AWS API Documentation
|
2421
|
+
#
|
2422
|
+
class GetEventPredictionMetadataResult < Struct.new(
|
2423
|
+
:event_id,
|
2424
|
+
:event_type_name,
|
2425
|
+
:entity_id,
|
2426
|
+
:entity_type,
|
2427
|
+
:event_timestamp,
|
2428
|
+
:detector_id,
|
2429
|
+
:detector_version_id,
|
2430
|
+
:detector_version_status,
|
2431
|
+
:event_variables,
|
2432
|
+
:rules,
|
2433
|
+
:rule_execution_mode,
|
2434
|
+
:outcomes,
|
2435
|
+
:evaluated_model_versions,
|
2436
|
+
:evaluated_external_models,
|
2437
|
+
:prediction_timestamp)
|
2438
|
+
SENSITIVE = []
|
2439
|
+
include Aws::Structure
|
2440
|
+
end
|
2441
|
+
|
2241
2442
|
# @!attribute [rw] detector_id
|
2242
2443
|
# The detector ID.
|
2243
2444
|
# @return [String]
|
@@ -2339,14 +2540,6 @@ module Aws::FraudDetector
|
|
2339
2540
|
include Aws::Structure
|
2340
2541
|
end
|
2341
2542
|
|
2342
|
-
# @note When making an API call, you may pass GetEventRequest
|
2343
|
-
# data as a hash:
|
2344
|
-
#
|
2345
|
-
# {
|
2346
|
-
# event_id: "string", # required
|
2347
|
-
# event_type_name: "string", # required
|
2348
|
-
# }
|
2349
|
-
#
|
2350
2543
|
# @!attribute [rw] event_id
|
2351
2544
|
# The ID of the event to retrieve.
|
2352
2545
|
# @return [String]
|
@@ -2376,15 +2569,6 @@ module Aws::FraudDetector
|
|
2376
2569
|
include Aws::Structure
|
2377
2570
|
end
|
2378
2571
|
|
2379
|
-
# @note When making an API call, you may pass GetEventTypesRequest
|
2380
|
-
# data as a hash:
|
2381
|
-
#
|
2382
|
-
# {
|
2383
|
-
# name: "identifier",
|
2384
|
-
# next_token: "string",
|
2385
|
-
# max_results: 1,
|
2386
|
-
# }
|
2387
|
-
#
|
2388
2572
|
# @!attribute [rw] name
|
2389
2573
|
# The name.
|
2390
2574
|
# @return [String]
|
@@ -2424,15 +2608,6 @@ module Aws::FraudDetector
|
|
2424
2608
|
include Aws::Structure
|
2425
2609
|
end
|
2426
2610
|
|
2427
|
-
# @note When making an API call, you may pass GetExternalModelsRequest
|
2428
|
-
# data as a hash:
|
2429
|
-
#
|
2430
|
-
# {
|
2431
|
-
# model_endpoint: "string",
|
2432
|
-
# next_token: "string",
|
2433
|
-
# max_results: 1,
|
2434
|
-
# }
|
2435
|
-
#
|
2436
2611
|
# @!attribute [rw] model_endpoint
|
2437
2612
|
# The Amazon SageMaker model endpoint.
|
2438
2613
|
# @return [String]
|
@@ -2484,15 +2659,6 @@ module Aws::FraudDetector
|
|
2484
2659
|
include Aws::Structure
|
2485
2660
|
end
|
2486
2661
|
|
2487
|
-
# @note When making an API call, you may pass GetLabelsRequest
|
2488
|
-
# data as a hash:
|
2489
|
-
#
|
2490
|
-
# {
|
2491
|
-
# name: "identifier",
|
2492
|
-
# next_token: "string",
|
2493
|
-
# max_results: 1,
|
2494
|
-
# }
|
2495
|
-
#
|
2496
2662
|
# @!attribute [rw] name
|
2497
2663
|
# The name of the label or labels to get.
|
2498
2664
|
# @return [String]
|
@@ -2532,15 +2698,84 @@ module Aws::FraudDetector
|
|
2532
2698
|
include Aws::Structure
|
2533
2699
|
end
|
2534
2700
|
|
2535
|
-
#
|
2536
|
-
#
|
2701
|
+
# @!attribute [rw] name
|
2702
|
+
# The name of the list.
|
2703
|
+
# @return [String]
|
2537
2704
|
#
|
2538
|
-
#
|
2539
|
-
#
|
2540
|
-
#
|
2541
|
-
# model_version_number: "floatVersionString", # required
|
2542
|
-
# }
|
2705
|
+
# @!attribute [rw] next_token
|
2706
|
+
# The next token for the subsequent request.
|
2707
|
+
# @return [String]
|
2543
2708
|
#
|
2709
|
+
# @!attribute [rw] max_results
|
2710
|
+
# The maximum number of objects to return for the request.
|
2711
|
+
# @return [Integer]
|
2712
|
+
#
|
2713
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetListElementsRequest AWS API Documentation
|
2714
|
+
#
|
2715
|
+
class GetListElementsRequest < Struct.new(
|
2716
|
+
:name,
|
2717
|
+
:next_token,
|
2718
|
+
:max_results)
|
2719
|
+
SENSITIVE = []
|
2720
|
+
include Aws::Structure
|
2721
|
+
end
|
2722
|
+
|
2723
|
+
# @!attribute [rw] elements
|
2724
|
+
# The list elements.
|
2725
|
+
# @return [Array<String>]
|
2726
|
+
#
|
2727
|
+
# @!attribute [rw] next_token
|
2728
|
+
# The next page token.
|
2729
|
+
# @return [String]
|
2730
|
+
#
|
2731
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetListElementsResult AWS API Documentation
|
2732
|
+
#
|
2733
|
+
class GetListElementsResult < Struct.new(
|
2734
|
+
:elements,
|
2735
|
+
:next_token)
|
2736
|
+
SENSITIVE = []
|
2737
|
+
include Aws::Structure
|
2738
|
+
end
|
2739
|
+
|
2740
|
+
# @!attribute [rw] name
|
2741
|
+
# The name of the list.
|
2742
|
+
# @return [String]
|
2743
|
+
#
|
2744
|
+
# @!attribute [rw] next_token
|
2745
|
+
# The next token for the subsequent request.
|
2746
|
+
# @return [String]
|
2747
|
+
#
|
2748
|
+
# @!attribute [rw] max_results
|
2749
|
+
# The maximum number of objects to return for the request.
|
2750
|
+
# @return [Integer]
|
2751
|
+
#
|
2752
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetListsMetadataRequest AWS API Documentation
|
2753
|
+
#
|
2754
|
+
class GetListsMetadataRequest < Struct.new(
|
2755
|
+
:name,
|
2756
|
+
:next_token,
|
2757
|
+
:max_results)
|
2758
|
+
SENSITIVE = []
|
2759
|
+
include Aws::Structure
|
2760
|
+
end
|
2761
|
+
|
2762
|
+
# @!attribute [rw] lists
|
2763
|
+
# The metadata of the specified list or all lists under the account.
|
2764
|
+
# @return [Array<Types::AllowDenyList>]
|
2765
|
+
#
|
2766
|
+
# @!attribute [rw] next_token
|
2767
|
+
# The next page token.
|
2768
|
+
# @return [String]
|
2769
|
+
#
|
2770
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetListsMetadataResult AWS API Documentation
|
2771
|
+
#
|
2772
|
+
class GetListsMetadataResult < Struct.new(
|
2773
|
+
:lists,
|
2774
|
+
:next_token)
|
2775
|
+
SENSITIVE = []
|
2776
|
+
include Aws::Structure
|
2777
|
+
end
|
2778
|
+
|
2544
2779
|
# @!attribute [rw] model_id
|
2545
2780
|
# The model ID.
|
2546
2781
|
# @return [String]
|
@@ -2639,16 +2874,6 @@ module Aws::FraudDetector
|
|
2639
2874
|
include Aws::Structure
|
2640
2875
|
end
|
2641
2876
|
|
2642
|
-
# @note When making an API call, you may pass GetModelsRequest
|
2643
|
-
# data as a hash:
|
2644
|
-
#
|
2645
|
-
# {
|
2646
|
-
# model_id: "modelIdentifier",
|
2647
|
-
# model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
|
2648
|
-
# next_token: "string",
|
2649
|
-
# max_results: 1,
|
2650
|
-
# }
|
2651
|
-
#
|
2652
2877
|
# @!attribute [rw] model_id
|
2653
2878
|
# The model ID.
|
2654
2879
|
# @return [String]
|
@@ -2693,15 +2918,6 @@ module Aws::FraudDetector
|
|
2693
2918
|
include Aws::Structure
|
2694
2919
|
end
|
2695
2920
|
|
2696
|
-
# @note When making an API call, you may pass GetOutcomesRequest
|
2697
|
-
# data as a hash:
|
2698
|
-
#
|
2699
|
-
# {
|
2700
|
-
# name: "identifier",
|
2701
|
-
# next_token: "string",
|
2702
|
-
# max_results: 1,
|
2703
|
-
# }
|
2704
|
-
#
|
2705
2921
|
# @!attribute [rw] name
|
2706
2922
|
# The name of the outcome or outcomes to get.
|
2707
2923
|
# @return [String]
|
@@ -2741,17 +2957,6 @@ module Aws::FraudDetector
|
|
2741
2957
|
include Aws::Structure
|
2742
2958
|
end
|
2743
2959
|
|
2744
|
-
# @note When making an API call, you may pass GetRulesRequest
|
2745
|
-
# data as a hash:
|
2746
|
-
#
|
2747
|
-
# {
|
2748
|
-
# rule_id: "identifier",
|
2749
|
-
# detector_id: "identifier", # required
|
2750
|
-
# rule_version: "wholeNumberVersionString",
|
2751
|
-
# next_token: "string",
|
2752
|
-
# max_results: 1,
|
2753
|
-
# }
|
2754
|
-
#
|
2755
2960
|
# @!attribute [rw] rule_id
|
2756
2961
|
# The rule ID.
|
2757
2962
|
# @return [String]
|
@@ -2801,15 +3006,6 @@ module Aws::FraudDetector
|
|
2801
3006
|
include Aws::Structure
|
2802
3007
|
end
|
2803
3008
|
|
2804
|
-
# @note When making an API call, you may pass GetVariablesRequest
|
2805
|
-
# data as a hash:
|
2806
|
-
#
|
2807
|
-
# {
|
2808
|
-
# name: "string",
|
2809
|
-
# next_token: "string",
|
2810
|
-
# max_results: 1,
|
2811
|
-
# }
|
2812
|
-
#
|
2813
3009
|
# @!attribute [rw] name
|
2814
3010
|
# The name of the variable.
|
2815
3011
|
# @return [String]
|
@@ -2885,16 +3081,6 @@ module Aws::FraudDetector
|
|
2885
3081
|
|
2886
3082
|
# The details of the ingested event.
|
2887
3083
|
#
|
2888
|
-
# @note When making an API call, you may pass IngestedEventsDetail
|
2889
|
-
# data as a hash:
|
2890
|
-
#
|
2891
|
-
# {
|
2892
|
-
# ingested_events_time_window: { # required
|
2893
|
-
# start_time: "time", # required
|
2894
|
-
# end_time: "time", # required
|
2895
|
-
# },
|
2896
|
-
# }
|
2897
|
-
#
|
2898
3084
|
# @!attribute [rw] ingested_events_time_window
|
2899
3085
|
# The start and stop time of the ingested events.
|
2900
3086
|
# @return [Types::IngestedEventsTimeWindow]
|
@@ -2909,14 +3095,6 @@ module Aws::FraudDetector
|
|
2909
3095
|
|
2910
3096
|
# The start and stop time of the ingested events.
|
2911
3097
|
#
|
2912
|
-
# @note When making an API call, you may pass IngestedEventsTimeWindow
|
2913
|
-
# data as a hash:
|
2914
|
-
#
|
2915
|
-
# {
|
2916
|
-
# start_time: "time", # required
|
2917
|
-
# end_time: "time", # required
|
2918
|
-
# }
|
2919
|
-
#
|
2920
3098
|
# @!attribute [rw] start_time
|
2921
3099
|
# Timestamp of the first ingensted event.
|
2922
3100
|
# @return [String]
|
@@ -2997,16 +3175,6 @@ module Aws::FraudDetector
|
|
2997
3175
|
|
2998
3176
|
# The label schema.
|
2999
3177
|
#
|
3000
|
-
# @note When making an API call, you may pass LabelSchema
|
3001
|
-
# data as a hash:
|
3002
|
-
#
|
3003
|
-
# {
|
3004
|
-
# label_mapper: { # required
|
3005
|
-
# "string" => ["string"],
|
3006
|
-
# },
|
3007
|
-
# unlabeled_events_treatment: "IGNORE", # accepts IGNORE, FRAUD, LEGIT
|
3008
|
-
# }
|
3009
|
-
#
|
3010
3178
|
# @!attribute [rw] label_mapper
|
3011
3179
|
# The label mapper maps the Amazon Fraud Detector supported model
|
3012
3180
|
# classification labels (`FRAUD`, `LEGIT`) to the appropriate event
|
@@ -3021,6 +3189,24 @@ module Aws::FraudDetector
|
|
3021
3189
|
#
|
3022
3190
|
# @!attribute [rw] unlabeled_events_treatment
|
3023
3191
|
# The action to take for unlabeled events.
|
3192
|
+
#
|
3193
|
+
# * Use `IGNORE` if you want the unlabeled events to be ignored. This
|
3194
|
+
# is recommended when the majority of the events in the dataset are
|
3195
|
+
# labeled.
|
3196
|
+
#
|
3197
|
+
# * Use `FRAUD` if you want to categorize all unlabeled events as
|
3198
|
+
# “Fraud”. This is recommended when most of the events in your
|
3199
|
+
# dataset are fraudulent.
|
3200
|
+
#
|
3201
|
+
# * Use `LEGIT` if you want to categorize all unlabeled events as
|
3202
|
+
# “Legit”. This is recommended when most of the events in your
|
3203
|
+
# dataset are legitimate.
|
3204
|
+
#
|
3205
|
+
# * Use `AUTO` if you want Amazon Fraud Detector to decide how to use
|
3206
|
+
# the unlabeled data. This is recommended when there is significant
|
3207
|
+
# unlabeled events in the dataset.
|
3208
|
+
#
|
3209
|
+
# By default, Amazon Fraud Detector ignores the unlabeled data.
|
3024
3210
|
# @return [String]
|
3025
3211
|
#
|
3026
3212
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/LabelSchema AWS API Documentation
|
@@ -3032,15 +3218,69 @@ module Aws::FraudDetector
|
|
3032
3218
|
include Aws::Structure
|
3033
3219
|
end
|
3034
3220
|
|
3035
|
-
#
|
3036
|
-
#
|
3221
|
+
# @!attribute [rw] event_id
|
3222
|
+
# The event ID.
|
3223
|
+
# @return [Types::FilterCondition]
|
3224
|
+
#
|
3225
|
+
# @!attribute [rw] event_type
|
3226
|
+
# The event type associated with the detector.
|
3227
|
+
# @return [Types::FilterCondition]
|
3228
|
+
#
|
3229
|
+
# @!attribute [rw] detector_id
|
3230
|
+
# The detector ID.
|
3231
|
+
# @return [Types::FilterCondition]
|
3232
|
+
#
|
3233
|
+
# @!attribute [rw] detector_version_id
|
3234
|
+
# The detector version ID.
|
3235
|
+
# @return [Types::FilterCondition]
|
3236
|
+
#
|
3237
|
+
# @!attribute [rw] prediction_time_range
|
3238
|
+
# The time period for when the predictions were generated.
|
3239
|
+
# @return [Types::PredictionTimeRange]
|
3240
|
+
#
|
3241
|
+
# @!attribute [rw] next_token
|
3242
|
+
# Identifies the next page of results to return. Use the token to make
|
3243
|
+
# the call again to retrieve the next page. Keep all other arguments
|
3244
|
+
# unchanged. Each pagination token expires after 24 hours.
|
3245
|
+
# @return [String]
|
3246
|
+
#
|
3247
|
+
# @!attribute [rw] max_results
|
3248
|
+
# The maximum number of predictions to return for the request.
|
3249
|
+
# @return [Integer]
|
3250
|
+
#
|
3251
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ListEventPredictionsRequest AWS API Documentation
|
3252
|
+
#
|
3253
|
+
class ListEventPredictionsRequest < Struct.new(
|
3254
|
+
:event_id,
|
3255
|
+
:event_type,
|
3256
|
+
:detector_id,
|
3257
|
+
:detector_version_id,
|
3258
|
+
:prediction_time_range,
|
3259
|
+
:next_token,
|
3260
|
+
:max_results)
|
3261
|
+
SENSITIVE = []
|
3262
|
+
include Aws::Structure
|
3263
|
+
end
|
3264
|
+
|
3265
|
+
# @!attribute [rw] event_prediction_summaries
|
3266
|
+
# The summary of the past predictions.
|
3267
|
+
# @return [Array<Types::EventPredictionSummary>]
|
3037
3268
|
#
|
3038
|
-
#
|
3039
|
-
#
|
3040
|
-
#
|
3041
|
-
#
|
3042
|
-
#
|
3269
|
+
# @!attribute [rw] next_token
|
3270
|
+
# Identifies the next page of results to return. Use the token to make
|
3271
|
+
# the call again to retrieve the next page. Keep all other arguments
|
3272
|
+
# unchanged. Each pagination token expires after 24 hours.
|
3273
|
+
# @return [String]
|
3274
|
+
#
|
3275
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ListEventPredictionsResult AWS API Documentation
|
3043
3276
|
#
|
3277
|
+
class ListEventPredictionsResult < Struct.new(
|
3278
|
+
:event_prediction_summaries,
|
3279
|
+
:next_token)
|
3280
|
+
SENSITIVE = []
|
3281
|
+
include Aws::Structure
|
3282
|
+
end
|
3283
|
+
|
3044
3284
|
# @!attribute [rw] resource_arn
|
3045
3285
|
# The ARN that specifies the resource whose tags you want to list.
|
3046
3286
|
# @return [String]
|
@@ -3191,14 +3431,6 @@ module Aws::FraudDetector
|
|
3191
3431
|
# detector version includes an imported Amazon SageMaker model endpoint
|
3192
3432
|
# with pass-through input configuration.
|
3193
3433
|
#
|
3194
|
-
# @note When making an API call, you may pass ModelEndpointDataBlob
|
3195
|
-
# data as a hash:
|
3196
|
-
#
|
3197
|
-
# {
|
3198
|
-
# byte_buffer: "data",
|
3199
|
-
# content_type: "contentType",
|
3200
|
-
# }
|
3201
|
-
#
|
3202
3434
|
# @!attribute [rw] byte_buffer
|
3203
3435
|
# The byte buffer of the Amazon SageMaker model endpoint input data
|
3204
3436
|
# blob.
|
@@ -3220,17 +3452,6 @@ module Aws::FraudDetector
|
|
3220
3452
|
|
3221
3453
|
# The Amazon SageMaker model input configuration.
|
3222
3454
|
#
|
3223
|
-
# @note When making an API call, you may pass ModelInputConfiguration
|
3224
|
-
# data as a hash:
|
3225
|
-
#
|
3226
|
-
# {
|
3227
|
-
# event_type_name: "identifier",
|
3228
|
-
# format: "TEXT_CSV", # accepts TEXT_CSV, APPLICATION_JSON
|
3229
|
-
# use_event_variables: false, # required
|
3230
|
-
# json_input_template: "modelInputTemplate",
|
3231
|
-
# csv_input_template: "modelInputTemplate",
|
3232
|
-
# }
|
3233
|
-
#
|
3234
3455
|
# @!attribute [rw] event_type_name
|
3235
3456
|
# The event type name.
|
3236
3457
|
# @return [String]
|
@@ -3273,19 +3494,6 @@ module Aws::FraudDetector
|
|
3273
3494
|
|
3274
3495
|
# Provides the Amazon Sagemaker model output configuration.
|
3275
3496
|
#
|
3276
|
-
# @note When making an API call, you may pass ModelOutputConfiguration
|
3277
|
-
# data as a hash:
|
3278
|
-
#
|
3279
|
-
# {
|
3280
|
-
# format: "TEXT_CSV", # required, accepts TEXT_CSV, APPLICATION_JSONLINES
|
3281
|
-
# json_key_to_variable_map: {
|
3282
|
-
# "string" => "string",
|
3283
|
-
# },
|
3284
|
-
# csv_index_to_variable_map: {
|
3285
|
-
# "string" => "string",
|
3286
|
-
# },
|
3287
|
-
# }
|
3288
|
-
#
|
3289
3497
|
# @!attribute [rw] format
|
3290
3498
|
# The format of the model output configuration.
|
3291
3499
|
# @return [String]
|
@@ -3329,17 +3537,7 @@ module Aws::FraudDetector
|
|
3329
3537
|
include Aws::Structure
|
3330
3538
|
end
|
3331
3539
|
|
3332
|
-
# The model version.
|
3333
|
-
#
|
3334
|
-
# @note When making an API call, you may pass ModelVersion
|
3335
|
-
# data as a hash:
|
3336
|
-
#
|
3337
|
-
# {
|
3338
|
-
# model_id: "modelIdentifier", # required
|
3339
|
-
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
|
3340
|
-
# model_version_number: "floatVersionString", # required
|
3341
|
-
# arn: "fraudDetectorArn",
|
3342
|
-
# }
|
3540
|
+
# The model version.
|
3343
3541
|
#
|
3344
3542
|
# @!attribute [rw] model_id
|
3345
3543
|
# The model ID.
|
@@ -3422,6 +3620,11 @@ module Aws::FraudDetector
|
|
3422
3620
|
# The model version ARN.
|
3423
3621
|
# @return [String]
|
3424
3622
|
#
|
3623
|
+
# @!attribute [rw] training_result_v2
|
3624
|
+
# The training result details. The details include the relative
|
3625
|
+
# importance of the variables.
|
3626
|
+
# @return [Types::TrainingResultV2]
|
3627
|
+
#
|
3425
3628
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ModelVersionDetail AWS API Documentation
|
3426
3629
|
#
|
3427
3630
|
class ModelVersionDetail < Struct.new(
|
@@ -3436,7 +3639,107 @@ module Aws::FraudDetector
|
|
3436
3639
|
:training_result,
|
3437
3640
|
:last_updated_time,
|
3438
3641
|
:created_time,
|
3439
|
-
:arn
|
3642
|
+
:arn,
|
3643
|
+
:training_result_v2)
|
3644
|
+
SENSITIVE = []
|
3645
|
+
include Aws::Structure
|
3646
|
+
end
|
3647
|
+
|
3648
|
+
# The model version evalutions.
|
3649
|
+
#
|
3650
|
+
# @!attribute [rw] output_variable_name
|
3651
|
+
# The output variable name.
|
3652
|
+
# @return [String]
|
3653
|
+
#
|
3654
|
+
# @!attribute [rw] evaluation_score
|
3655
|
+
# The evaluation score generated for the model version.
|
3656
|
+
# @return [String]
|
3657
|
+
#
|
3658
|
+
# @!attribute [rw] prediction_explanations
|
3659
|
+
# The prediction explanations generated for the model version.
|
3660
|
+
# @return [Types::PredictionExplanations]
|
3661
|
+
#
|
3662
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ModelVersionEvaluation AWS API Documentation
|
3663
|
+
#
|
3664
|
+
class ModelVersionEvaluation < Struct.new(
|
3665
|
+
:output_variable_name,
|
3666
|
+
:evaluation_score,
|
3667
|
+
:prediction_explanations)
|
3668
|
+
SENSITIVE = []
|
3669
|
+
include Aws::Structure
|
3670
|
+
end
|
3671
|
+
|
3672
|
+
# The Online Fraud Insights (OFI) model performance metrics data points.
|
3673
|
+
#
|
3674
|
+
# @!attribute [rw] fpr
|
3675
|
+
# The false positive rate. This is the percentage of total legitimate
|
3676
|
+
# events that are incorrectly predicted as fraud.
|
3677
|
+
# @return [Float]
|
3678
|
+
#
|
3679
|
+
# @!attribute [rw] precision
|
3680
|
+
# The percentage of fraud events correctly predicted as fraudulent as
|
3681
|
+
# compared to all events predicted as fraudulent.
|
3682
|
+
# @return [Float]
|
3683
|
+
#
|
3684
|
+
# @!attribute [rw] tpr
|
3685
|
+
# The true positive rate. This is the percentage of total fraud the
|
3686
|
+
# model detects. Also known as capture rate.
|
3687
|
+
# @return [Float]
|
3688
|
+
#
|
3689
|
+
# @!attribute [rw] threshold
|
3690
|
+
# The model threshold that specifies an acceptable fraud capture rate.
|
3691
|
+
# For example, a threshold of 500 means any model score 500 or above
|
3692
|
+
# is labeled as fraud.
|
3693
|
+
# @return [Float]
|
3694
|
+
#
|
3695
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/OFIMetricDataPoint AWS API Documentation
|
3696
|
+
#
|
3697
|
+
class OFIMetricDataPoint < Struct.new(
|
3698
|
+
:fpr,
|
3699
|
+
:precision,
|
3700
|
+
:tpr,
|
3701
|
+
:threshold)
|
3702
|
+
SENSITIVE = []
|
3703
|
+
include Aws::Structure
|
3704
|
+
end
|
3705
|
+
|
3706
|
+
# The Online Fraud Insights (OFI) model performance score.
|
3707
|
+
#
|
3708
|
+
# @!attribute [rw] auc
|
3709
|
+
# The area under the curve (auc). This summarizes the total positive
|
3710
|
+
# rate (tpr) and false positive rate (FPR) across all possible model
|
3711
|
+
# score thresholds.
|
3712
|
+
# @return [Float]
|
3713
|
+
#
|
3714
|
+
# @!attribute [rw] uncertainty_range
|
3715
|
+
# Indicates the range of area under curve (auc) expected from the OFI
|
3716
|
+
# model. A range greater than 0.1 indicates higher model uncertainity.
|
3717
|
+
# @return [Types::UncertaintyRange]
|
3718
|
+
#
|
3719
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/OFIModelPerformance AWS API Documentation
|
3720
|
+
#
|
3721
|
+
class OFIModelPerformance < Struct.new(
|
3722
|
+
:auc,
|
3723
|
+
:uncertainty_range)
|
3724
|
+
SENSITIVE = []
|
3725
|
+
include Aws::Structure
|
3726
|
+
end
|
3727
|
+
|
3728
|
+
# The Online Fraud Insights (OFI) model training metric details.
|
3729
|
+
#
|
3730
|
+
# @!attribute [rw] metric_data_points
|
3731
|
+
# The model's performance metrics data points.
|
3732
|
+
# @return [Array<Types::OFIMetricDataPoint>]
|
3733
|
+
#
|
3734
|
+
# @!attribute [rw] model_performance
|
3735
|
+
# The model's overall performance score.
|
3736
|
+
# @return [Types::OFIModelPerformance]
|
3737
|
+
#
|
3738
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/OFITrainingMetricsValue AWS API Documentation
|
3739
|
+
#
|
3740
|
+
class OFITrainingMetricsValue < Struct.new(
|
3741
|
+
:metric_data_points,
|
3742
|
+
:model_performance)
|
3440
3743
|
SENSITIVE = []
|
3441
3744
|
include Aws::Structure
|
3442
3745
|
end
|
@@ -3475,21 +3778,55 @@ module Aws::FraudDetector
|
|
3475
3778
|
include Aws::Structure
|
3476
3779
|
end
|
3477
3780
|
|
3478
|
-
#
|
3479
|
-
#
|
3781
|
+
# The prediction explanations that provide insight into how each event
|
3782
|
+
# variable impacted the model version's fraud prediction score.
|
3783
|
+
#
|
3784
|
+
# @!attribute [rw] variable_impact_explanations
|
3785
|
+
# The details of the event variable's impact on the prediction score.
|
3786
|
+
# @return [Array<Types::VariableImpactExplanation>]
|
3787
|
+
#
|
3788
|
+
# @!attribute [rw] aggregated_variables_impact_explanations
|
3789
|
+
# The details of the aggregated variables impact on the prediction
|
3790
|
+
# score.
|
3791
|
+
#
|
3792
|
+
# Account Takeover Insights (ATI) model uses event variables from the
|
3793
|
+
# login data you provide to continuously calculate a set of variables
|
3794
|
+
# (aggregated variables) based on historical events. For example, your
|
3795
|
+
# ATI model might calculate the number of times an user has logged in
|
3796
|
+
# using the same IP address. In this case, event variables used to
|
3797
|
+
# derive the aggregated variables are `IP address` and `user`.
|
3798
|
+
# @return [Array<Types::AggregatedVariablesImpactExplanation>]
|
3799
|
+
#
|
3800
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PredictionExplanations AWS API Documentation
|
3801
|
+
#
|
3802
|
+
class PredictionExplanations < Struct.new(
|
3803
|
+
:variable_impact_explanations,
|
3804
|
+
:aggregated_variables_impact_explanations)
|
3805
|
+
SENSITIVE = []
|
3806
|
+
include Aws::Structure
|
3807
|
+
end
|
3808
|
+
|
3809
|
+
# The time period for when the predictions were generated.
|
3810
|
+
#
|
3811
|
+
# @!attribute [rw] start_time
|
3812
|
+
# The start time of the time period for when the predictions were
|
3813
|
+
# generated.
|
3814
|
+
# @return [String]
|
3815
|
+
#
|
3816
|
+
# @!attribute [rw] end_time
|
3817
|
+
# The end time of the time period for when the predictions were
|
3818
|
+
# generated.
|
3819
|
+
# @return [String]
|
3480
3820
|
#
|
3481
|
-
#
|
3482
|
-
# detector_id: "identifier", # required
|
3483
|
-
# description: "description",
|
3484
|
-
# event_type_name: "identifier", # required
|
3485
|
-
# tags: [
|
3486
|
-
# {
|
3487
|
-
# key: "tagKey", # required
|
3488
|
-
# value: "tagValue", # required
|
3489
|
-
# },
|
3490
|
-
# ],
|
3491
|
-
# }
|
3821
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PredictionTimeRange AWS API Documentation
|
3492
3822
|
#
|
3823
|
+
class PredictionTimeRange < Struct.new(
|
3824
|
+
:start_time,
|
3825
|
+
:end_time)
|
3826
|
+
SENSITIVE = []
|
3827
|
+
include Aws::Structure
|
3828
|
+
end
|
3829
|
+
|
3493
3830
|
# @!attribute [rw] detector_id
|
3494
3831
|
# The detector ID.
|
3495
3832
|
# @return [String]
|
@@ -3521,20 +3858,6 @@ module Aws::FraudDetector
|
|
3521
3858
|
#
|
3522
3859
|
class PutDetectorResult < Aws::EmptyStructure; end
|
3523
3860
|
|
3524
|
-
# @note When making an API call, you may pass PutEntityTypeRequest
|
3525
|
-
# data as a hash:
|
3526
|
-
#
|
3527
|
-
# {
|
3528
|
-
# name: "identifier", # required
|
3529
|
-
# description: "description",
|
3530
|
-
# tags: [
|
3531
|
-
# {
|
3532
|
-
# key: "tagKey", # required
|
3533
|
-
# value: "tagValue", # required
|
3534
|
-
# },
|
3535
|
-
# ],
|
3536
|
-
# }
|
3537
|
-
#
|
3538
3861
|
# @!attribute [rw] name
|
3539
3862
|
# The name of the entity type.
|
3540
3863
|
# @return [String]
|
@@ -3561,24 +3884,6 @@ module Aws::FraudDetector
|
|
3561
3884
|
#
|
3562
3885
|
class PutEntityTypeResult < Aws::EmptyStructure; end
|
3563
3886
|
|
3564
|
-
# @note When making an API call, you may pass PutEventTypeRequest
|
3565
|
-
# data as a hash:
|
3566
|
-
#
|
3567
|
-
# {
|
3568
|
-
# name: "identifier", # required
|
3569
|
-
# description: "description",
|
3570
|
-
# event_variables: ["string"], # required
|
3571
|
-
# labels: ["string"],
|
3572
|
-
# entity_types: ["string"], # required
|
3573
|
-
# event_ingestion: "ENABLED", # accepts ENABLED, DISABLED
|
3574
|
-
# tags: [
|
3575
|
-
# {
|
3576
|
-
# key: "tagKey", # required
|
3577
|
-
# value: "tagValue", # required
|
3578
|
-
# },
|
3579
|
-
# ],
|
3580
|
-
# }
|
3581
|
-
#
|
3582
3887
|
# @!attribute [rw] name
|
3583
3888
|
# The name.
|
3584
3889
|
# @return [String]
|
@@ -3601,13 +3906,19 @@ module Aws::FraudDetector
|
|
3601
3906
|
# @return [Array<String>]
|
3602
3907
|
#
|
3603
3908
|
# @!attribute [rw] event_ingestion
|
3604
|
-
# Specifies if
|
3909
|
+
# Specifies if ingestion is enabled or disabled.
|
3605
3910
|
# @return [String]
|
3606
3911
|
#
|
3607
3912
|
# @!attribute [rw] tags
|
3608
3913
|
# A collection of key and value pairs.
|
3609
3914
|
# @return [Array<Types::Tag>]
|
3610
3915
|
#
|
3916
|
+
# @!attribute [rw] event_orchestration
|
3917
|
+
# Enables or disables event orchestration. If enabled, you can send
|
3918
|
+
# event predictions to select AWS services for downstream processing
|
3919
|
+
# of the events.
|
3920
|
+
# @return [Types::EventOrchestration]
|
3921
|
+
#
|
3611
3922
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutEventTypeRequest AWS API Documentation
|
3612
3923
|
#
|
3613
3924
|
class PutEventTypeRequest < Struct.new(
|
@@ -3617,7 +3928,8 @@ module Aws::FraudDetector
|
|
3617
3928
|
:labels,
|
3618
3929
|
:entity_types,
|
3619
3930
|
:event_ingestion,
|
3620
|
-
:tags
|
3931
|
+
:tags,
|
3932
|
+
:event_orchestration)
|
3621
3933
|
SENSITIVE = []
|
3622
3934
|
include Aws::Structure
|
3623
3935
|
end
|
@@ -3626,38 +3938,6 @@ module Aws::FraudDetector
|
|
3626
3938
|
#
|
3627
3939
|
class PutEventTypeResult < Aws::EmptyStructure; end
|
3628
3940
|
|
3629
|
-
# @note When making an API call, you may pass PutExternalModelRequest
|
3630
|
-
# data as a hash:
|
3631
|
-
#
|
3632
|
-
# {
|
3633
|
-
# model_endpoint: "sageMakerEndpointIdentifier", # required
|
3634
|
-
# model_source: "SAGEMAKER", # required, accepts SAGEMAKER
|
3635
|
-
# invoke_model_endpoint_role_arn: "string", # required
|
3636
|
-
# input_configuration: { # required
|
3637
|
-
# event_type_name: "identifier",
|
3638
|
-
# format: "TEXT_CSV", # accepts TEXT_CSV, APPLICATION_JSON
|
3639
|
-
# use_event_variables: false, # required
|
3640
|
-
# json_input_template: "modelInputTemplate",
|
3641
|
-
# csv_input_template: "modelInputTemplate",
|
3642
|
-
# },
|
3643
|
-
# output_configuration: { # required
|
3644
|
-
# format: "TEXT_CSV", # required, accepts TEXT_CSV, APPLICATION_JSONLINES
|
3645
|
-
# json_key_to_variable_map: {
|
3646
|
-
# "string" => "string",
|
3647
|
-
# },
|
3648
|
-
# csv_index_to_variable_map: {
|
3649
|
-
# "string" => "string",
|
3650
|
-
# },
|
3651
|
-
# },
|
3652
|
-
# model_endpoint_status: "ASSOCIATED", # required, accepts ASSOCIATED, DISSOCIATED
|
3653
|
-
# tags: [
|
3654
|
-
# {
|
3655
|
-
# key: "tagKey", # required
|
3656
|
-
# value: "tagValue", # required
|
3657
|
-
# },
|
3658
|
-
# ],
|
3659
|
-
# }
|
3660
|
-
#
|
3661
3941
|
# @!attribute [rw] model_endpoint
|
3662
3942
|
# The model endpoints name.
|
3663
3943
|
# @return [String]
|
@@ -3704,15 +3984,11 @@ module Aws::FraudDetector
|
|
3704
3984
|
#
|
3705
3985
|
class PutExternalModelResult < Aws::EmptyStructure; end
|
3706
3986
|
|
3707
|
-
# @note When making an API call, you may pass PutKMSEncryptionKeyRequest
|
3708
|
-
# data as a hash:
|
3709
|
-
#
|
3710
|
-
# {
|
3711
|
-
# kms_encryption_key_arn: "KmsEncryptionKeyArn", # required
|
3712
|
-
# }
|
3713
|
-
#
|
3714
3987
|
# @!attribute [rw] kms_encryption_key_arn
|
3715
3988
|
# The KMS encryption key ARN.
|
3989
|
+
#
|
3990
|
+
# The KMS key must be single-Region key. Amazon Fraud Detector does
|
3991
|
+
# not support multi-Region KMS key.
|
3716
3992
|
# @return [String]
|
3717
3993
|
#
|
3718
3994
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutKMSEncryptionKeyRequest AWS API Documentation
|
@@ -3727,20 +4003,6 @@ module Aws::FraudDetector
|
|
3727
4003
|
#
|
3728
4004
|
class PutKMSEncryptionKeyResult < Aws::EmptyStructure; end
|
3729
4005
|
|
3730
|
-
# @note When making an API call, you may pass PutLabelRequest
|
3731
|
-
# data as a hash:
|
3732
|
-
#
|
3733
|
-
# {
|
3734
|
-
# name: "identifier", # required
|
3735
|
-
# description: "description",
|
3736
|
-
# tags: [
|
3737
|
-
# {
|
3738
|
-
# key: "tagKey", # required
|
3739
|
-
# value: "tagValue", # required
|
3740
|
-
# },
|
3741
|
-
# ],
|
3742
|
-
# }
|
3743
|
-
#
|
3744
4006
|
# @!attribute [rw] name
|
3745
4007
|
# The label name.
|
3746
4008
|
# @return [String]
|
@@ -3750,6 +4012,7 @@ module Aws::FraudDetector
|
|
3750
4012
|
# @return [String]
|
3751
4013
|
#
|
3752
4014
|
# @!attribute [rw] tags
|
4015
|
+
# A collection of key and value pairs.
|
3753
4016
|
# @return [Array<Types::Tag>]
|
3754
4017
|
#
|
3755
4018
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutLabelRequest AWS API Documentation
|
@@ -3766,20 +4029,6 @@ module Aws::FraudDetector
|
|
3766
4029
|
#
|
3767
4030
|
class PutLabelResult < Aws::EmptyStructure; end
|
3768
4031
|
|
3769
|
-
# @note When making an API call, you may pass PutOutcomeRequest
|
3770
|
-
# data as a hash:
|
3771
|
-
#
|
3772
|
-
# {
|
3773
|
-
# name: "identifier", # required
|
3774
|
-
# description: "description",
|
3775
|
-
# tags: [
|
3776
|
-
# {
|
3777
|
-
# key: "tagKey", # required
|
3778
|
-
# value: "tagValue", # required
|
3779
|
-
# },
|
3780
|
-
# ],
|
3781
|
-
# }
|
3782
|
-
#
|
3783
4032
|
# @!attribute [rw] name
|
3784
4033
|
# The name of the outcome.
|
3785
4034
|
# @return [String]
|
@@ -3835,15 +4084,6 @@ module Aws::FraudDetector
|
|
3835
4084
|
|
3836
4085
|
# A rule.
|
3837
4086
|
#
|
3838
|
-
# @note When making an API call, you may pass Rule
|
3839
|
-
# data as a hash:
|
3840
|
-
#
|
3841
|
-
# {
|
3842
|
-
# detector_id: "identifier", # required
|
3843
|
-
# rule_id: "identifier", # required
|
3844
|
-
# rule_version: "wholeNumberVersionString", # required
|
3845
|
-
# }
|
3846
|
-
#
|
3847
4087
|
# @!attribute [rw] detector_id
|
3848
4088
|
# The detector for which the rule is associated.
|
3849
4089
|
# @return [String]
|
@@ -3944,26 +4184,6 @@ module Aws::FraudDetector
|
|
3944
4184
|
include Aws::Structure
|
3945
4185
|
end
|
3946
4186
|
|
3947
|
-
# @note When making an API call, you may pass SendEventRequest
|
3948
|
-
# data as a hash:
|
3949
|
-
#
|
3950
|
-
# {
|
3951
|
-
# event_id: "identifier", # required
|
3952
|
-
# event_type_name: "identifier", # required
|
3953
|
-
# event_timestamp: "utcTimestampISO8601", # required
|
3954
|
-
# event_variables: { # required
|
3955
|
-
# "variableName" => "variableValue",
|
3956
|
-
# },
|
3957
|
-
# assigned_label: "identifier",
|
3958
|
-
# label_timestamp: "utcTimestampISO8601",
|
3959
|
-
# entities: [ # required
|
3960
|
-
# {
|
3961
|
-
# entity_type: "string", # required
|
3962
|
-
# entity_id: "entityRestrictedString", # required
|
3963
|
-
# },
|
3964
|
-
# ],
|
3965
|
-
# }
|
3966
|
-
#
|
3967
4187
|
# @!attribute [rw] event_id
|
3968
4188
|
# The event ID to upload.
|
3969
4189
|
# @return [String]
|
@@ -4015,15 +4235,83 @@ module Aws::FraudDetector
|
|
4015
4235
|
#
|
4016
4236
|
class SendEventResult < Aws::EmptyStructure; end
|
4017
4237
|
|
4018
|
-
#
|
4238
|
+
# The performance metrics data points for Transaction Fraud Insights
|
4239
|
+
# (TFI) model.
|
4240
|
+
#
|
4241
|
+
# @!attribute [rw] fpr
|
4242
|
+
# The false positive rate. This is the percentage of total legitimate
|
4243
|
+
# events that are incorrectly predicted as fraud.
|
4244
|
+
# @return [Float]
|
4245
|
+
#
|
4246
|
+
# @!attribute [rw] precision
|
4247
|
+
# The percentage of fraud events correctly predicted as fraudulent as
|
4248
|
+
# compared to all events predicted as fraudulent.
|
4249
|
+
# @return [Float]
|
4250
|
+
#
|
4251
|
+
# @!attribute [rw] tpr
|
4252
|
+
# The true positive rate. This is the percentage of total fraud the
|
4253
|
+
# model detects. Also known as capture rate.
|
4254
|
+
# @return [Float]
|
4255
|
+
#
|
4256
|
+
# @!attribute [rw] threshold
|
4257
|
+
# The model threshold that specifies an acceptable fraud capture rate.
|
4258
|
+
# For example, a threshold of 500 means any model score 500 or above
|
4259
|
+
# is labeled as fraud.
|
4260
|
+
# @return [Float]
|
4019
4261
|
#
|
4020
|
-
# @
|
4021
|
-
# data as a hash:
|
4262
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/TFIMetricDataPoint AWS API Documentation
|
4022
4263
|
#
|
4023
|
-
|
4024
|
-
|
4025
|
-
|
4026
|
-
|
4264
|
+
class TFIMetricDataPoint < Struct.new(
|
4265
|
+
:fpr,
|
4266
|
+
:precision,
|
4267
|
+
:tpr,
|
4268
|
+
:threshold)
|
4269
|
+
SENSITIVE = []
|
4270
|
+
include Aws::Structure
|
4271
|
+
end
|
4272
|
+
|
4273
|
+
# The Transaction Fraud Insights (TFI) model performance score.
|
4274
|
+
#
|
4275
|
+
# @!attribute [rw] auc
|
4276
|
+
# The area under the curve (auc). This summarizes the total positive
|
4277
|
+
# rate (tpr) and false positive rate (FPR) across all possible model
|
4278
|
+
# score thresholds.
|
4279
|
+
# @return [Float]
|
4280
|
+
#
|
4281
|
+
# @!attribute [rw] uncertainty_range
|
4282
|
+
# Indicates the range of area under curve (auc) expected from the TFI
|
4283
|
+
# model. A range greater than 0.1 indicates higher model uncertainity.
|
4284
|
+
# @return [Types::UncertaintyRange]
|
4285
|
+
#
|
4286
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/TFIModelPerformance AWS API Documentation
|
4287
|
+
#
|
4288
|
+
class TFIModelPerformance < Struct.new(
|
4289
|
+
:auc,
|
4290
|
+
:uncertainty_range)
|
4291
|
+
SENSITIVE = []
|
4292
|
+
include Aws::Structure
|
4293
|
+
end
|
4294
|
+
|
4295
|
+
# The Transaction Fraud Insights (TFI) model training metric details.
|
4296
|
+
#
|
4297
|
+
# @!attribute [rw] metric_data_points
|
4298
|
+
# The model's performance metrics data points.
|
4299
|
+
# @return [Array<Types::TFIMetricDataPoint>]
|
4300
|
+
#
|
4301
|
+
# @!attribute [rw] model_performance
|
4302
|
+
# The model performance score.
|
4303
|
+
# @return [Types::TFIModelPerformance]
|
4304
|
+
#
|
4305
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/TFITrainingMetricsValue AWS API Documentation
|
4306
|
+
#
|
4307
|
+
class TFITrainingMetricsValue < Struct.new(
|
4308
|
+
:metric_data_points,
|
4309
|
+
:model_performance)
|
4310
|
+
SENSITIVE = []
|
4311
|
+
include Aws::Structure
|
4312
|
+
end
|
4313
|
+
|
4314
|
+
# A key and value pair.
|
4027
4315
|
#
|
4028
4316
|
# @!attribute [rw] key
|
4029
4317
|
# A tag key.
|
@@ -4042,19 +4330,6 @@ module Aws::FraudDetector
|
|
4042
4330
|
include Aws::Structure
|
4043
4331
|
end
|
4044
4332
|
|
4045
|
-
# @note When making an API call, you may pass TagResourceRequest
|
4046
|
-
# data as a hash:
|
4047
|
-
#
|
4048
|
-
# {
|
4049
|
-
# resource_arn: "fraudDetectorArn", # required
|
4050
|
-
# tags: [ # required
|
4051
|
-
# {
|
4052
|
-
# key: "tagKey", # required
|
4053
|
-
# value: "tagValue", # required
|
4054
|
-
# },
|
4055
|
-
# ],
|
4056
|
-
# }
|
4057
|
-
#
|
4058
4333
|
# @!attribute [rw] resource_arn
|
4059
4334
|
# The resource ARN.
|
4060
4335
|
# @return [String]
|
@@ -4091,19 +4366,6 @@ module Aws::FraudDetector
|
|
4091
4366
|
|
4092
4367
|
# The training data schema.
|
4093
4368
|
#
|
4094
|
-
# @note When making an API call, you may pass TrainingDataSchema
|
4095
|
-
# data as a hash:
|
4096
|
-
#
|
4097
|
-
# {
|
4098
|
-
# model_variables: ["string"], # required
|
4099
|
-
# label_schema: { # required
|
4100
|
-
# label_mapper: { # required
|
4101
|
-
# "string" => ["string"],
|
4102
|
-
# },
|
4103
|
-
# unlabeled_events_treatment: "IGNORE", # accepts IGNORE, FRAUD, LEGIT
|
4104
|
-
# },
|
4105
|
-
# }
|
4106
|
-
#
|
4107
4369
|
# @!attribute [rw] model_variables
|
4108
4370
|
# The training data schema variables.
|
4109
4371
|
# @return [Array<String>]
|
@@ -4143,6 +4405,30 @@ module Aws::FraudDetector
|
|
4143
4405
|
include Aws::Structure
|
4144
4406
|
end
|
4145
4407
|
|
4408
|
+
# The training metrics details.
|
4409
|
+
#
|
4410
|
+
# @!attribute [rw] ofi
|
4411
|
+
# The Online Fraud Insights (OFI) model training metric details.
|
4412
|
+
# @return [Types::OFITrainingMetricsValue]
|
4413
|
+
#
|
4414
|
+
# @!attribute [rw] tfi
|
4415
|
+
# The Transaction Fraud Insights (TFI) model training metric details.
|
4416
|
+
# @return [Types::TFITrainingMetricsValue]
|
4417
|
+
#
|
4418
|
+
# @!attribute [rw] ati
|
4419
|
+
# The Account Takeover Insights (ATI) model training metric details.
|
4420
|
+
# @return [Types::ATITrainingMetricsValue]
|
4421
|
+
#
|
4422
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/TrainingMetricsV2 AWS API Documentation
|
4423
|
+
#
|
4424
|
+
class TrainingMetricsV2 < Struct.new(
|
4425
|
+
:ofi,
|
4426
|
+
:tfi,
|
4427
|
+
:ati)
|
4428
|
+
SENSITIVE = []
|
4429
|
+
include Aws::Structure
|
4430
|
+
end
|
4431
|
+
|
4146
4432
|
# The training result details.
|
4147
4433
|
#
|
4148
4434
|
# @!attribute [rw] data_validation_metrics
|
@@ -4167,14 +4453,63 @@ module Aws::FraudDetector
|
|
4167
4453
|
include Aws::Structure
|
4168
4454
|
end
|
4169
4455
|
|
4170
|
-
#
|
4171
|
-
#
|
4456
|
+
# The training result details.
|
4457
|
+
#
|
4458
|
+
# @!attribute [rw] data_validation_metrics
|
4459
|
+
# The model training data validation metrics.
|
4460
|
+
# @return [Types::DataValidationMetrics]
|
4461
|
+
#
|
4462
|
+
# @!attribute [rw] training_metrics_v2
|
4463
|
+
# The training metric details.
|
4464
|
+
# @return [Types::TrainingMetricsV2]
|
4465
|
+
#
|
4466
|
+
# @!attribute [rw] variable_importance_metrics
|
4467
|
+
# The variable importance metrics details.
|
4468
|
+
# @return [Types::VariableImportanceMetrics]
|
4469
|
+
#
|
4470
|
+
# @!attribute [rw] aggregated_variables_importance_metrics
|
4471
|
+
# The variable importance metrics of the aggregated variables.
|
4472
|
+
#
|
4473
|
+
# Account Takeover Insights (ATI) model uses event variables from the
|
4474
|
+
# login data you provide to continuously calculate a set of variables
|
4475
|
+
# (aggregated variables) based on historical events. For example, your
|
4476
|
+
# ATI model might calculate the number of times an user has logged in
|
4477
|
+
# using the same IP address. In this case, event variables used to
|
4478
|
+
# derive the aggregated variables are `IP address` and `user`.
|
4479
|
+
# @return [Types::AggregatedVariablesImportanceMetrics]
|
4480
|
+
#
|
4481
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/TrainingResultV2 AWS API Documentation
|
4482
|
+
#
|
4483
|
+
class TrainingResultV2 < Struct.new(
|
4484
|
+
:data_validation_metrics,
|
4485
|
+
:training_metrics_v2,
|
4486
|
+
:variable_importance_metrics,
|
4487
|
+
:aggregated_variables_importance_metrics)
|
4488
|
+
SENSITIVE = []
|
4489
|
+
include Aws::Structure
|
4490
|
+
end
|
4491
|
+
|
4492
|
+
# Range of area under curve (auc) expected from the model. A range
|
4493
|
+
# greater than 0.1 indicates higher model uncertainity. A range is the
|
4494
|
+
# difference between upper and lower bound of auc.
|
4495
|
+
#
|
4496
|
+
# @!attribute [rw] lower_bound_value
|
4497
|
+
# The lower bound value of the area under curve (auc).
|
4498
|
+
# @return [Float]
|
4499
|
+
#
|
4500
|
+
# @!attribute [rw] upper_bound_value
|
4501
|
+
# The upper bound value of the area under curve (auc).
|
4502
|
+
# @return [Float]
|
4172
4503
|
#
|
4173
|
-
#
|
4174
|
-
# resource_arn: "fraudDetectorArn", # required
|
4175
|
-
# tag_keys: ["tagKey"], # required
|
4176
|
-
# }
|
4504
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UncertaintyRange AWS API Documentation
|
4177
4505
|
#
|
4506
|
+
class UncertaintyRange < Struct.new(
|
4507
|
+
:lower_bound_value,
|
4508
|
+
:upper_bound_value)
|
4509
|
+
SENSITIVE = []
|
4510
|
+
include Aws::Structure
|
4511
|
+
end
|
4512
|
+
|
4178
4513
|
# @!attribute [rw] resource_arn
|
4179
4514
|
# The ARN of the resource from which to remove the tag.
|
4180
4515
|
# @return [String]
|
@@ -4196,15 +4531,6 @@ module Aws::FraudDetector
|
|
4196
4531
|
#
|
4197
4532
|
class UntagResourceResult < Aws::EmptyStructure; end
|
4198
4533
|
|
4199
|
-
# @note When making an API call, you may pass UpdateDetectorVersionMetadataRequest
|
4200
|
-
# data as a hash:
|
4201
|
-
#
|
4202
|
-
# {
|
4203
|
-
# detector_id: "identifier", # required
|
4204
|
-
# detector_version_id: "wholeNumberVersionString", # required
|
4205
|
-
# description: "description", # required
|
4206
|
-
# }
|
4207
|
-
#
|
4208
4534
|
# @!attribute [rw] detector_id
|
4209
4535
|
# The detector ID.
|
4210
4536
|
# @return [String]
|
@@ -4231,32 +4557,6 @@ module Aws::FraudDetector
|
|
4231
4557
|
#
|
4232
4558
|
class UpdateDetectorVersionMetadataResult < Aws::EmptyStructure; end
|
4233
4559
|
|
4234
|
-
# @note When making an API call, you may pass UpdateDetectorVersionRequest
|
4235
|
-
# data as a hash:
|
4236
|
-
#
|
4237
|
-
# {
|
4238
|
-
# detector_id: "identifier", # required
|
4239
|
-
# detector_version_id: "wholeNumberVersionString", # required
|
4240
|
-
# external_model_endpoints: ["string"], # required
|
4241
|
-
# rules: [ # required
|
4242
|
-
# {
|
4243
|
-
# detector_id: "identifier", # required
|
4244
|
-
# rule_id: "identifier", # required
|
4245
|
-
# rule_version: "wholeNumberVersionString", # required
|
4246
|
-
# },
|
4247
|
-
# ],
|
4248
|
-
# description: "description",
|
4249
|
-
# model_versions: [
|
4250
|
-
# {
|
4251
|
-
# model_id: "modelIdentifier", # required
|
4252
|
-
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
|
4253
|
-
# model_version_number: "floatVersionString", # required
|
4254
|
-
# arn: "fraudDetectorArn",
|
4255
|
-
# },
|
4256
|
-
# ],
|
4257
|
-
# rule_execution_mode: "ALL_MATCHED", # accepts ALL_MATCHED, FIRST_MATCHED
|
4258
|
-
# }
|
4259
|
-
#
|
4260
4560
|
# @!attribute [rw] detector_id
|
4261
4561
|
# The parent detector ID for the detector version you want to update.
|
4262
4562
|
# @return [String]
|
@@ -4316,15 +4616,6 @@ module Aws::FraudDetector
|
|
4316
4616
|
#
|
4317
4617
|
class UpdateDetectorVersionResult < Aws::EmptyStructure; end
|
4318
4618
|
|
4319
|
-
# @note When making an API call, you may pass UpdateDetectorVersionStatusRequest
|
4320
|
-
# data as a hash:
|
4321
|
-
#
|
4322
|
-
# {
|
4323
|
-
# detector_id: "identifier", # required
|
4324
|
-
# detector_version_id: "wholeNumberVersionString", # required
|
4325
|
-
# status: "DRAFT", # required, accepts DRAFT, ACTIVE, INACTIVE
|
4326
|
-
# }
|
4327
|
-
#
|
4328
4619
|
# @!attribute [rw] detector_id
|
4329
4620
|
# The detector ID.
|
4330
4621
|
# @return [String]
|
@@ -4335,6 +4626,8 @@ module Aws::FraudDetector
|
|
4335
4626
|
#
|
4336
4627
|
# @!attribute [rw] status
|
4337
4628
|
# The new status.
|
4629
|
+
#
|
4630
|
+
# The only supported values are `ACTIVE` and `INACTIVE`
|
4338
4631
|
# @return [String]
|
4339
4632
|
#
|
4340
4633
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateDetectorVersionStatusRequest AWS API Documentation
|
@@ -4351,16 +4644,6 @@ module Aws::FraudDetector
|
|
4351
4644
|
#
|
4352
4645
|
class UpdateDetectorVersionStatusResult < Aws::EmptyStructure; end
|
4353
4646
|
|
4354
|
-
# @note When making an API call, you may pass UpdateEventLabelRequest
|
4355
|
-
# data as a hash:
|
4356
|
-
#
|
4357
|
-
# {
|
4358
|
-
# event_id: "identifier", # required
|
4359
|
-
# event_type_name: "identifier", # required
|
4360
|
-
# assigned_label: "identifier", # required
|
4361
|
-
# label_timestamp: "utcTimestampISO8601", # required
|
4362
|
-
# }
|
4363
|
-
#
|
4364
4647
|
# @!attribute [rw] event_id
|
4365
4648
|
# The ID of the event associated with the label to update.
|
4366
4649
|
# @return [String]
|
@@ -4393,15 +4676,58 @@ module Aws::FraudDetector
|
|
4393
4676
|
#
|
4394
4677
|
class UpdateEventLabelResult < Aws::EmptyStructure; end
|
4395
4678
|
|
4396
|
-
#
|
4397
|
-
#
|
4679
|
+
# @!attribute [rw] name
|
4680
|
+
# The name of the list to update.
|
4681
|
+
# @return [String]
|
4682
|
+
#
|
4683
|
+
# @!attribute [rw] elements
|
4684
|
+
# One or more list elements to add or replace. If you are providing
|
4685
|
+
# the elements, make sure to specify the `updateMode` to use.
|
4686
|
+
#
|
4687
|
+
# If you are deleting all elements from the list, use `REPLACE` for
|
4688
|
+
# the `updateMode` and provide an empty list (0 elements).
|
4689
|
+
# @return [Array<String>]
|
4690
|
+
#
|
4691
|
+
# @!attribute [rw] description
|
4692
|
+
# The new description.
|
4693
|
+
# @return [String]
|
4694
|
+
#
|
4695
|
+
# @!attribute [rw] update_mode
|
4696
|
+
# The update mode (type).
|
4697
|
+
#
|
4698
|
+
# * Use `APPEND` if you are adding elements to the list.
|
4699
|
+
#
|
4700
|
+
# * Use `REPLACE` if you replacing existing elements in the list.
|
4701
|
+
#
|
4702
|
+
# * Use `REMOVE` if you are removing elements from the list.
|
4703
|
+
# @return [String]
|
4704
|
+
#
|
4705
|
+
# @!attribute [rw] variable_type
|
4706
|
+
# The variable type you want to assign to the list.
|
4707
|
+
#
|
4708
|
+
# <note markdown="1"> You cannot update a variable type of a list that already has a
|
4709
|
+
# variable type assigned to it. You can assign a variable type to a
|
4710
|
+
# list only if the list does not already have a variable type.
|
4711
|
+
#
|
4712
|
+
# </note>
|
4713
|
+
# @return [String]
|
4714
|
+
#
|
4715
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateListRequest AWS API Documentation
|
4398
4716
|
#
|
4399
|
-
|
4400
|
-
|
4401
|
-
|
4402
|
-
|
4403
|
-
|
4717
|
+
class UpdateListRequest < Struct.new(
|
4718
|
+
:name,
|
4719
|
+
:elements,
|
4720
|
+
:description,
|
4721
|
+
:update_mode,
|
4722
|
+
:variable_type)
|
4723
|
+
SENSITIVE = []
|
4724
|
+
include Aws::Structure
|
4725
|
+
end
|
4726
|
+
|
4727
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateListResult AWS API Documentation
|
4404
4728
|
#
|
4729
|
+
class UpdateListResult < Aws::EmptyStructure; end
|
4730
|
+
|
4405
4731
|
# @!attribute [rw] model_id
|
4406
4732
|
# The model ID.
|
4407
4733
|
# @return [String]
|
@@ -4428,31 +4754,6 @@ module Aws::FraudDetector
|
|
4428
4754
|
#
|
4429
4755
|
class UpdateModelResult < Aws::EmptyStructure; end
|
4430
4756
|
|
4431
|
-
# @note When making an API call, you may pass UpdateModelVersionRequest
|
4432
|
-
# data as a hash:
|
4433
|
-
#
|
4434
|
-
# {
|
4435
|
-
# model_id: "modelIdentifier", # required
|
4436
|
-
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
|
4437
|
-
# major_version_number: "wholeNumberVersionString", # required
|
4438
|
-
# external_events_detail: {
|
4439
|
-
# data_location: "s3BucketLocation", # required
|
4440
|
-
# data_access_role_arn: "iamRoleArn", # required
|
4441
|
-
# },
|
4442
|
-
# ingested_events_detail: {
|
4443
|
-
# ingested_events_time_window: { # required
|
4444
|
-
# start_time: "time", # required
|
4445
|
-
# end_time: "time", # required
|
4446
|
-
# },
|
4447
|
-
# },
|
4448
|
-
# tags: [
|
4449
|
-
# {
|
4450
|
-
# key: "tagKey", # required
|
4451
|
-
# value: "tagValue", # required
|
4452
|
-
# },
|
4453
|
-
# ],
|
4454
|
-
# }
|
4455
|
-
#
|
4456
4757
|
# @!attribute [rw] model_id
|
4457
4758
|
# The model ID.
|
4458
4759
|
# @return [String]
|
@@ -4519,16 +4820,6 @@ module Aws::FraudDetector
|
|
4519
4820
|
include Aws::Structure
|
4520
4821
|
end
|
4521
4822
|
|
4522
|
-
# @note When making an API call, you may pass UpdateModelVersionStatusRequest
|
4523
|
-
# data as a hash:
|
4524
|
-
#
|
4525
|
-
# {
|
4526
|
-
# model_id: "modelIdentifier", # required
|
4527
|
-
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
|
4528
|
-
# model_version_number: "floatVersionString", # required
|
4529
|
-
# status: "ACTIVE", # required, accepts ACTIVE, INACTIVE, TRAINING_CANCELLED
|
4530
|
-
# }
|
4531
|
-
#
|
4532
4823
|
# @!attribute [rw] model_id
|
4533
4824
|
# The model ID of the model version to update.
|
4534
4825
|
# @return [String]
|
@@ -4560,18 +4851,6 @@ module Aws::FraudDetector
|
|
4560
4851
|
#
|
4561
4852
|
class UpdateModelVersionStatusResult < Aws::EmptyStructure; end
|
4562
4853
|
|
4563
|
-
# @note When making an API call, you may pass UpdateRuleMetadataRequest
|
4564
|
-
# data as a hash:
|
4565
|
-
#
|
4566
|
-
# {
|
4567
|
-
# rule: { # required
|
4568
|
-
# detector_id: "identifier", # required
|
4569
|
-
# rule_id: "identifier", # required
|
4570
|
-
# rule_version: "wholeNumberVersionString", # required
|
4571
|
-
# },
|
4572
|
-
# description: "description", # required
|
4573
|
-
# }
|
4574
|
-
#
|
4575
4854
|
# @!attribute [rw] rule
|
4576
4855
|
# The rule to update.
|
4577
4856
|
# @return [Types::Rule]
|
@@ -4593,27 +4872,6 @@ module Aws::FraudDetector
|
|
4593
4872
|
#
|
4594
4873
|
class UpdateRuleMetadataResult < Aws::EmptyStructure; end
|
4595
4874
|
|
4596
|
-
# @note When making an API call, you may pass UpdateRuleVersionRequest
|
4597
|
-
# data as a hash:
|
4598
|
-
#
|
4599
|
-
# {
|
4600
|
-
# rule: { # required
|
4601
|
-
# detector_id: "identifier", # required
|
4602
|
-
# rule_id: "identifier", # required
|
4603
|
-
# rule_version: "wholeNumberVersionString", # required
|
4604
|
-
# },
|
4605
|
-
# description: "description",
|
4606
|
-
# expression: "ruleExpression", # required
|
4607
|
-
# language: "DETECTORPL", # required, accepts DETECTORPL
|
4608
|
-
# outcomes: ["string"], # required
|
4609
|
-
# tags: [
|
4610
|
-
# {
|
4611
|
-
# key: "tagKey", # required
|
4612
|
-
# value: "tagValue", # required
|
4613
|
-
# },
|
4614
|
-
# ],
|
4615
|
-
# }
|
4616
|
-
#
|
4617
4875
|
# @!attribute [rw] rule
|
4618
4876
|
# The rule to update.
|
4619
4877
|
# @return [Types::Rule]
|
@@ -4663,16 +4921,6 @@ module Aws::FraudDetector
|
|
4663
4921
|
include Aws::Structure
|
4664
4922
|
end
|
4665
4923
|
|
4666
|
-
# @note When making an API call, you may pass UpdateVariableRequest
|
4667
|
-
# data as a hash:
|
4668
|
-
#
|
4669
|
-
# {
|
4670
|
-
# name: "string", # required
|
4671
|
-
# default_value: "string",
|
4672
|
-
# description: "string",
|
4673
|
-
# variable_type: "string",
|
4674
|
-
# }
|
4675
|
-
#
|
4676
4924
|
# @!attribute [rw] name
|
4677
4925
|
# The name of the variable.
|
4678
4926
|
# @return [String]
|
@@ -4793,18 +5041,6 @@ module Aws::FraudDetector
|
|
4793
5041
|
# A variable in the list of variables for the batch create variable
|
4794
5042
|
# request.
|
4795
5043
|
#
|
4796
|
-
# @note When making an API call, you may pass VariableEntry
|
4797
|
-
# data as a hash:
|
4798
|
-
#
|
4799
|
-
# {
|
4800
|
-
# name: "string",
|
4801
|
-
# data_type: "string",
|
4802
|
-
# data_source: "string",
|
4803
|
-
# default_value: "string",
|
4804
|
-
# description: "string",
|
4805
|
-
# variable_type: "string",
|
4806
|
-
# }
|
4807
|
-
#
|
4808
5044
|
# @!attribute [rw] name
|
4809
5045
|
# The name of the variable.
|
4810
5046
|
# @return [String]
|
@@ -4857,6 +5093,41 @@ module Aws::FraudDetector
|
|
4857
5093
|
include Aws::Structure
|
4858
5094
|
end
|
4859
5095
|
|
5096
|
+
# The details of the event variable's impact on the prediction score.
|
5097
|
+
#
|
5098
|
+
# @!attribute [rw] event_variable_name
|
5099
|
+
# The event variable name.
|
5100
|
+
# @return [String]
|
5101
|
+
#
|
5102
|
+
# @!attribute [rw] relative_impact
|
5103
|
+
# The event variable's relative impact in terms of magnitude on the
|
5104
|
+
# prediction scores. The relative impact values consist of a numerical
|
5105
|
+
# rating (0-5, 5 being the highest) and direction
|
5106
|
+
# (increased/decreased) impact of the fraud risk.
|
5107
|
+
# @return [String]
|
5108
|
+
#
|
5109
|
+
# @!attribute [rw] log_odds_impact
|
5110
|
+
# The raw, uninterpreted value represented as log-odds of the fraud.
|
5111
|
+
# These values are usually between -10 to +10, but range from -
|
5112
|
+
# infinity to + infinity.
|
5113
|
+
#
|
5114
|
+
# * A positive value indicates that the variable drove the risk score
|
5115
|
+
# up.
|
5116
|
+
#
|
5117
|
+
# * A negative value indicates that the variable drove the risk score
|
5118
|
+
# down.
|
5119
|
+
# @return [Float]
|
5120
|
+
#
|
5121
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/VariableImpactExplanation AWS API Documentation
|
5122
|
+
#
|
5123
|
+
class VariableImpactExplanation < Struct.new(
|
5124
|
+
:event_variable_name,
|
5125
|
+
:relative_impact,
|
5126
|
+
:log_odds_impact)
|
5127
|
+
SENSITIVE = []
|
5128
|
+
include Aws::Structure
|
5129
|
+
end
|
5130
|
+
|
4860
5131
|
# The variable importance metrics details.
|
4861
5132
|
#
|
4862
5133
|
# @!attribute [rw] log_odds_metrics
|