aws-sdk-frauddetector 1.21.0 → 1.25.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-frauddetector/client.rb +459 -58
- data/lib/aws-sdk-frauddetector/client_api.rb +366 -20
- data/lib/aws-sdk-frauddetector/errors.rb +16 -0
- data/lib/aws-sdk-frauddetector/types.rb +777 -62
- data/lib/aws-sdk-frauddetector.rb +1 -1
- metadata +5 -5
@@ -160,6 +160,80 @@ module Aws::FraudDetector
|
|
160
160
|
include Aws::Structure
|
161
161
|
end
|
162
162
|
|
163
|
+
# The batch import job details.
|
164
|
+
#
|
165
|
+
# @!attribute [rw] job_id
|
166
|
+
# The ID of the batch import job.
|
167
|
+
# @return [String]
|
168
|
+
#
|
169
|
+
# @!attribute [rw] status
|
170
|
+
# The status of the batch import job.
|
171
|
+
# @return [String]
|
172
|
+
#
|
173
|
+
# @!attribute [rw] failure_reason
|
174
|
+
# The reason batch import job failed.
|
175
|
+
# @return [String]
|
176
|
+
#
|
177
|
+
# @!attribute [rw] start_time
|
178
|
+
# Timestamp of when the batch import job started.
|
179
|
+
# @return [String]
|
180
|
+
#
|
181
|
+
# @!attribute [rw] completion_time
|
182
|
+
# Timestamp of when batch import job completed.
|
183
|
+
# @return [String]
|
184
|
+
#
|
185
|
+
# @!attribute [rw] input_path
|
186
|
+
# The Amazon S3 location of your data file for batch import.
|
187
|
+
# @return [String]
|
188
|
+
#
|
189
|
+
# @!attribute [rw] output_path
|
190
|
+
# The Amazon S3 location of your output file.
|
191
|
+
# @return [String]
|
192
|
+
#
|
193
|
+
# @!attribute [rw] event_type_name
|
194
|
+
# The name of the event type.
|
195
|
+
# @return [String]
|
196
|
+
#
|
197
|
+
# @!attribute [rw] iam_role_arn
|
198
|
+
# The ARN of the IAM role to use for this job request.
|
199
|
+
# @return [String]
|
200
|
+
#
|
201
|
+
# @!attribute [rw] arn
|
202
|
+
# The ARN of the batch import job.
|
203
|
+
# @return [String]
|
204
|
+
#
|
205
|
+
# @!attribute [rw] processed_records_count
|
206
|
+
# The number of records processed by batch import job.
|
207
|
+
# @return [Integer]
|
208
|
+
#
|
209
|
+
# @!attribute [rw] failed_records_count
|
210
|
+
# The number of records that failed to import.
|
211
|
+
# @return [Integer]
|
212
|
+
#
|
213
|
+
# @!attribute [rw] total_records_count
|
214
|
+
# The total number of records in the batch import job.
|
215
|
+
# @return [Integer]
|
216
|
+
#
|
217
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/BatchImport AWS API Documentation
|
218
|
+
#
|
219
|
+
class BatchImport < Struct.new(
|
220
|
+
:job_id,
|
221
|
+
:status,
|
222
|
+
:failure_reason,
|
223
|
+
:start_time,
|
224
|
+
:completion_time,
|
225
|
+
:input_path,
|
226
|
+
:output_path,
|
227
|
+
:event_type_name,
|
228
|
+
:iam_role_arn,
|
229
|
+
:arn,
|
230
|
+
:processed_records_count,
|
231
|
+
:failed_records_count,
|
232
|
+
:total_records_count)
|
233
|
+
SENSITIVE = []
|
234
|
+
include Aws::Structure
|
235
|
+
end
|
236
|
+
|
163
237
|
# The batch prediction details.
|
164
238
|
#
|
165
239
|
# @!attribute [rw] job_id
|
@@ -179,7 +253,7 @@ module Aws::FraudDetector
|
|
179
253
|
# @return [String]
|
180
254
|
#
|
181
255
|
# @!attribute [rw] completion_time
|
182
|
-
# Timestamp of when the batch prediction job
|
256
|
+
# Timestamp of when the batch prediction job completed.
|
183
257
|
# @return [String]
|
184
258
|
#
|
185
259
|
# @!attribute [rw] last_heartbeat_time
|
@@ -245,6 +319,32 @@ module Aws::FraudDetector
|
|
245
319
|
include Aws::Structure
|
246
320
|
end
|
247
321
|
|
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
|
+
# @!attribute [rw] job_id
|
330
|
+
# The ID of an in-progress batch import job to cancel.
|
331
|
+
#
|
332
|
+
# Amazon Fraud Detector will throw an error if the batch import job is
|
333
|
+
# in `FAILED`, `CANCELED`, or `COMPLETED` state.
|
334
|
+
# @return [String]
|
335
|
+
#
|
336
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CancelBatchImportJobRequest AWS API Documentation
|
337
|
+
#
|
338
|
+
class CancelBatchImportJobRequest < Struct.new(
|
339
|
+
:job_id)
|
340
|
+
SENSITIVE = []
|
341
|
+
include Aws::Structure
|
342
|
+
end
|
343
|
+
|
344
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CancelBatchImportJobResult AWS API Documentation
|
345
|
+
#
|
346
|
+
class CancelBatchImportJobResult < Aws::EmptyStructure; end
|
347
|
+
|
248
348
|
# @note When making an API call, you may pass CancelBatchPredictionJobRequest
|
249
349
|
# data as a hash:
|
250
350
|
#
|
@@ -269,18 +369,7 @@ module Aws::FraudDetector
|
|
269
369
|
class CancelBatchPredictionJobResult < Aws::EmptyStructure; end
|
270
370
|
|
271
371
|
# An exception indicating there was a conflict during a delete
|
272
|
-
# operation.
|
273
|
-
# exception:
|
274
|
-
#
|
275
|
-
# * DeleteDetector: A conflict exception will occur if the detector has
|
276
|
-
# associated `Rules` or `DetectorVersions`. You can only delete a
|
277
|
-
# detector if it has no `Rules` or `DetectorVersions`.
|
278
|
-
#
|
279
|
-
# * DeleteDetectorVersion: A conflict exception will occur if the
|
280
|
-
# `DetectorVersion` status is `ACTIVE`.
|
281
|
-
#
|
282
|
-
# * DeleteRule: A conflict exception will occur if the `RuleVersion` is
|
283
|
-
# in use by an associated `ACTIVE` or `INACTIVE DetectorVersion`.
|
372
|
+
# operation.
|
284
373
|
#
|
285
374
|
# @!attribute [rw] message
|
286
375
|
# @return [String]
|
@@ -293,6 +382,68 @@ module Aws::FraudDetector
|
|
293
382
|
include Aws::Structure
|
294
383
|
end
|
295
384
|
|
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
|
+
# @!attribute [rw] job_id
|
403
|
+
# The ID of the batch import job. The ID cannot be of a past job,
|
404
|
+
# unless the job exists in `CREATE_FAILED` state.
|
405
|
+
# @return [String]
|
406
|
+
#
|
407
|
+
# @!attribute [rw] input_path
|
408
|
+
# The URI that points to the Amazon S3 location of your data file.
|
409
|
+
# @return [String]
|
410
|
+
#
|
411
|
+
# @!attribute [rw] output_path
|
412
|
+
# The URI that points to the Amazon S3 location for storing your
|
413
|
+
# results.
|
414
|
+
# @return [String]
|
415
|
+
#
|
416
|
+
# @!attribute [rw] event_type_name
|
417
|
+
# The name of the event type.
|
418
|
+
# @return [String]
|
419
|
+
#
|
420
|
+
# @!attribute [rw] iam_role_arn
|
421
|
+
# The ARN of the IAM role created for Amazon S3 bucket that holds your
|
422
|
+
# data file. The IAM role must have read and write permissions to both
|
423
|
+
# input and output S3 buckets.
|
424
|
+
# @return [String]
|
425
|
+
#
|
426
|
+
# @!attribute [rw] tags
|
427
|
+
# A collection of key-value pairs associated with this request.
|
428
|
+
# @return [Array<Types::Tag>]
|
429
|
+
#
|
430
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateBatchImportJobRequest AWS API Documentation
|
431
|
+
#
|
432
|
+
class CreateBatchImportJobRequest < Struct.new(
|
433
|
+
:job_id,
|
434
|
+
:input_path,
|
435
|
+
:output_path,
|
436
|
+
:event_type_name,
|
437
|
+
:iam_role_arn,
|
438
|
+
:tags)
|
439
|
+
SENSITIVE = []
|
440
|
+
include Aws::Structure
|
441
|
+
end
|
442
|
+
|
443
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateBatchImportJobResult AWS API Documentation
|
444
|
+
#
|
445
|
+
class CreateBatchImportJobResult < Aws::EmptyStructure; end
|
446
|
+
|
296
447
|
# @note When making an API call, you may pass CreateBatchPredictionJobRequest
|
297
448
|
# data as a hash:
|
298
449
|
#
|
@@ -380,8 +531,8 @@ module Aws::FraudDetector
|
|
380
531
|
# model_versions: [
|
381
532
|
# {
|
382
533
|
# model_id: "modelIdentifier", # required
|
383
|
-
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
|
384
|
-
# model_version_number: "
|
534
|
+
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
|
535
|
+
# model_version_number: "floatVersionString", # required
|
385
536
|
# arn: "fraudDetectorArn",
|
386
537
|
# },
|
387
538
|
# ],
|
@@ -478,7 +629,7 @@ module Aws::FraudDetector
|
|
478
629
|
#
|
479
630
|
# {
|
480
631
|
# model_id: "modelIdentifier", # required
|
481
|
-
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
|
632
|
+
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
|
482
633
|
# description: "description",
|
483
634
|
# event_type_name: "string", # required
|
484
635
|
# tags: [
|
@@ -530,20 +681,27 @@ module Aws::FraudDetector
|
|
530
681
|
#
|
531
682
|
# {
|
532
683
|
# model_id: "modelIdentifier", # required
|
533
|
-
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
|
534
|
-
# training_data_source: "EXTERNAL_EVENTS", # required, accepts EXTERNAL_EVENTS
|
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
|
535
686
|
# training_data_schema: { # required
|
536
687
|
# model_variables: ["string"], # required
|
537
688
|
# label_schema: { # required
|
538
689
|
# label_mapper: { # required
|
539
690
|
# "string" => ["string"],
|
540
691
|
# },
|
692
|
+
# unlabeled_events_treatment: "IGNORE", # accepts IGNORE, FRAUD, LEGIT
|
541
693
|
# },
|
542
694
|
# },
|
543
695
|
# external_events_detail: {
|
544
696
|
# data_location: "s3BucketLocation", # required
|
545
697
|
# data_access_role_arn: "iamRoleArn", # required
|
546
698
|
# },
|
699
|
+
# ingested_events_detail: {
|
700
|
+
# ingested_events_time_window: { # required
|
701
|
+
# start_time: "time", # required
|
702
|
+
# end_time: "time", # required
|
703
|
+
# },
|
704
|
+
# },
|
547
705
|
# tags: [
|
548
706
|
# {
|
549
707
|
# key: "tagKey", # required
|
@@ -569,10 +727,15 @@ module Aws::FraudDetector
|
|
569
727
|
# @return [Types::TrainingDataSchema]
|
570
728
|
#
|
571
729
|
# @!attribute [rw] external_events_detail
|
572
|
-
# Details
|
573
|
-
#
|
730
|
+
# Details of the external events data used for model version training.
|
731
|
+
# Required if `trainingDataSource` is `EXTERNAL_EVENTS`.
|
574
732
|
# @return [Types::ExternalEventsDetail]
|
575
733
|
#
|
734
|
+
# @!attribute [rw] ingested_events_detail
|
735
|
+
# Details of the ingested events data used for model version training.
|
736
|
+
# Required if `trainingDataSource` is `INGESTED_EVENTS`.
|
737
|
+
# @return [Types::IngestedEventsDetail]
|
738
|
+
#
|
576
739
|
# @!attribute [rw] tags
|
577
740
|
# A collection of key and value pairs.
|
578
741
|
# @return [Array<Types::Tag>]
|
@@ -585,6 +748,7 @@ module Aws::FraudDetector
|
|
585
748
|
:training_data_source,
|
586
749
|
:training_data_schema,
|
587
750
|
:external_events_detail,
|
751
|
+
:ingested_events_detail,
|
588
752
|
:tags)
|
589
753
|
SENSITIVE = []
|
590
754
|
include Aws::Structure
|
@@ -786,6 +950,29 @@ module Aws::FraudDetector
|
|
786
950
|
include Aws::Structure
|
787
951
|
end
|
788
952
|
|
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
|
+
# @!attribute [rw] job_id
|
961
|
+
# The ID of the batch import job to delete.
|
962
|
+
# @return [String]
|
963
|
+
#
|
964
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteBatchImportJobRequest AWS API Documentation
|
965
|
+
#
|
966
|
+
class DeleteBatchImportJobRequest < Struct.new(
|
967
|
+
:job_id)
|
968
|
+
SENSITIVE = []
|
969
|
+
include Aws::Structure
|
970
|
+
end
|
971
|
+
|
972
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteBatchImportJobResult AWS API Documentation
|
973
|
+
#
|
974
|
+
class DeleteBatchImportJobResult < Aws::EmptyStructure; end
|
975
|
+
|
789
976
|
# @note When making an API call, you may pass DeleteBatchPredictionJobRequest
|
790
977
|
# data as a hash:
|
791
978
|
#
|
@@ -890,6 +1077,7 @@ module Aws::FraudDetector
|
|
890
1077
|
# {
|
891
1078
|
# event_id: "identifier", # required
|
892
1079
|
# event_type_name: "identifier", # required
|
1080
|
+
# delete_audit_history: false,
|
893
1081
|
# }
|
894
1082
|
#
|
895
1083
|
# @!attribute [rw] event_id
|
@@ -900,11 +1088,17 @@ module Aws::FraudDetector
|
|
900
1088
|
# The name of the event type.
|
901
1089
|
# @return [String]
|
902
1090
|
#
|
1091
|
+
# @!attribute [rw] delete_audit_history
|
1092
|
+
# Specifies whether or not to delete any predictions associated with
|
1093
|
+
# the event.
|
1094
|
+
# @return [Boolean]
|
1095
|
+
#
|
903
1096
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteEventRequest AWS API Documentation
|
904
1097
|
#
|
905
1098
|
class DeleteEventRequest < Struct.new(
|
906
1099
|
:event_id,
|
907
|
-
:event_type_name
|
1100
|
+
:event_type_name,
|
1101
|
+
:delete_audit_history)
|
908
1102
|
SENSITIVE = []
|
909
1103
|
include Aws::Structure
|
910
1104
|
end
|
@@ -936,6 +1130,42 @@ module Aws::FraudDetector
|
|
936
1130
|
#
|
937
1131
|
class DeleteEventTypeResult < Aws::EmptyStructure; end
|
938
1132
|
|
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
|
+
# @!attribute [rw] event_type_name
|
1141
|
+
# The name of the event type.
|
1142
|
+
# @return [String]
|
1143
|
+
#
|
1144
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteEventsByEventTypeRequest AWS API Documentation
|
1145
|
+
#
|
1146
|
+
class DeleteEventsByEventTypeRequest < Struct.new(
|
1147
|
+
:event_type_name)
|
1148
|
+
SENSITIVE = []
|
1149
|
+
include Aws::Structure
|
1150
|
+
end
|
1151
|
+
|
1152
|
+
# @!attribute [rw] event_type_name
|
1153
|
+
# Name of event type for which to delete the events.
|
1154
|
+
# @return [String]
|
1155
|
+
#
|
1156
|
+
# @!attribute [rw] events_deletion_status
|
1157
|
+
# The status of the delete request.
|
1158
|
+
# @return [String]
|
1159
|
+
#
|
1160
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteEventsByEventTypeResult AWS API Documentation
|
1161
|
+
#
|
1162
|
+
class DeleteEventsByEventTypeResult < Struct.new(
|
1163
|
+
:event_type_name,
|
1164
|
+
:events_deletion_status)
|
1165
|
+
SENSITIVE = []
|
1166
|
+
include Aws::Structure
|
1167
|
+
end
|
1168
|
+
|
939
1169
|
# @note When making an API call, you may pass DeleteExternalModelRequest
|
940
1170
|
# data as a hash:
|
941
1171
|
#
|
@@ -987,7 +1217,7 @@ module Aws::FraudDetector
|
|
987
1217
|
#
|
988
1218
|
# {
|
989
1219
|
# model_id: "modelIdentifier", # required
|
990
|
-
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
|
1220
|
+
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
|
991
1221
|
# }
|
992
1222
|
#
|
993
1223
|
# @!attribute [rw] model_id
|
@@ -1016,7 +1246,7 @@ module Aws::FraudDetector
|
|
1016
1246
|
#
|
1017
1247
|
# {
|
1018
1248
|
# model_id: "modelIdentifier", # required
|
1019
|
-
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
|
1249
|
+
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
|
1020
1250
|
# model_version_number: "floatVersionString", # required
|
1021
1251
|
# }
|
1022
1252
|
#
|
@@ -1183,7 +1413,7 @@ module Aws::FraudDetector
|
|
1183
1413
|
# {
|
1184
1414
|
# model_id: "modelIdentifier",
|
1185
1415
|
# model_version_number: "floatVersionString",
|
1186
|
-
# model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
|
1416
|
+
# model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
|
1187
1417
|
# next_token: "string",
|
1188
1418
|
# max_results: 1,
|
1189
1419
|
# }
|
@@ -1312,7 +1542,7 @@ module Aws::FraudDetector
|
|
1312
1542
|
#
|
1313
1543
|
# {
|
1314
1544
|
# entity_type: "string", # required
|
1315
|
-
# entity_id: "
|
1545
|
+
# entity_id: "entityRestrictedString", # required
|
1316
1546
|
# }
|
1317
1547
|
#
|
1318
1548
|
# @!attribute [rw] entity_type
|
@@ -1367,6 +1597,54 @@ module Aws::FraudDetector
|
|
1367
1597
|
include Aws::Structure
|
1368
1598
|
end
|
1369
1599
|
|
1600
|
+
# The event details.
|
1601
|
+
#
|
1602
|
+
# @!attribute [rw] event_id
|
1603
|
+
# The event ID.
|
1604
|
+
# @return [String]
|
1605
|
+
#
|
1606
|
+
# @!attribute [rw] event_type_name
|
1607
|
+
# The event type.
|
1608
|
+
# @return [String]
|
1609
|
+
#
|
1610
|
+
# @!attribute [rw] event_timestamp
|
1611
|
+
# The timestamp that defines when the event under evaluation occurred.
|
1612
|
+
# The timestamp must be specified using ISO 8601 standard in UTC.
|
1613
|
+
# @return [String]
|
1614
|
+
#
|
1615
|
+
# @!attribute [rw] event_variables
|
1616
|
+
# Names of the event type's variables you defined in Amazon Fraud
|
1617
|
+
# Detector to represent data elements and their corresponding values
|
1618
|
+
# for the event you are sending for evaluation.
|
1619
|
+
# @return [Hash<String,String>]
|
1620
|
+
#
|
1621
|
+
# @!attribute [rw] current_label
|
1622
|
+
# The label associated with the event.
|
1623
|
+
# @return [String]
|
1624
|
+
#
|
1625
|
+
# @!attribute [rw] label_timestamp
|
1626
|
+
# The timestamp associated with the label to update. The timestamp
|
1627
|
+
# must be specified using ISO 8601 standard in UTC.
|
1628
|
+
# @return [String]
|
1629
|
+
#
|
1630
|
+
# @!attribute [rw] entities
|
1631
|
+
# The event entities.
|
1632
|
+
# @return [Array<Types::Entity>]
|
1633
|
+
#
|
1634
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Event AWS API Documentation
|
1635
|
+
#
|
1636
|
+
class Event < Struct.new(
|
1637
|
+
:event_id,
|
1638
|
+
:event_type_name,
|
1639
|
+
:event_timestamp,
|
1640
|
+
:event_variables,
|
1641
|
+
:current_label,
|
1642
|
+
:label_timestamp,
|
1643
|
+
:entities)
|
1644
|
+
SENSITIVE = []
|
1645
|
+
include Aws::Structure
|
1646
|
+
end
|
1647
|
+
|
1370
1648
|
# The event type details.
|
1371
1649
|
#
|
1372
1650
|
# @!attribute [rw] name
|
@@ -1389,6 +1667,18 @@ module Aws::FraudDetector
|
|
1389
1667
|
# The event type entity types.
|
1390
1668
|
# @return [Array<String>]
|
1391
1669
|
#
|
1670
|
+
# @!attribute [rw] event_ingestion
|
1671
|
+
# If `Enabled`, Amazon Fraud Detector stores event data when you
|
1672
|
+
# generate a prediction and uses that data to update calculated
|
1673
|
+
# variables in near real-time. Amazon Fraud Detector uses this data,
|
1674
|
+
# known as `INGESTED_EVENTS`, to train your model and improve fraud
|
1675
|
+
# predictions.
|
1676
|
+
# @return [String]
|
1677
|
+
#
|
1678
|
+
# @!attribute [rw] ingested_event_statistics
|
1679
|
+
# Data about the stored events.
|
1680
|
+
# @return [Types::IngestedEventStatistics]
|
1681
|
+
#
|
1392
1682
|
# @!attribute [rw] last_updated_time
|
1393
1683
|
# Timestamp of when the event type was last updated.
|
1394
1684
|
# @return [String]
|
@@ -1409,6 +1699,8 @@ module Aws::FraudDetector
|
|
1409
1699
|
:event_variables,
|
1410
1700
|
:labels,
|
1411
1701
|
:entity_types,
|
1702
|
+
:event_ingestion,
|
1703
|
+
:ingested_event_statistics,
|
1412
1704
|
:last_updated_time,
|
1413
1705
|
:created_time,
|
1414
1706
|
:arn)
|
@@ -1498,6 +1790,44 @@ module Aws::FraudDetector
|
|
1498
1790
|
include Aws::Structure
|
1499
1791
|
end
|
1500
1792
|
|
1793
|
+
# The fraud prediction scores from Amazon SageMaker model.
|
1794
|
+
#
|
1795
|
+
# @!attribute [rw] external_model
|
1796
|
+
# The Amazon SageMaker model.
|
1797
|
+
# @return [Types::ExternalModelSummary]
|
1798
|
+
#
|
1799
|
+
# @!attribute [rw] outputs
|
1800
|
+
# The fraud prediction scores from Amazon SageMaker model.
|
1801
|
+
# @return [Hash<String,String>]
|
1802
|
+
#
|
1803
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ExternalModelOutputs AWS API Documentation
|
1804
|
+
#
|
1805
|
+
class ExternalModelOutputs < Struct.new(
|
1806
|
+
:external_model,
|
1807
|
+
:outputs)
|
1808
|
+
SENSITIVE = []
|
1809
|
+
include Aws::Structure
|
1810
|
+
end
|
1811
|
+
|
1812
|
+
# The Amazon SageMaker model.
|
1813
|
+
#
|
1814
|
+
# @!attribute [rw] model_endpoint
|
1815
|
+
# The endpoint of the Amazon SageMaker model.
|
1816
|
+
# @return [String]
|
1817
|
+
#
|
1818
|
+
# @!attribute [rw] model_source
|
1819
|
+
# The source of the model.
|
1820
|
+
# @return [String]
|
1821
|
+
#
|
1822
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ExternalModelSummary AWS API Documentation
|
1823
|
+
#
|
1824
|
+
class ExternalModelSummary < Struct.new(
|
1825
|
+
:model_endpoint,
|
1826
|
+
:model_source)
|
1827
|
+
SENSITIVE = []
|
1828
|
+
include Aws::Structure
|
1829
|
+
end
|
1830
|
+
|
1501
1831
|
# The message details.
|
1502
1832
|
#
|
1503
1833
|
# @!attribute [rw] field_name
|
@@ -1556,6 +1886,54 @@ module Aws::FraudDetector
|
|
1556
1886
|
include Aws::Structure
|
1557
1887
|
end
|
1558
1888
|
|
1889
|
+
# @note When making an API call, you may pass GetBatchImportJobsRequest
|
1890
|
+
# data as a hash:
|
1891
|
+
#
|
1892
|
+
# {
|
1893
|
+
# job_id: "identifier",
|
1894
|
+
# max_results: 1,
|
1895
|
+
# next_token: "string",
|
1896
|
+
# }
|
1897
|
+
#
|
1898
|
+
# @!attribute [rw] job_id
|
1899
|
+
# The ID of the batch import job to get.
|
1900
|
+
# @return [String]
|
1901
|
+
#
|
1902
|
+
# @!attribute [rw] max_results
|
1903
|
+
# The maximum number of objects to return for request.
|
1904
|
+
# @return [Integer]
|
1905
|
+
#
|
1906
|
+
# @!attribute [rw] next_token
|
1907
|
+
# The next token from the previous request.
|
1908
|
+
# @return [String]
|
1909
|
+
#
|
1910
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetBatchImportJobsRequest AWS API Documentation
|
1911
|
+
#
|
1912
|
+
class GetBatchImportJobsRequest < Struct.new(
|
1913
|
+
:job_id,
|
1914
|
+
:max_results,
|
1915
|
+
:next_token)
|
1916
|
+
SENSITIVE = []
|
1917
|
+
include Aws::Structure
|
1918
|
+
end
|
1919
|
+
|
1920
|
+
# @!attribute [rw] batch_imports
|
1921
|
+
# An array containing the details of each batch import job.
|
1922
|
+
# @return [Array<Types::BatchImport>]
|
1923
|
+
#
|
1924
|
+
# @!attribute [rw] next_token
|
1925
|
+
# The next token for the subsequent resquest.
|
1926
|
+
# @return [String]
|
1927
|
+
#
|
1928
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetBatchImportJobsResult AWS API Documentation
|
1929
|
+
#
|
1930
|
+
class GetBatchImportJobsResult < Struct.new(
|
1931
|
+
:batch_imports,
|
1932
|
+
:next_token)
|
1933
|
+
SENSITIVE = []
|
1934
|
+
include Aws::Structure
|
1935
|
+
end
|
1936
|
+
|
1559
1937
|
# @note When making an API call, you may pass GetBatchPredictionJobsRequest
|
1560
1938
|
# data as a hash:
|
1561
1939
|
#
|
@@ -1604,6 +1982,42 @@ module Aws::FraudDetector
|
|
1604
1982
|
include Aws::Structure
|
1605
1983
|
end
|
1606
1984
|
|
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
|
+
# @!attribute [rw] event_type_name
|
1993
|
+
# Name of event type for which to get the deletion status.
|
1994
|
+
# @return [String]
|
1995
|
+
#
|
1996
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetDeleteEventsByEventTypeStatusRequest AWS API Documentation
|
1997
|
+
#
|
1998
|
+
class GetDeleteEventsByEventTypeStatusRequest < Struct.new(
|
1999
|
+
:event_type_name)
|
2000
|
+
SENSITIVE = []
|
2001
|
+
include Aws::Structure
|
2002
|
+
end
|
2003
|
+
|
2004
|
+
# @!attribute [rw] event_type_name
|
2005
|
+
# The event type name.
|
2006
|
+
# @return [String]
|
2007
|
+
#
|
2008
|
+
# @!attribute [rw] events_deletion_status
|
2009
|
+
# The deletion status.
|
2010
|
+
# @return [String]
|
2011
|
+
#
|
2012
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetDeleteEventsByEventTypeStatusResult AWS API Documentation
|
2013
|
+
#
|
2014
|
+
class GetDeleteEventsByEventTypeStatusResult < Struct.new(
|
2015
|
+
:event_type_name,
|
2016
|
+
:events_deletion_status)
|
2017
|
+
SENSITIVE = []
|
2018
|
+
include Aws::Structure
|
2019
|
+
end
|
2020
|
+
|
1607
2021
|
# @note When making an API call, you may pass GetDetectorVersionRequest
|
1608
2022
|
# data as a hash:
|
1609
2023
|
#
|
@@ -1809,15 +2223,15 @@ module Aws::FraudDetector
|
|
1809
2223
|
# entities: [ # required
|
1810
2224
|
# {
|
1811
2225
|
# entity_type: "string", # required
|
1812
|
-
# entity_id: "
|
2226
|
+
# entity_id: "entityRestrictedString", # required
|
1813
2227
|
# },
|
1814
2228
|
# ],
|
1815
|
-
# event_timestamp: "
|
2229
|
+
# event_timestamp: "utcTimestampISO8601", # required
|
1816
2230
|
# event_variables: { # required
|
1817
2231
|
# "variableName" => "variableValue",
|
1818
2232
|
# },
|
1819
2233
|
# external_model_endpoint_data_blobs: {
|
1820
|
-
# "
|
2234
|
+
# "sageMakerEndpointIdentifier" => {
|
1821
2235
|
# byte_buffer: "data",
|
1822
2236
|
# content_type: "contentType",
|
1823
2237
|
# },
|
@@ -1848,7 +2262,8 @@ module Aws::FraudDetector
|
|
1848
2262
|
# @return [Array<Types::Entity>]
|
1849
2263
|
#
|
1850
2264
|
# @!attribute [rw] event_timestamp
|
1851
|
-
# Timestamp that defines when the event under evaluation occurred.
|
2265
|
+
# Timestamp that defines when the event under evaluation occurred. The
|
2266
|
+
# timestamp must be specified using ISO 8601 standard in UTC.
|
1852
2267
|
# @return [String]
|
1853
2268
|
#
|
1854
2269
|
# @!attribute [rw] event_variables
|
@@ -1856,13 +2271,10 @@ module Aws::FraudDetector
|
|
1856
2271
|
# Detector to represent data elements and their corresponding values
|
1857
2272
|
# for the event you are sending for evaluation.
|
1858
2273
|
#
|
1859
|
-
#
|
2274
|
+
# You must provide at least one eventVariable
|
1860
2275
|
#
|
1861
|
-
#
|
1862
|
-
#
|
1863
|
-
#
|
1864
|
-
# To ensure highest possible fraud prediction and to simplify your
|
1865
|
-
# data preparation, Amazon Fraud Detector will replace all missing
|
2276
|
+
# To ensure most accurate fraud prediction and to simplify your data
|
2277
|
+
# preparation, Amazon Fraud Detector will replace all missing
|
1866
2278
|
# variables or values as follows:
|
1867
2279
|
#
|
1868
2280
|
# **For Amazon Fraud Detector trained models:**
|
@@ -1873,7 +2285,7 @@ module Aws::FraudDetector
|
|
1873
2285
|
# calculated default mean/medians for numeric variables and with
|
1874
2286
|
# special values for categorical variables.
|
1875
2287
|
#
|
1876
|
-
# **For
|
2288
|
+
# **For imported SageMaker models:**
|
1877
2289
|
#
|
1878
2290
|
# If a null value is provided explicitly for a variable, the model and
|
1879
2291
|
# rules will use “null” as the value. If a variable is not provided
|
@@ -1910,14 +2322,56 @@ module Aws::FraudDetector
|
|
1910
2322
|
# @return [Array<Types::ModelScores>]
|
1911
2323
|
#
|
1912
2324
|
# @!attribute [rw] rule_results
|
1913
|
-
# The results.
|
2325
|
+
# The results from the rules.
|
1914
2326
|
# @return [Array<Types::RuleResult>]
|
1915
2327
|
#
|
2328
|
+
# @!attribute [rw] external_model_outputs
|
2329
|
+
# The model scores for Amazon SageMaker models.
|
2330
|
+
# @return [Array<Types::ExternalModelOutputs>]
|
2331
|
+
#
|
1916
2332
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventPredictionResult AWS API Documentation
|
1917
2333
|
#
|
1918
2334
|
class GetEventPredictionResult < Struct.new(
|
1919
2335
|
:model_scores,
|
1920
|
-
:rule_results
|
2336
|
+
:rule_results,
|
2337
|
+
:external_model_outputs)
|
2338
|
+
SENSITIVE = []
|
2339
|
+
include Aws::Structure
|
2340
|
+
end
|
2341
|
+
|
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
|
+
# @!attribute [rw] event_id
|
2351
|
+
# The ID of the event to retrieve.
|
2352
|
+
# @return [String]
|
2353
|
+
#
|
2354
|
+
# @!attribute [rw] event_type_name
|
2355
|
+
# The event type of the event to retrieve.
|
2356
|
+
# @return [String]
|
2357
|
+
#
|
2358
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventRequest AWS API Documentation
|
2359
|
+
#
|
2360
|
+
class GetEventRequest < Struct.new(
|
2361
|
+
:event_id,
|
2362
|
+
:event_type_name)
|
2363
|
+
SENSITIVE = []
|
2364
|
+
include Aws::Structure
|
2365
|
+
end
|
2366
|
+
|
2367
|
+
# @!attribute [rw] event
|
2368
|
+
# The details of the event.
|
2369
|
+
# @return [Types::Event]
|
2370
|
+
#
|
2371
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventResult AWS API Documentation
|
2372
|
+
#
|
2373
|
+
class GetEventResult < Struct.new(
|
2374
|
+
:event)
|
1921
2375
|
SENSITIVE = []
|
1922
2376
|
include Aws::Structure
|
1923
2377
|
end
|
@@ -2083,7 +2537,7 @@ module Aws::FraudDetector
|
|
2083
2537
|
#
|
2084
2538
|
# {
|
2085
2539
|
# model_id: "modelIdentifier", # required
|
2086
|
-
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
|
2540
|
+
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
|
2087
2541
|
# model_version_number: "floatVersionString", # required
|
2088
2542
|
# }
|
2089
2543
|
#
|
@@ -2130,9 +2584,17 @@ module Aws::FraudDetector
|
|
2130
2584
|
# @return [Types::TrainingDataSchema]
|
2131
2585
|
#
|
2132
2586
|
# @!attribute [rw] external_events_detail
|
2133
|
-
# The
|
2587
|
+
# The details of the external events data used for training the model
|
2588
|
+
# version. This will be populated if the `trainingDataSource` is
|
2589
|
+
# `EXTERNAL_EVENTS`
|
2134
2590
|
# @return [Types::ExternalEventsDetail]
|
2135
2591
|
#
|
2592
|
+
# @!attribute [rw] ingested_events_detail
|
2593
|
+
# The details of the ingested events data used for training the model
|
2594
|
+
# version. This will be populated if the `trainingDataSource` is
|
2595
|
+
# `INGESTED_EVENTS`.
|
2596
|
+
# @return [Types::IngestedEventsDetail]
|
2597
|
+
#
|
2136
2598
|
# @!attribute [rw] status
|
2137
2599
|
# The model version status.
|
2138
2600
|
#
|
@@ -2170,6 +2632,7 @@ module Aws::FraudDetector
|
|
2170
2632
|
:training_data_source,
|
2171
2633
|
:training_data_schema,
|
2172
2634
|
:external_events_detail,
|
2635
|
+
:ingested_events_detail,
|
2173
2636
|
:status,
|
2174
2637
|
:arn)
|
2175
2638
|
SENSITIVE = []
|
@@ -2181,7 +2644,7 @@ module Aws::FraudDetector
|
|
2181
2644
|
#
|
2182
2645
|
# {
|
2183
2646
|
# model_id: "modelIdentifier",
|
2184
|
-
# model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
|
2647
|
+
# model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
|
2185
2648
|
# next_token: "string",
|
2186
2649
|
# max_results: 1,
|
2187
2650
|
# }
|
@@ -2386,6 +2849,91 @@ module Aws::FraudDetector
|
|
2386
2849
|
include Aws::Structure
|
2387
2850
|
end
|
2388
2851
|
|
2852
|
+
# Data about the stored events.
|
2853
|
+
#
|
2854
|
+
# @!attribute [rw] number_of_events
|
2855
|
+
# The number of stored events.
|
2856
|
+
# @return [Integer]
|
2857
|
+
#
|
2858
|
+
# @!attribute [rw] event_data_size_in_bytes
|
2859
|
+
# The total size of the stored events.
|
2860
|
+
# @return [Integer]
|
2861
|
+
#
|
2862
|
+
# @!attribute [rw] least_recent_event
|
2863
|
+
# The oldest stored event.
|
2864
|
+
# @return [String]
|
2865
|
+
#
|
2866
|
+
# @!attribute [rw] most_recent_event
|
2867
|
+
# The newest stored event.
|
2868
|
+
# @return [String]
|
2869
|
+
#
|
2870
|
+
# @!attribute [rw] last_updated_time
|
2871
|
+
# Timestamp of when the stored event was last updated.
|
2872
|
+
# @return [String]
|
2873
|
+
#
|
2874
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/IngestedEventStatistics AWS API Documentation
|
2875
|
+
#
|
2876
|
+
class IngestedEventStatistics < Struct.new(
|
2877
|
+
:number_of_events,
|
2878
|
+
:event_data_size_in_bytes,
|
2879
|
+
:least_recent_event,
|
2880
|
+
:most_recent_event,
|
2881
|
+
:last_updated_time)
|
2882
|
+
SENSITIVE = []
|
2883
|
+
include Aws::Structure
|
2884
|
+
end
|
2885
|
+
|
2886
|
+
# The details of the ingested event.
|
2887
|
+
#
|
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
|
+
# @!attribute [rw] ingested_events_time_window
|
2899
|
+
# The start and stop time of the ingested events.
|
2900
|
+
# @return [Types::IngestedEventsTimeWindow]
|
2901
|
+
#
|
2902
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/IngestedEventsDetail AWS API Documentation
|
2903
|
+
#
|
2904
|
+
class IngestedEventsDetail < Struct.new(
|
2905
|
+
:ingested_events_time_window)
|
2906
|
+
SENSITIVE = []
|
2907
|
+
include Aws::Structure
|
2908
|
+
end
|
2909
|
+
|
2910
|
+
# The start and stop time of the ingested events.
|
2911
|
+
#
|
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
|
+
# @!attribute [rw] start_time
|
2921
|
+
# Timestamp of the first ingensted event.
|
2922
|
+
# @return [String]
|
2923
|
+
#
|
2924
|
+
# @!attribute [rw] end_time
|
2925
|
+
# Timestamp of the final ingested event.
|
2926
|
+
# @return [String]
|
2927
|
+
#
|
2928
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/IngestedEventsTimeWindow AWS API Documentation
|
2929
|
+
#
|
2930
|
+
class IngestedEventsTimeWindow < Struct.new(
|
2931
|
+
:start_time,
|
2932
|
+
:end_time)
|
2933
|
+
SENSITIVE = []
|
2934
|
+
include Aws::Structure
|
2935
|
+
end
|
2936
|
+
|
2389
2937
|
# An exception indicating an internal server error.
|
2390
2938
|
#
|
2391
2939
|
# @!attribute [rw] message
|
@@ -2456,6 +3004,7 @@ module Aws::FraudDetector
|
|
2456
3004
|
# label_mapper: { # required
|
2457
3005
|
# "string" => ["string"],
|
2458
3006
|
# },
|
3007
|
+
# unlabeled_events_treatment: "IGNORE", # accepts IGNORE, FRAUD, LEGIT
|
2459
3008
|
# }
|
2460
3009
|
#
|
2461
3010
|
# @!attribute [rw] label_mapper
|
@@ -2470,10 +3019,15 @@ module Aws::FraudDetector
|
|
2470
3019
|
# for a single Amazon Fraud Detector label.
|
2471
3020
|
# @return [Hash<String,Array<String>>]
|
2472
3021
|
#
|
3022
|
+
# @!attribute [rw] unlabeled_events_treatment
|
3023
|
+
# The action to take for unlabeled events.
|
3024
|
+
# @return [String]
|
3025
|
+
#
|
2473
3026
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/LabelSchema AWS API Documentation
|
2474
3027
|
#
|
2475
3028
|
class LabelSchema < Struct.new(
|
2476
|
-
:label_mapper
|
3029
|
+
:label_mapper,
|
3030
|
+
:unlabeled_events_treatment)
|
2477
3031
|
SENSITIVE = []
|
2478
3032
|
include Aws::Structure
|
2479
3033
|
end
|
@@ -2526,7 +3080,7 @@ module Aws::FraudDetector
|
|
2526
3080
|
include Aws::Structure
|
2527
3081
|
end
|
2528
3082
|
|
2529
|
-
# The
|
3083
|
+
# The log odds metric details.
|
2530
3084
|
#
|
2531
3085
|
# @!attribute [rw] variable_name
|
2532
3086
|
# The name of the variable.
|
@@ -2537,12 +3091,17 @@ module Aws::FraudDetector
|
|
2537
3091
|
# @return [String]
|
2538
3092
|
#
|
2539
3093
|
# @!attribute [rw] variable_importance
|
2540
|
-
# The relative importance of the variable.
|
3094
|
+
# The relative importance of the variable. For more information, see
|
3095
|
+
# [Model variable importance][1].
|
3096
|
+
#
|
3097
|
+
#
|
3098
|
+
#
|
3099
|
+
# [1]: https://docs.aws.amazon.com/frauddetector/latest/ug/model-variable-importance.html
|
2541
3100
|
# @return [Float]
|
2542
3101
|
#
|
2543
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/
|
3102
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/LogOddsMetric AWS API Documentation
|
2544
3103
|
#
|
2545
|
-
class
|
3104
|
+
class LogOddsMetric < Struct.new(
|
2546
3105
|
:variable_name,
|
2547
3106
|
:variable_type,
|
2548
3107
|
:variable_importance)
|
@@ -2668,8 +3227,8 @@ module Aws::FraudDetector
|
|
2668
3227
|
# event_type_name: "identifier",
|
2669
3228
|
# format: "TEXT_CSV", # accepts TEXT_CSV, APPLICATION_JSON
|
2670
3229
|
# use_event_variables: false, # required
|
2671
|
-
# json_input_template: "
|
2672
|
-
# csv_input_template: "
|
3230
|
+
# json_input_template: "modelInputTemplate",
|
3231
|
+
# csv_input_template: "modelInputTemplate",
|
2673
3232
|
# }
|
2674
3233
|
#
|
2675
3234
|
# @!attribute [rw] event_type_name
|
@@ -2777,8 +3336,8 @@ module Aws::FraudDetector
|
|
2777
3336
|
#
|
2778
3337
|
# {
|
2779
3338
|
# model_id: "modelIdentifier", # required
|
2780
|
-
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
|
2781
|
-
# model_version_number: "
|
3339
|
+
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
|
3340
|
+
# model_version_number: "floatVersionString", # required
|
2782
3341
|
# arn: "fraudDetectorArn",
|
2783
3342
|
# }
|
2784
3343
|
#
|
@@ -2836,9 +3395,17 @@ module Aws::FraudDetector
|
|
2836
3395
|
# @return [Types::TrainingDataSchema]
|
2837
3396
|
#
|
2838
3397
|
# @!attribute [rw] external_events_detail
|
2839
|
-
# The
|
3398
|
+
# The external events data details. This will be populated if the
|
3399
|
+
# `trainingDataSource` for the model version is specified as
|
3400
|
+
# `EXTERNAL_EVENTS`.
|
2840
3401
|
# @return [Types::ExternalEventsDetail]
|
2841
3402
|
#
|
3403
|
+
# @!attribute [rw] ingested_events_detail
|
3404
|
+
# The ingested events data details. This will be populated if the
|
3405
|
+
# `trainingDataSource` for the model version is specified as
|
3406
|
+
# `INGESTED_EVENTS`.
|
3407
|
+
# @return [Types::IngestedEventsDetail]
|
3408
|
+
#
|
2842
3409
|
# @!attribute [rw] training_result
|
2843
3410
|
# The training results.
|
2844
3411
|
# @return [Types::TrainingResult]
|
@@ -2865,6 +3432,7 @@ module Aws::FraudDetector
|
|
2865
3432
|
:training_data_source,
|
2866
3433
|
:training_data_schema,
|
2867
3434
|
:external_events_detail,
|
3435
|
+
:ingested_events_detail,
|
2868
3436
|
:training_result,
|
2869
3437
|
:last_updated_time,
|
2870
3438
|
:created_time,
|
@@ -3002,6 +3570,7 @@ module Aws::FraudDetector
|
|
3002
3570
|
# event_variables: ["string"], # required
|
3003
3571
|
# labels: ["string"],
|
3004
3572
|
# entity_types: ["string"], # required
|
3573
|
+
# event_ingestion: "ENABLED", # accepts ENABLED, DISABLED
|
3005
3574
|
# tags: [
|
3006
3575
|
# {
|
3007
3576
|
# key: "tagKey", # required
|
@@ -3031,6 +3600,10 @@ module Aws::FraudDetector
|
|
3031
3600
|
# merchant, account.
|
3032
3601
|
# @return [Array<String>]
|
3033
3602
|
#
|
3603
|
+
# @!attribute [rw] event_ingestion
|
3604
|
+
# Specifies if ingenstion is enabled or disabled.
|
3605
|
+
# @return [String]
|
3606
|
+
#
|
3034
3607
|
# @!attribute [rw] tags
|
3035
3608
|
# A collection of key and value pairs.
|
3036
3609
|
# @return [Array<Types::Tag>]
|
@@ -3043,6 +3616,7 @@ module Aws::FraudDetector
|
|
3043
3616
|
:event_variables,
|
3044
3617
|
:labels,
|
3045
3618
|
:entity_types,
|
3619
|
+
:event_ingestion,
|
3046
3620
|
:tags)
|
3047
3621
|
SENSITIVE = []
|
3048
3622
|
include Aws::Structure
|
@@ -3063,8 +3637,8 @@ module Aws::FraudDetector
|
|
3063
3637
|
# event_type_name: "identifier",
|
3064
3638
|
# format: "TEXT_CSV", # accepts TEXT_CSV, APPLICATION_JSON
|
3065
3639
|
# use_event_variables: false, # required
|
3066
|
-
# json_input_template: "
|
3067
|
-
# csv_input_template: "
|
3640
|
+
# json_input_template: "modelInputTemplate",
|
3641
|
+
# csv_input_template: "modelInputTemplate",
|
3068
3642
|
# },
|
3069
3643
|
# output_configuration: { # required
|
3070
3644
|
# format: "TEXT_CSV", # required, accepts TEXT_CSV, APPLICATION_JSONLINES
|
@@ -3245,6 +3819,20 @@ module Aws::FraudDetector
|
|
3245
3819
|
include Aws::Structure
|
3246
3820
|
end
|
3247
3821
|
|
3822
|
+
# An exception indicating that the attached customer-owned (external)
|
3823
|
+
# model threw an exception when Amazon Fraud Detector invoked the model.
|
3824
|
+
#
|
3825
|
+
# @!attribute [rw] message
|
3826
|
+
# @return [String]
|
3827
|
+
#
|
3828
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ResourceUnavailableException AWS API Documentation
|
3829
|
+
#
|
3830
|
+
class ResourceUnavailableException < Struct.new(
|
3831
|
+
:message)
|
3832
|
+
SENSITIVE = []
|
3833
|
+
include Aws::Structure
|
3834
|
+
end
|
3835
|
+
|
3248
3836
|
# A rule.
|
3249
3837
|
#
|
3250
3838
|
# @note When making an API call, you may pass Rule
|
@@ -3356,6 +3944,77 @@ module Aws::FraudDetector
|
|
3356
3944
|
include Aws::Structure
|
3357
3945
|
end
|
3358
3946
|
|
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
|
+
# @!attribute [rw] event_id
|
3968
|
+
# The event ID to upload.
|
3969
|
+
# @return [String]
|
3970
|
+
#
|
3971
|
+
# @!attribute [rw] event_type_name
|
3972
|
+
# The event type name of the event.
|
3973
|
+
# @return [String]
|
3974
|
+
#
|
3975
|
+
# @!attribute [rw] event_timestamp
|
3976
|
+
# The timestamp that defines when the event under evaluation occurred.
|
3977
|
+
# The timestamp must be specified using ISO 8601 standard in UTC.
|
3978
|
+
# @return [String]
|
3979
|
+
#
|
3980
|
+
# @!attribute [rw] event_variables
|
3981
|
+
# Names of the event type's variables you defined in Amazon Fraud
|
3982
|
+
# Detector to represent data elements and their corresponding values
|
3983
|
+
# for the event you are sending for evaluation.
|
3984
|
+
# @return [Hash<String,String>]
|
3985
|
+
#
|
3986
|
+
# @!attribute [rw] assigned_label
|
3987
|
+
# The label to associate with the event. Required if specifying
|
3988
|
+
# `labelTimestamp`.
|
3989
|
+
# @return [String]
|
3990
|
+
#
|
3991
|
+
# @!attribute [rw] label_timestamp
|
3992
|
+
# The timestamp associated with the label. Required if specifying
|
3993
|
+
# `assignedLabel`.
|
3994
|
+
# @return [String]
|
3995
|
+
#
|
3996
|
+
# @!attribute [rw] entities
|
3997
|
+
# An array of entities.
|
3998
|
+
# @return [Array<Types::Entity>]
|
3999
|
+
#
|
4000
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/SendEventRequest AWS API Documentation
|
4001
|
+
#
|
4002
|
+
class SendEventRequest < Struct.new(
|
4003
|
+
:event_id,
|
4004
|
+
:event_type_name,
|
4005
|
+
:event_timestamp,
|
4006
|
+
:event_variables,
|
4007
|
+
:assigned_label,
|
4008
|
+
:label_timestamp,
|
4009
|
+
:entities)
|
4010
|
+
SENSITIVE = []
|
4011
|
+
include Aws::Structure
|
4012
|
+
end
|
4013
|
+
|
4014
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/SendEventResult AWS API Documentation
|
4015
|
+
#
|
4016
|
+
class SendEventResult < Aws::EmptyStructure; end
|
4017
|
+
|
3359
4018
|
# A key and value pair.
|
3360
4019
|
#
|
3361
4020
|
# @note When making an API call, you may pass Tag
|
@@ -3441,6 +4100,7 @@ module Aws::FraudDetector
|
|
3441
4100
|
# label_mapper: { # required
|
3442
4101
|
# "string" => ["string"],
|
3443
4102
|
# },
|
4103
|
+
# unlabeled_events_treatment: "IGNORE", # accepts IGNORE, FRAUD, LEGIT
|
3444
4104
|
# },
|
3445
4105
|
# }
|
3446
4106
|
#
|
@@ -3589,8 +4249,8 @@ module Aws::FraudDetector
|
|
3589
4249
|
# model_versions: [
|
3590
4250
|
# {
|
3591
4251
|
# model_id: "modelIdentifier", # required
|
3592
|
-
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
|
3593
|
-
# model_version_number: "
|
4252
|
+
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
|
4253
|
+
# model_version_number: "floatVersionString", # required
|
3594
4254
|
# arn: "fraudDetectorArn",
|
3595
4255
|
# },
|
3596
4256
|
# ],
|
@@ -3691,12 +4351,54 @@ module Aws::FraudDetector
|
|
3691
4351
|
#
|
3692
4352
|
class UpdateDetectorVersionStatusResult < Aws::EmptyStructure; end
|
3693
4353
|
|
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
|
+
# @!attribute [rw] event_id
|
4365
|
+
# The ID of the event associated with the label to update.
|
4366
|
+
# @return [String]
|
4367
|
+
#
|
4368
|
+
# @!attribute [rw] event_type_name
|
4369
|
+
# The event type of the event associated with the label to update.
|
4370
|
+
# @return [String]
|
4371
|
+
#
|
4372
|
+
# @!attribute [rw] assigned_label
|
4373
|
+
# The new label to assign to the event.
|
4374
|
+
# @return [String]
|
4375
|
+
#
|
4376
|
+
# @!attribute [rw] label_timestamp
|
4377
|
+
# The timestamp associated with the label. The timestamp must be
|
4378
|
+
# specified using ISO 8601 standard in UTC.
|
4379
|
+
# @return [String]
|
4380
|
+
#
|
4381
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateEventLabelRequest AWS API Documentation
|
4382
|
+
#
|
4383
|
+
class UpdateEventLabelRequest < Struct.new(
|
4384
|
+
:event_id,
|
4385
|
+
:event_type_name,
|
4386
|
+
:assigned_label,
|
4387
|
+
:label_timestamp)
|
4388
|
+
SENSITIVE = []
|
4389
|
+
include Aws::Structure
|
4390
|
+
end
|
4391
|
+
|
4392
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateEventLabelResult AWS API Documentation
|
4393
|
+
#
|
4394
|
+
class UpdateEventLabelResult < Aws::EmptyStructure; end
|
4395
|
+
|
3694
4396
|
# @note When making an API call, you may pass UpdateModelRequest
|
3695
4397
|
# data as a hash:
|
3696
4398
|
#
|
3697
4399
|
# {
|
3698
4400
|
# model_id: "modelIdentifier", # required
|
3699
|
-
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
|
4401
|
+
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
|
3700
4402
|
# description: "description",
|
3701
4403
|
# }
|
3702
4404
|
#
|
@@ -3731,12 +4433,18 @@ module Aws::FraudDetector
|
|
3731
4433
|
#
|
3732
4434
|
# {
|
3733
4435
|
# model_id: "modelIdentifier", # required
|
3734
|
-
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
|
4436
|
+
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
|
3735
4437
|
# major_version_number: "wholeNumberVersionString", # required
|
3736
4438
|
# external_events_detail: {
|
3737
4439
|
# data_location: "s3BucketLocation", # required
|
3738
4440
|
# data_access_role_arn: "iamRoleArn", # required
|
3739
4441
|
# },
|
4442
|
+
# ingested_events_detail: {
|
4443
|
+
# ingested_events_time_window: { # required
|
4444
|
+
# start_time: "time", # required
|
4445
|
+
# end_time: "time", # required
|
4446
|
+
# },
|
4447
|
+
# },
|
3740
4448
|
# tags: [
|
3741
4449
|
# {
|
3742
4450
|
# key: "tagKey", # required
|
@@ -3758,9 +4466,15 @@ module Aws::FraudDetector
|
|
3758
4466
|
# @return [String]
|
3759
4467
|
#
|
3760
4468
|
# @!attribute [rw] external_events_detail
|
3761
|
-
# The
|
4469
|
+
# The details of the external events data used for training the model
|
4470
|
+
# version. Required if `trainingDataSource` is `EXTERNAL_EVENTS`.
|
3762
4471
|
# @return [Types::ExternalEventsDetail]
|
3763
4472
|
#
|
4473
|
+
# @!attribute [rw] ingested_events_detail
|
4474
|
+
# The details of the ingested event used for training the model
|
4475
|
+
# version. Required if your `trainingDataSource` is `INGESTED_EVENTS`.
|
4476
|
+
# @return [Types::IngestedEventsDetail]
|
4477
|
+
#
|
3764
4478
|
# @!attribute [rw] tags
|
3765
4479
|
# A collection of key and value pairs.
|
3766
4480
|
# @return [Array<Types::Tag>]
|
@@ -3772,6 +4486,7 @@ module Aws::FraudDetector
|
|
3772
4486
|
:model_type,
|
3773
4487
|
:major_version_number,
|
3774
4488
|
:external_events_detail,
|
4489
|
+
:ingested_events_detail,
|
3775
4490
|
:tags)
|
3776
4491
|
SENSITIVE = []
|
3777
4492
|
include Aws::Structure
|
@@ -3809,7 +4524,7 @@ module Aws::FraudDetector
|
|
3809
4524
|
#
|
3810
4525
|
# {
|
3811
4526
|
# model_id: "modelIdentifier", # required
|
3812
|
-
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
|
4527
|
+
# model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
|
3813
4528
|
# model_version_number: "floatVersionString", # required
|
3814
4529
|
# status: "ACTIVE", # required, accepts ACTIVE, INACTIVE, TRAINING_CANCELLED
|
3815
4530
|
# }
|
@@ -4144,14 +4859,14 @@ module Aws::FraudDetector
|
|
4144
4859
|
|
4145
4860
|
# The variable importance metrics details.
|
4146
4861
|
#
|
4147
|
-
# @!attribute [rw]
|
4862
|
+
# @!attribute [rw] log_odds_metrics
|
4148
4863
|
# List of variable metrics.
|
4149
|
-
# @return [Array<Types::
|
4864
|
+
# @return [Array<Types::LogOddsMetric>]
|
4150
4865
|
#
|
4151
4866
|
# @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/VariableImportanceMetrics AWS API Documentation
|
4152
4867
|
#
|
4153
4868
|
class VariableImportanceMetrics < Struct.new(
|
4154
|
-
:
|
4869
|
+
:log_odds_metrics)
|
4155
4870
|
SENSITIVE = []
|
4156
4871
|
include Aws::Structure
|
4157
4872
|
end
|