aws-sdk-frauddetector 1.23.0 → 1.27.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -285,6 +285,15 @@ module Aws::FraudDetector
285
285
  # ** Please note ** When response stubbing is enabled, no HTTP
286
286
  # requests are made, and retries are disabled.
287
287
  #
288
+ # @option options [Boolean] :use_dualstack_endpoint
289
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
290
+ # will be used if available.
291
+ #
292
+ # @option options [Boolean] :use_fips_endpoint
293
+ # When set to `true`, fips compatible endpoints will be used if available.
294
+ # When a `fips` region is used, the region is normalized and this config
295
+ # is set to `true`.
296
+ #
288
297
  # @option options [Boolean] :validate_params (true)
289
298
  # When `true`, request parameters are validated before
290
299
  # sending the request.
@@ -428,6 +437,31 @@ module Aws::FraudDetector
428
437
  req.send_request(options)
429
438
  end
430
439
 
440
+ # Cancels an in-progress batch import job.
441
+ #
442
+ # @option params [required, String] :job_id
443
+ # The ID of an in-progress batch import job to cancel.
444
+ #
445
+ # Amazon Fraud Detector will throw an error if the batch import job is
446
+ # in `FAILED`, `CANCELED`, or `COMPLETED` state.
447
+ #
448
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
449
+ #
450
+ # @example Request syntax with placeholder values
451
+ #
452
+ # resp = client.cancel_batch_import_job({
453
+ # job_id: "identifier", # required
454
+ # })
455
+ #
456
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CancelBatchImportJob AWS API Documentation
457
+ #
458
+ # @overload cancel_batch_import_job(params = {})
459
+ # @param [Hash] params ({})
460
+ def cancel_batch_import_job(params = {}, options = {})
461
+ req = build_request(:cancel_batch_import_job, params)
462
+ req.send_request(options)
463
+ end
464
+
431
465
  # Cancels the specified batch prediction job.
432
466
  #
433
467
  # @option params [required, String] :job_id
@@ -450,6 +484,57 @@ module Aws::FraudDetector
450
484
  req.send_request(options)
451
485
  end
452
486
 
487
+ # Creates a batch import job.
488
+ #
489
+ # @option params [required, String] :job_id
490
+ # The ID of the batch import job. The ID cannot be of a past job, unless
491
+ # the job exists in `CREATE_FAILED` state.
492
+ #
493
+ # @option params [required, String] :input_path
494
+ # The URI that points to the Amazon S3 location of your data file.
495
+ #
496
+ # @option params [required, String] :output_path
497
+ # The URI that points to the Amazon S3 location for storing your
498
+ # results.
499
+ #
500
+ # @option params [required, String] :event_type_name
501
+ # The name of the event type.
502
+ #
503
+ # @option params [required, String] :iam_role_arn
504
+ # The ARN of the IAM role created for Amazon S3 bucket that holds your
505
+ # data file. The IAM role must have read and write permissions to both
506
+ # input and output S3 buckets.
507
+ #
508
+ # @option params [Array<Types::Tag>] :tags
509
+ # A collection of key-value pairs associated with this request.
510
+ #
511
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
512
+ #
513
+ # @example Request syntax with placeholder values
514
+ #
515
+ # resp = client.create_batch_import_job({
516
+ # job_id: "identifier", # required
517
+ # input_path: "s3BucketLocation", # required
518
+ # output_path: "s3BucketLocation", # required
519
+ # event_type_name: "identifier", # required
520
+ # iam_role_arn: "iamRoleArn", # required
521
+ # tags: [
522
+ # {
523
+ # key: "tagKey", # required
524
+ # value: "tagValue", # required
525
+ # },
526
+ # ],
527
+ # })
528
+ #
529
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateBatchImportJob AWS API Documentation
530
+ #
531
+ # @overload create_batch_import_job(params = {})
532
+ # @param [Hash] params ({})
533
+ def create_batch_import_job(params = {}, options = {})
534
+ req = build_request(:create_batch_import_job, params)
535
+ req.send_request(options)
536
+ end
537
+
453
538
  # Creates a batch prediction job.
454
539
  #
455
540
  # @option params [required, String] :job_id
@@ -566,8 +651,8 @@ module Aws::FraudDetector
566
651
  # model_versions: [
567
652
  # {
568
653
  # model_id: "modelIdentifier", # required
569
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
570
- # model_version_number: "nonEmptyString", # required
654
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
655
+ # model_version_number: "floatVersionString", # required
571
656
  # arn: "fraudDetectorArn",
572
657
  # },
573
658
  # ],
@@ -618,7 +703,7 @@ module Aws::FraudDetector
618
703
  #
619
704
  # resp = client.create_model({
620
705
  # model_id: "modelIdentifier", # required
621
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
706
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
622
707
  # description: "description",
623
708
  # event_type_name: "string", # required
624
709
  # tags: [
@@ -654,9 +739,13 @@ module Aws::FraudDetector
654
739
  # The training data schema.
655
740
  #
656
741
  # @option params [Types::ExternalEventsDetail] :external_events_detail
657
- # Details for the external events data used for model version training.
742
+ # Details of the external events data used for model version training.
658
743
  # Required if `trainingDataSource` is `EXTERNAL_EVENTS`.
659
744
  #
745
+ # @option params [Types::IngestedEventsDetail] :ingested_events_detail
746
+ # Details of the ingested events data used for model version training.
747
+ # Required if `trainingDataSource` is `INGESTED_EVENTS`.
748
+ #
660
749
  # @option params [Array<Types::Tag>] :tags
661
750
  # A collection of key and value pairs.
662
751
  #
@@ -671,20 +760,27 @@ module Aws::FraudDetector
671
760
  #
672
761
  # resp = client.create_model_version({
673
762
  # model_id: "modelIdentifier", # required
674
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
675
- # training_data_source: "EXTERNAL_EVENTS", # required, accepts EXTERNAL_EVENTS
763
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
764
+ # training_data_source: "EXTERNAL_EVENTS", # required, accepts EXTERNAL_EVENTS, INGESTED_EVENTS
676
765
  # training_data_schema: { # required
677
766
  # model_variables: ["string"], # required
678
767
  # label_schema: { # required
679
768
  # label_mapper: { # required
680
769
  # "string" => ["string"],
681
770
  # },
771
+ # unlabeled_events_treatment: "IGNORE", # accepts IGNORE, FRAUD, LEGIT
682
772
  # },
683
773
  # },
684
774
  # external_events_detail: {
685
775
  # data_location: "s3BucketLocation", # required
686
776
  # data_access_role_arn: "iamRoleArn", # required
687
777
  # },
778
+ # ingested_events_detail: {
779
+ # ingested_events_time_window: { # required
780
+ # start_time: "time", # required
781
+ # end_time: "time", # required
782
+ # },
783
+ # },
688
784
  # tags: [
689
785
  # {
690
786
  # key: "tagKey", # required
@@ -696,7 +792,7 @@ module Aws::FraudDetector
696
792
  # @example Response structure
697
793
  #
698
794
  # resp.model_id #=> String
699
- # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
795
+ # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS", "TRANSACTION_FRAUD_INSIGHTS"
700
796
  # resp.model_version_number #=> String
701
797
  # resp.status #=> String
702
798
  #
@@ -832,6 +928,28 @@ module Aws::FraudDetector
832
928
  req.send_request(options)
833
929
  end
834
930
 
931
+ # Deletes data that was batch imported to Amazon Fraud Detector.
932
+ #
933
+ # @option params [required, String] :job_id
934
+ # The ID of the batch import job to delete.
935
+ #
936
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
937
+ #
938
+ # @example Request syntax with placeholder values
939
+ #
940
+ # resp = client.delete_batch_import_job({
941
+ # job_id: "identifier", # required
942
+ # })
943
+ #
944
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteBatchImportJob AWS API Documentation
945
+ #
946
+ # @overload delete_batch_import_job(params = {})
947
+ # @param [Hash] params ({})
948
+ def delete_batch_import_job(params = {}, options = {})
949
+ req = build_request(:delete_batch_import_job, params)
950
+ req.send_request(options)
951
+ end
952
+
835
953
  # Deletes a batch prediction job.
836
954
  #
837
955
  # @option params [required, String] :job_id
@@ -953,6 +1071,10 @@ module Aws::FraudDetector
953
1071
  # @option params [required, String] :event_type_name
954
1072
  # The name of the event type.
955
1073
  #
1074
+ # @option params [Boolean] :delete_audit_history
1075
+ # Specifies whether or not to delete any predictions associated with the
1076
+ # event.
1077
+ #
956
1078
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
957
1079
  #
958
1080
  # @example Request syntax with placeholder values
@@ -960,6 +1082,7 @@ module Aws::FraudDetector
960
1082
  # resp = client.delete_event({
961
1083
  # event_id: "identifier", # required
962
1084
  # event_type_name: "identifier", # required
1085
+ # delete_audit_history: false,
963
1086
  # })
964
1087
  #
965
1088
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteEvent AWS API Documentation
@@ -975,8 +1098,8 @@ module Aws::FraudDetector
975
1098
  #
976
1099
  # You cannot delete an event type that is used in a detector or a model.
977
1100
  #
978
- # When you delete an entity type, Amazon Fraud Detector permanently
979
- # deletes that entity type and the data is no longer stored in Amazon
1101
+ # When you delete an event type, Amazon Fraud Detector permanently
1102
+ # deletes that event type and the data is no longer stored in Amazon
980
1103
  # Fraud Detector.
981
1104
  #
982
1105
  # @option params [required, String] :name
@@ -999,6 +1122,36 @@ module Aws::FraudDetector
999
1122
  req.send_request(options)
1000
1123
  end
1001
1124
 
1125
+ # Deletes all events of a particular event type.
1126
+ #
1127
+ # @option params [required, String] :event_type_name
1128
+ # The name of the event type.
1129
+ #
1130
+ # @return [Types::DeleteEventsByEventTypeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1131
+ #
1132
+ # * {Types::DeleteEventsByEventTypeResult#event_type_name #event_type_name} => String
1133
+ # * {Types::DeleteEventsByEventTypeResult#events_deletion_status #events_deletion_status} => String
1134
+ #
1135
+ # @example Request syntax with placeholder values
1136
+ #
1137
+ # resp = client.delete_events_by_event_type({
1138
+ # event_type_name: "identifier", # required
1139
+ # })
1140
+ #
1141
+ # @example Response structure
1142
+ #
1143
+ # resp.event_type_name #=> String
1144
+ # resp.events_deletion_status #=> String
1145
+ #
1146
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteEventsByEventType AWS API Documentation
1147
+ #
1148
+ # @overload delete_events_by_event_type(params = {})
1149
+ # @param [Hash] params ({})
1150
+ def delete_events_by_event_type(params = {}, options = {})
1151
+ req = build_request(:delete_events_by_event_type, params)
1152
+ req.send_request(options)
1153
+ end
1154
+
1002
1155
  # Removes a SageMaker model from Amazon Fraud Detector.
1003
1156
  #
1004
1157
  # You can remove an Amazon SageMaker model if it is not associated with
@@ -1076,7 +1229,7 @@ module Aws::FraudDetector
1076
1229
  #
1077
1230
  # resp = client.delete_model({
1078
1231
  # model_id: "modelIdentifier", # required
1079
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1232
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
1080
1233
  # })
1081
1234
  #
1082
1235
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteModel AWS API Documentation
@@ -1112,7 +1265,7 @@ module Aws::FraudDetector
1112
1265
  #
1113
1266
  # resp = client.delete_model_version({
1114
1267
  # model_id: "modelIdentifier", # required
1115
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1268
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
1116
1269
  # model_version_number: "floatVersionString", # required
1117
1270
  # })
1118
1271
  #
@@ -1293,7 +1446,7 @@ module Aws::FraudDetector
1293
1446
  # resp = client.describe_model_versions({
1294
1447
  # model_id: "modelIdentifier",
1295
1448
  # model_version_number: "floatVersionString",
1296
- # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
1449
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
1297
1450
  # next_token: "string",
1298
1451
  # max_results: 1,
1299
1452
  # })
@@ -1302,17 +1455,20 @@ module Aws::FraudDetector
1302
1455
  #
1303
1456
  # resp.model_version_details #=> Array
1304
1457
  # resp.model_version_details[0].model_id #=> String
1305
- # resp.model_version_details[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1458
+ # resp.model_version_details[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS", "TRANSACTION_FRAUD_INSIGHTS"
1306
1459
  # resp.model_version_details[0].model_version_number #=> String
1307
1460
  # resp.model_version_details[0].status #=> String
1308
- # resp.model_version_details[0].training_data_source #=> String, one of "EXTERNAL_EVENTS"
1461
+ # resp.model_version_details[0].training_data_source #=> String, one of "EXTERNAL_EVENTS", "INGESTED_EVENTS"
1309
1462
  # resp.model_version_details[0].training_data_schema.model_variables #=> Array
1310
1463
  # resp.model_version_details[0].training_data_schema.model_variables[0] #=> String
1311
1464
  # resp.model_version_details[0].training_data_schema.label_schema.label_mapper #=> Hash
1312
1465
  # resp.model_version_details[0].training_data_schema.label_schema.label_mapper["string"] #=> Array
1313
1466
  # resp.model_version_details[0].training_data_schema.label_schema.label_mapper["string"][0] #=> String
1467
+ # resp.model_version_details[0].training_data_schema.label_schema.unlabeled_events_treatment #=> String, one of "IGNORE", "FRAUD", "LEGIT"
1314
1468
  # resp.model_version_details[0].external_events_detail.data_location #=> String
1315
1469
  # resp.model_version_details[0].external_events_detail.data_access_role_arn #=> String
1470
+ # resp.model_version_details[0].ingested_events_detail.ingested_events_time_window.start_time #=> String
1471
+ # resp.model_version_details[0].ingested_events_detail.ingested_events_time_window.end_time #=> String
1316
1472
  # resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages #=> Array
1317
1473
  # resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages[0].title #=> String
1318
1474
  # resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages[0].content #=> String
@@ -1347,6 +1503,65 @@ module Aws::FraudDetector
1347
1503
  req.send_request(options)
1348
1504
  end
1349
1505
 
1506
+ # Gets all batch import jobs or a specific job of the specified ID. This
1507
+ # is a paginated API. If you provide a null `maxResults`, this action
1508
+ # retrieves a maximum of 50 records per page. If you provide a
1509
+ # `maxResults`, the value must be between 1 and 50. To get the next page
1510
+ # results, provide the pagination token from the
1511
+ # `GetBatchImportJobsResponse` as part of your request. A null
1512
+ # pagination token fetches the records from the beginning.
1513
+ #
1514
+ # @option params [String] :job_id
1515
+ # The ID of the batch import job to get.
1516
+ #
1517
+ # @option params [Integer] :max_results
1518
+ # The maximum number of objects to return for request.
1519
+ #
1520
+ # @option params [String] :next_token
1521
+ # The next token from the previous request.
1522
+ #
1523
+ # @return [Types::GetBatchImportJobsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1524
+ #
1525
+ # * {Types::GetBatchImportJobsResult#batch_imports #batch_imports} => Array&lt;Types::BatchImport&gt;
1526
+ # * {Types::GetBatchImportJobsResult#next_token #next_token} => String
1527
+ #
1528
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1529
+ #
1530
+ # @example Request syntax with placeholder values
1531
+ #
1532
+ # resp = client.get_batch_import_jobs({
1533
+ # job_id: "identifier",
1534
+ # max_results: 1,
1535
+ # next_token: "string",
1536
+ # })
1537
+ #
1538
+ # @example Response structure
1539
+ #
1540
+ # resp.batch_imports #=> Array
1541
+ # resp.batch_imports[0].job_id #=> String
1542
+ # resp.batch_imports[0].status #=> String, one of "IN_PROGRESS_INITIALIZING", "IN_PROGRESS", "CANCEL_IN_PROGRESS", "CANCELED", "COMPLETE", "FAILED"
1543
+ # resp.batch_imports[0].failure_reason #=> String
1544
+ # resp.batch_imports[0].start_time #=> String
1545
+ # resp.batch_imports[0].completion_time #=> String
1546
+ # resp.batch_imports[0].input_path #=> String
1547
+ # resp.batch_imports[0].output_path #=> String
1548
+ # resp.batch_imports[0].event_type_name #=> String
1549
+ # resp.batch_imports[0].iam_role_arn #=> String
1550
+ # resp.batch_imports[0].arn #=> String
1551
+ # resp.batch_imports[0].processed_records_count #=> Integer
1552
+ # resp.batch_imports[0].failed_records_count #=> Integer
1553
+ # resp.batch_imports[0].total_records_count #=> Integer
1554
+ # resp.next_token #=> String
1555
+ #
1556
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetBatchImportJobs AWS API Documentation
1557
+ #
1558
+ # @overload get_batch_import_jobs(params = {})
1559
+ # @param [Hash] params ({})
1560
+ def get_batch_import_jobs(params = {}, options = {})
1561
+ req = build_request(:get_batch_import_jobs, params)
1562
+ req.send_request(options)
1563
+ end
1564
+
1350
1565
  # Gets all batch prediction jobs or a specific job if you specify a job
1351
1566
  # ID. This is a paginated API. If you provide a null maxResults, this
1352
1567
  # action retrieves a maximum of 50 records per page. If you provide a
@@ -1408,6 +1623,36 @@ module Aws::FraudDetector
1408
1623
  req.send_request(options)
1409
1624
  end
1410
1625
 
1626
+ # Retrieves the status of a `DeleteEventsByEventType` action.
1627
+ #
1628
+ # @option params [required, String] :event_type_name
1629
+ # Name of event type for which to get the deletion status.
1630
+ #
1631
+ # @return [Types::GetDeleteEventsByEventTypeStatusResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1632
+ #
1633
+ # * {Types::GetDeleteEventsByEventTypeStatusResult#event_type_name #event_type_name} => String
1634
+ # * {Types::GetDeleteEventsByEventTypeStatusResult#events_deletion_status #events_deletion_status} => String
1635
+ #
1636
+ # @example Request syntax with placeholder values
1637
+ #
1638
+ # resp = client.get_delete_events_by_event_type_status({
1639
+ # event_type_name: "identifier", # required
1640
+ # })
1641
+ #
1642
+ # @example Response structure
1643
+ #
1644
+ # resp.event_type_name #=> String
1645
+ # resp.events_deletion_status #=> String, one of "IN_PROGRESS_INITIALIZING", "IN_PROGRESS", "CANCEL_IN_PROGRESS", "CANCELED", "COMPLETE", "FAILED"
1646
+ #
1647
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetDeleteEventsByEventTypeStatus AWS API Documentation
1648
+ #
1649
+ # @overload get_delete_events_by_event_type_status(params = {})
1650
+ # @param [Hash] params ({})
1651
+ def get_delete_events_by_event_type_status(params = {}, options = {})
1652
+ req = build_request(:get_delete_events_by_event_type_status, params)
1653
+ req.send_request(options)
1654
+ end
1655
+
1411
1656
  # Gets a particular detector version.
1412
1657
  #
1413
1658
  # @option params [required, String] :detector_id
@@ -1446,7 +1691,7 @@ module Aws::FraudDetector
1446
1691
  # resp.external_model_endpoints[0] #=> String
1447
1692
  # resp.model_versions #=> Array
1448
1693
  # resp.model_versions[0].model_id #=> String
1449
- # resp.model_versions[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1694
+ # resp.model_versions[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS", "TRANSACTION_FRAUD_INSIGHTS"
1450
1695
  # resp.model_versions[0].model_version_number #=> String
1451
1696
  # resp.model_versions[0].arn #=> String
1452
1697
  # resp.rules #=> Array
@@ -1571,6 +1816,48 @@ module Aws::FraudDetector
1571
1816
  req.send_request(options)
1572
1817
  end
1573
1818
 
1819
+ # Retrieves details of events stored with Amazon Fraud Detector. This
1820
+ # action does not retrieve prediction results.
1821
+ #
1822
+ # @option params [required, String] :event_id
1823
+ # The ID of the event to retrieve.
1824
+ #
1825
+ # @option params [required, String] :event_type_name
1826
+ # The event type of the event to retrieve.
1827
+ #
1828
+ # @return [Types::GetEventResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1829
+ #
1830
+ # * {Types::GetEventResult#event #event} => Types::Event
1831
+ #
1832
+ # @example Request syntax with placeholder values
1833
+ #
1834
+ # resp = client.get_event({
1835
+ # event_id: "string", # required
1836
+ # event_type_name: "string", # required
1837
+ # })
1838
+ #
1839
+ # @example Response structure
1840
+ #
1841
+ # resp.event.event_id #=> String
1842
+ # resp.event.event_type_name #=> String
1843
+ # resp.event.event_timestamp #=> String
1844
+ # resp.event.event_variables #=> Hash
1845
+ # resp.event.event_variables["attributeKey"] #=> String
1846
+ # resp.event.current_label #=> String
1847
+ # resp.event.label_timestamp #=> String
1848
+ # resp.event.entities #=> Array
1849
+ # resp.event.entities[0].entity_type #=> String
1850
+ # resp.event.entities[0].entity_id #=> String
1851
+ #
1852
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEvent AWS API Documentation
1853
+ #
1854
+ # @overload get_event(params = {})
1855
+ # @param [Hash] params ({})
1856
+ def get_event(params = {}, options = {})
1857
+ req = build_request(:get_event, params)
1858
+ req.send_request(options)
1859
+ end
1860
+
1574
1861
  # Evaluates an event against a detector version. If a version ID is not
1575
1862
  # provided, the detector’s (`ACTIVE`) version is used.
1576
1863
  #
@@ -1593,19 +1880,17 @@ module Aws::FraudDetector
1593
1880
  # id is not available, use "UNKNOWN."
1594
1881
  #
1595
1882
  # @option params [required, String] :event_timestamp
1596
- # Timestamp that defines when the event under evaluation occurred.
1883
+ # Timestamp that defines when the event under evaluation occurred. The
1884
+ # timestamp must be specified using ISO 8601 standard in UTC.
1597
1885
  #
1598
1886
  # @option params [required, Hash<String,String>] :event_variables
1599
1887
  # Names of the event type's variables you defined in Amazon Fraud
1600
1888
  # Detector to represent data elements and their corresponding values for
1601
1889
  # the event you are sending for evaluation.
1602
1890
  #
1603
- # * You must provide at least one eventVariable
1604
- #
1605
- # * If detectorVersion is associated with a modelVersion, you must
1606
- # provide at least one associated eventVariable
1891
+ # You must provide at least one eventVariable
1607
1892
  #
1608
- # To ensure highest possible fraud prediction and to simplify your data
1893
+ # To ensure most accurate fraud prediction and to simplify your data
1609
1894
  # preparation, Amazon Fraud Detector will replace all missing variables
1610
1895
  # or values as follows:
1611
1896
  #
@@ -1617,7 +1902,7 @@ module Aws::FraudDetector
1617
1902
  # mean/medians for numeric variables and with special values for
1618
1903
  # categorical variables.
1619
1904
  #
1620
- # **For External models ( for example, imported SageMaker):**
1905
+ # **For imported SageMaker models:**
1621
1906
  #
1622
1907
  # If a null value is provided explicitly for a variable, the model and
1623
1908
  # rules will use “null” as the value. If a variable is not provided (no
@@ -1631,6 +1916,7 @@ module Aws::FraudDetector
1631
1916
  #
1632
1917
  # * {Types::GetEventPredictionResult#model_scores #model_scores} => Array&lt;Types::ModelScores&gt;
1633
1918
  # * {Types::GetEventPredictionResult#rule_results #rule_results} => Array&lt;Types::RuleResult&gt;
1919
+ # * {Types::GetEventPredictionResult#external_model_outputs #external_model_outputs} => Array&lt;Types::ExternalModelOutputs&gt;
1634
1920
  #
1635
1921
  # @example Request syntax with placeholder values
1636
1922
  #
@@ -1642,7 +1928,7 @@ module Aws::FraudDetector
1642
1928
  # entities: [ # required
1643
1929
  # {
1644
1930
  # entity_type: "string", # required
1645
- # entity_id: "identifier", # required
1931
+ # entity_id: "entityRestrictedString", # required
1646
1932
  # },
1647
1933
  # ],
1648
1934
  # event_timestamp: "utcTimestampISO8601", # required
@@ -1650,7 +1936,7 @@ module Aws::FraudDetector
1650
1936
  # "variableName" => "variableValue",
1651
1937
  # },
1652
1938
  # external_model_endpoint_data_blobs: {
1653
- # "string" => {
1939
+ # "sageMakerEndpointIdentifier" => {
1654
1940
  # byte_buffer: "data",
1655
1941
  # content_type: "contentType",
1656
1942
  # },
@@ -1661,7 +1947,7 @@ module Aws::FraudDetector
1661
1947
  #
1662
1948
  # resp.model_scores #=> Array
1663
1949
  # resp.model_scores[0].model_version.model_id #=> String
1664
- # resp.model_scores[0].model_version.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1950
+ # resp.model_scores[0].model_version.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS", "TRANSACTION_FRAUD_INSIGHTS"
1665
1951
  # resp.model_scores[0].model_version.model_version_number #=> String
1666
1952
  # resp.model_scores[0].model_version.arn #=> String
1667
1953
  # resp.model_scores[0].scores #=> Hash
@@ -1670,6 +1956,11 @@ module Aws::FraudDetector
1670
1956
  # resp.rule_results[0].rule_id #=> String
1671
1957
  # resp.rule_results[0].outcomes #=> Array
1672
1958
  # resp.rule_results[0].outcomes[0] #=> String
1959
+ # resp.external_model_outputs #=> Array
1960
+ # resp.external_model_outputs[0].external_model.model_endpoint #=> String
1961
+ # resp.external_model_outputs[0].external_model.model_source #=> String, one of "SAGEMAKER"
1962
+ # resp.external_model_outputs[0].outputs #=> Hash
1963
+ # resp.external_model_outputs[0].outputs["string"] #=> String
1673
1964
  #
1674
1965
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventPrediction AWS API Documentation
1675
1966
  #
@@ -1723,6 +2014,12 @@ module Aws::FraudDetector
1723
2014
  # resp.event_types[0].labels[0] #=> String
1724
2015
  # resp.event_types[0].entity_types #=> Array
1725
2016
  # resp.event_types[0].entity_types[0] #=> String
2017
+ # resp.event_types[0].event_ingestion #=> String, one of "ENABLED", "DISABLED"
2018
+ # resp.event_types[0].ingested_event_statistics.number_of_events #=> Integer
2019
+ # resp.event_types[0].ingested_event_statistics.event_data_size_in_bytes #=> Integer
2020
+ # resp.event_types[0].ingested_event_statistics.least_recent_event #=> String
2021
+ # resp.event_types[0].ingested_event_statistics.most_recent_event #=> String
2022
+ # resp.event_types[0].ingested_event_statistics.last_updated_time #=> String
1726
2023
  # resp.event_types[0].last_updated_time #=> String
1727
2024
  # resp.event_types[0].created_time #=> String
1728
2025
  # resp.event_types[0].arn #=> String
@@ -1800,9 +2097,8 @@ module Aws::FraudDetector
1800
2097
  req.send_request(options)
1801
2098
  end
1802
2099
 
1803
- # Gets the encryption key if a Key Management Service (KMS) customer
1804
- # master key (CMK) has been specified to be used to encrypt content in
1805
- # Amazon Fraud Detector.
2100
+ # Gets the encryption key if a KMS key has been specified to be used to
2101
+ # encrypt content in Amazon Fraud Detector.
1806
2102
  #
1807
2103
  # @return [Types::GetKMSEncryptionKeyResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1808
2104
  #
@@ -1891,6 +2187,7 @@ module Aws::FraudDetector
1891
2187
  # * {Types::GetModelVersionResult#training_data_source #training_data_source} => String
1892
2188
  # * {Types::GetModelVersionResult#training_data_schema #training_data_schema} => Types::TrainingDataSchema
1893
2189
  # * {Types::GetModelVersionResult#external_events_detail #external_events_detail} => Types::ExternalEventsDetail
2190
+ # * {Types::GetModelVersionResult#ingested_events_detail #ingested_events_detail} => Types::IngestedEventsDetail
1894
2191
  # * {Types::GetModelVersionResult#status #status} => String
1895
2192
  # * {Types::GetModelVersionResult#arn #arn} => String
1896
2193
  #
@@ -1898,23 +2195,26 @@ module Aws::FraudDetector
1898
2195
  #
1899
2196
  # resp = client.get_model_version({
1900
2197
  # model_id: "modelIdentifier", # required
1901
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
2198
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
1902
2199
  # model_version_number: "floatVersionString", # required
1903
2200
  # })
1904
2201
  #
1905
2202
  # @example Response structure
1906
2203
  #
1907
2204
  # resp.model_id #=> String
1908
- # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
2205
+ # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS", "TRANSACTION_FRAUD_INSIGHTS"
1909
2206
  # resp.model_version_number #=> String
1910
- # resp.training_data_source #=> String, one of "EXTERNAL_EVENTS"
2207
+ # resp.training_data_source #=> String, one of "EXTERNAL_EVENTS", "INGESTED_EVENTS"
1911
2208
  # resp.training_data_schema.model_variables #=> Array
1912
2209
  # resp.training_data_schema.model_variables[0] #=> String
1913
2210
  # resp.training_data_schema.label_schema.label_mapper #=> Hash
1914
2211
  # resp.training_data_schema.label_schema.label_mapper["string"] #=> Array
1915
2212
  # resp.training_data_schema.label_schema.label_mapper["string"][0] #=> String
2213
+ # resp.training_data_schema.label_schema.unlabeled_events_treatment #=> String, one of "IGNORE", "FRAUD", "LEGIT"
1916
2214
  # resp.external_events_detail.data_location #=> String
1917
2215
  # resp.external_events_detail.data_access_role_arn #=> String
2216
+ # resp.ingested_events_detail.ingested_events_time_window.start_time #=> String
2217
+ # resp.ingested_events_detail.ingested_events_time_window.end_time #=> String
1918
2218
  # resp.status #=> String
1919
2219
  # resp.arn #=> String
1920
2220
  #
@@ -1963,7 +2263,7 @@ module Aws::FraudDetector
1963
2263
  #
1964
2264
  # resp = client.get_models({
1965
2265
  # model_id: "modelIdentifier",
1966
- # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
2266
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
1967
2267
  # next_token: "string",
1968
2268
  # max_results: 1,
1969
2269
  # })
@@ -1973,7 +2273,7 @@ module Aws::FraudDetector
1973
2273
  # resp.next_token #=> String
1974
2274
  # resp.models #=> Array
1975
2275
  # resp.models[0].model_id #=> String
1976
- # resp.models[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
2276
+ # resp.models[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS", "TRANSACTION_FRAUD_INSIGHTS"
1977
2277
  # resp.models[0].description #=> String
1978
2278
  # resp.models[0].event_type_name #=> String
1979
2279
  # resp.models[0].created_time #=> String
@@ -2309,6 +2609,9 @@ module Aws::FraudDetector
2309
2609
  # The entity type for the event type. Example entity types: customer,
2310
2610
  # merchant, account.
2311
2611
  #
2612
+ # @option params [String] :event_ingestion
2613
+ # Specifies if ingenstion is enabled or disabled.
2614
+ #
2312
2615
  # @option params [Array<Types::Tag>] :tags
2313
2616
  # A collection of key and value pairs.
2314
2617
  #
@@ -2322,6 +2625,7 @@ module Aws::FraudDetector
2322
2625
  # event_variables: ["string"], # required
2323
2626
  # labels: ["string"],
2324
2627
  # entity_types: ["string"], # required
2628
+ # event_ingestion: "ENABLED", # accepts ENABLED, DISABLED
2325
2629
  # tags: [
2326
2630
  # {
2327
2631
  # key: "tagKey", # required
@@ -2376,8 +2680,8 @@ module Aws::FraudDetector
2376
2680
  # event_type_name: "identifier",
2377
2681
  # format: "TEXT_CSV", # accepts TEXT_CSV, APPLICATION_JSON
2378
2682
  # use_event_variables: false, # required
2379
- # json_input_template: "string",
2380
- # csv_input_template: "string",
2683
+ # json_input_template: "modelInputTemplate",
2684
+ # csv_input_template: "modelInputTemplate",
2381
2685
  # },
2382
2686
  # output_configuration: { # required
2383
2687
  # format: "TEXT_CSV", # required, accepts TEXT_CSV, APPLICATION_JSONLINES
@@ -2406,8 +2710,8 @@ module Aws::FraudDetector
2406
2710
  req.send_request(options)
2407
2711
  end
2408
2712
 
2409
- # Specifies the Key Management Service (KMS) customer master key (CMK)
2410
- # to be used to encrypt content in Amazon Fraud Detector.
2713
+ # Specifies the KMS key to be used to encrypt content in Amazon Fraud
2714
+ # Detector.
2411
2715
  #
2412
2716
  # @option params [required, String] :kms_encryption_key_arn
2413
2717
  # The KMS encryption key ARN.
@@ -2500,6 +2804,67 @@ module Aws::FraudDetector
2500
2804
  req.send_request(options)
2501
2805
  end
2502
2806
 
2807
+ # Stores events in Amazon Fraud Detector without generating fraud
2808
+ # predictions for those events. For example, you can use `SendEvent` to
2809
+ # upload a historical dataset, which you can then later use to train a
2810
+ # model.
2811
+ #
2812
+ # @option params [required, String] :event_id
2813
+ # The event ID to upload.
2814
+ #
2815
+ # @option params [required, String] :event_type_name
2816
+ # The event type name of the event.
2817
+ #
2818
+ # @option params [required, String] :event_timestamp
2819
+ # The timestamp that defines when the event under evaluation occurred.
2820
+ # The timestamp must be specified using ISO 8601 standard in UTC.
2821
+ #
2822
+ # @option params [required, Hash<String,String>] :event_variables
2823
+ # Names of the event type's variables you defined in Amazon Fraud
2824
+ # Detector to represent data elements and their corresponding values for
2825
+ # the event you are sending for evaluation.
2826
+ #
2827
+ # @option params [String] :assigned_label
2828
+ # The label to associate with the event. Required if specifying
2829
+ # `labelTimestamp`.
2830
+ #
2831
+ # @option params [String] :label_timestamp
2832
+ # The timestamp associated with the label. Required if specifying
2833
+ # `assignedLabel`.
2834
+ #
2835
+ # @option params [required, Array<Types::Entity>] :entities
2836
+ # An array of entities.
2837
+ #
2838
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2839
+ #
2840
+ # @example Request syntax with placeholder values
2841
+ #
2842
+ # resp = client.send_event({
2843
+ # event_id: "identifier", # required
2844
+ # event_type_name: "identifier", # required
2845
+ # event_timestamp: "utcTimestampISO8601", # required
2846
+ # event_variables: { # required
2847
+ # "variableName" => "variableValue",
2848
+ # },
2849
+ # assigned_label: "identifier",
2850
+ # label_timestamp: "utcTimestampISO8601",
2851
+ # entities: [ # required
2852
+ # {
2853
+ # entity_type: "string", # required
2854
+ # entity_id: "entityRestrictedString", # required
2855
+ # },
2856
+ # ],
2857
+ # })
2858
+ #
2859
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/SendEvent AWS API Documentation
2860
+ #
2861
+ # @overload send_event(params = {})
2862
+ # @param [Hash] params ({})
2863
+ def send_event(params = {}, options = {})
2864
+ req = build_request(:send_event, params)
2865
+ req.send_request(options)
2866
+ end
2867
+
2503
2868
  # Assigns tags to a resource.
2504
2869
  #
2505
2870
  # @option params [required, String] :resource_arn
@@ -2615,8 +2980,8 @@ module Aws::FraudDetector
2615
2980
  # model_versions: [
2616
2981
  # {
2617
2982
  # model_id: "modelIdentifier", # required
2618
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
2619
- # model_version_number: "nonEmptyString", # required
2983
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
2984
+ # model_version_number: "floatVersionString", # required
2620
2985
  # arn: "fraudDetectorArn",
2621
2986
  # },
2622
2987
  # ],
@@ -2695,8 +3060,42 @@ module Aws::FraudDetector
2695
3060
  req.send_request(options)
2696
3061
  end
2697
3062
 
2698
- # Updates a model. You can update the description attribute using this
2699
- # action.
3063
+ # Updates the specified event with a new label.
3064
+ #
3065
+ # @option params [required, String] :event_id
3066
+ # The ID of the event associated with the label to update.
3067
+ #
3068
+ # @option params [required, String] :event_type_name
3069
+ # The event type of the event associated with the label to update.
3070
+ #
3071
+ # @option params [required, String] :assigned_label
3072
+ # The new label to assign to the event.
3073
+ #
3074
+ # @option params [required, String] :label_timestamp
3075
+ # The timestamp associated with the label. The timestamp must be
3076
+ # specified using ISO 8601 standard in UTC.
3077
+ #
3078
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3079
+ #
3080
+ # @example Request syntax with placeholder values
3081
+ #
3082
+ # resp = client.update_event_label({
3083
+ # event_id: "identifier", # required
3084
+ # event_type_name: "identifier", # required
3085
+ # assigned_label: "identifier", # required
3086
+ # label_timestamp: "utcTimestampISO8601", # required
3087
+ # })
3088
+ #
3089
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateEventLabel AWS API Documentation
3090
+ #
3091
+ # @overload update_event_label(params = {})
3092
+ # @param [Hash] params ({})
3093
+ def update_event_label(params = {}, options = {})
3094
+ req = build_request(:update_event_label, params)
3095
+ req.send_request(options)
3096
+ end
3097
+
3098
+ # Updates model description.
2700
3099
  #
2701
3100
  # @option params [required, String] :model_id
2702
3101
  # The model ID.
@@ -2713,7 +3112,7 @@ module Aws::FraudDetector
2713
3112
  #
2714
3113
  # resp = client.update_model({
2715
3114
  # model_id: "modelIdentifier", # required
2716
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
3115
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
2717
3116
  # description: "description",
2718
3117
  # })
2719
3118
  #
@@ -2743,7 +3142,12 @@ module Aws::FraudDetector
2743
3142
  # The major version number.
2744
3143
  #
2745
3144
  # @option params [Types::ExternalEventsDetail] :external_events_detail
2746
- # The event details.
3145
+ # The details of the external events data used for training the model
3146
+ # version. Required if `trainingDataSource` is `EXTERNAL_EVENTS`.
3147
+ #
3148
+ # @option params [Types::IngestedEventsDetail] :ingested_events_detail
3149
+ # The details of the ingested event used for training the model version.
3150
+ # Required if your `trainingDataSource` is `INGESTED_EVENTS`.
2747
3151
  #
2748
3152
  # @option params [Array<Types::Tag>] :tags
2749
3153
  # A collection of key and value pairs.
@@ -2759,12 +3163,18 @@ module Aws::FraudDetector
2759
3163
  #
2760
3164
  # resp = client.update_model_version({
2761
3165
  # model_id: "modelIdentifier", # required
2762
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
3166
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
2763
3167
  # major_version_number: "wholeNumberVersionString", # required
2764
3168
  # external_events_detail: {
2765
3169
  # data_location: "s3BucketLocation", # required
2766
3170
  # data_access_role_arn: "iamRoleArn", # required
2767
3171
  # },
3172
+ # ingested_events_detail: {
3173
+ # ingested_events_time_window: { # required
3174
+ # start_time: "time", # required
3175
+ # end_time: "time", # required
3176
+ # },
3177
+ # },
2768
3178
  # tags: [
2769
3179
  # {
2770
3180
  # key: "tagKey", # required
@@ -2776,7 +3186,7 @@ module Aws::FraudDetector
2776
3186
  # @example Response structure
2777
3187
  #
2778
3188
  # resp.model_id #=> String
2779
- # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
3189
+ # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS", "TRANSACTION_FRAUD_INSIGHTS"
2780
3190
  # resp.model_version_number #=> String
2781
3191
  # resp.status #=> String
2782
3192
  #
@@ -2795,7 +3205,7 @@ module Aws::FraudDetector
2795
3205
  #
2796
3206
  # 1. Change the `TRAINING_COMPLETE` status to `ACTIVE`.
2797
3207
  #
2798
- # 2. Change `ACTIVE`to `INACTIVE`.
3208
+ # 2. Change `ACTIVE` to `INACTIVE`.
2799
3209
  #
2800
3210
  # @option params [required, String] :model_id
2801
3211
  # The model ID of the model version to update.
@@ -2815,7 +3225,7 @@ module Aws::FraudDetector
2815
3225
  #
2816
3226
  # resp = client.update_model_version_status({
2817
3227
  # model_id: "modelIdentifier", # required
2818
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
3228
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
2819
3229
  # model_version_number: "floatVersionString", # required
2820
3230
  # status: "ACTIVE", # required, accepts ACTIVE, INACTIVE, TRAINING_CANCELLED
2821
3231
  # })
@@ -2970,7 +3380,7 @@ module Aws::FraudDetector
2970
3380
  params: params,
2971
3381
  config: config)
2972
3382
  context[:gem_name] = 'aws-sdk-frauddetector'
2973
- context[:gem_version] = '1.23.0'
3383
+ context[:gem_version] = '1.27.0'
2974
3384
  Seahorse::Client::Request.new(handlers, context)
2975
3385
  end
2976
3386