aws-sdk-frauddetector 1.24.0 → 1.25.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -428,6 +428,31 @@ module Aws::FraudDetector
428
428
  req.send_request(options)
429
429
  end
430
430
 
431
+ # Cancels an in-progress batch import job.
432
+ #
433
+ # @option params [required, String] :job_id
434
+ # The ID of an in-progress batch import job to cancel.
435
+ #
436
+ # Amazon Fraud Detector will throw an error if the batch import job is
437
+ # in `FAILED`, `CANCELED`, or `COMPLETED` state.
438
+ #
439
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
440
+ #
441
+ # @example Request syntax with placeholder values
442
+ #
443
+ # resp = client.cancel_batch_import_job({
444
+ # job_id: "identifier", # required
445
+ # })
446
+ #
447
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CancelBatchImportJob AWS API Documentation
448
+ #
449
+ # @overload cancel_batch_import_job(params = {})
450
+ # @param [Hash] params ({})
451
+ def cancel_batch_import_job(params = {}, options = {})
452
+ req = build_request(:cancel_batch_import_job, params)
453
+ req.send_request(options)
454
+ end
455
+
431
456
  # Cancels the specified batch prediction job.
432
457
  #
433
458
  # @option params [required, String] :job_id
@@ -450,6 +475,57 @@ module Aws::FraudDetector
450
475
  req.send_request(options)
451
476
  end
452
477
 
478
+ # Creates a batch import job.
479
+ #
480
+ # @option params [required, String] :job_id
481
+ # The ID of the batch import job. The ID cannot be of a past job, unless
482
+ # the job exists in `CREATE_FAILED` state.
483
+ #
484
+ # @option params [required, String] :input_path
485
+ # The URI that points to the Amazon S3 location of your data file.
486
+ #
487
+ # @option params [required, String] :output_path
488
+ # The URI that points to the Amazon S3 location for storing your
489
+ # results.
490
+ #
491
+ # @option params [required, String] :event_type_name
492
+ # The name of the event type.
493
+ #
494
+ # @option params [required, String] :iam_role_arn
495
+ # The ARN of the IAM role created for Amazon S3 bucket that holds your
496
+ # data file. The IAM role must have read and write permissions to both
497
+ # input and output S3 buckets.
498
+ #
499
+ # @option params [Array<Types::Tag>] :tags
500
+ # A collection of key-value pairs associated with this request.
501
+ #
502
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
503
+ #
504
+ # @example Request syntax with placeholder values
505
+ #
506
+ # resp = client.create_batch_import_job({
507
+ # job_id: "identifier", # required
508
+ # input_path: "s3BucketLocation", # required
509
+ # output_path: "s3BucketLocation", # required
510
+ # event_type_name: "identifier", # required
511
+ # iam_role_arn: "iamRoleArn", # required
512
+ # tags: [
513
+ # {
514
+ # key: "tagKey", # required
515
+ # value: "tagValue", # required
516
+ # },
517
+ # ],
518
+ # })
519
+ #
520
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateBatchImportJob AWS API Documentation
521
+ #
522
+ # @overload create_batch_import_job(params = {})
523
+ # @param [Hash] params ({})
524
+ def create_batch_import_job(params = {}, options = {})
525
+ req = build_request(:create_batch_import_job, params)
526
+ req.send_request(options)
527
+ end
528
+
453
529
  # Creates a batch prediction job.
454
530
  #
455
531
  # @option params [required, String] :job_id
@@ -566,8 +642,8 @@ module Aws::FraudDetector
566
642
  # model_versions: [
567
643
  # {
568
644
  # model_id: "modelIdentifier", # required
569
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
570
- # model_version_number: "nonEmptyString", # required
645
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
646
+ # model_version_number: "floatVersionString", # required
571
647
  # arn: "fraudDetectorArn",
572
648
  # },
573
649
  # ],
@@ -618,7 +694,7 @@ module Aws::FraudDetector
618
694
  #
619
695
  # resp = client.create_model({
620
696
  # model_id: "modelIdentifier", # required
621
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
697
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
622
698
  # description: "description",
623
699
  # event_type_name: "string", # required
624
700
  # tags: [
@@ -654,9 +730,13 @@ module Aws::FraudDetector
654
730
  # The training data schema.
655
731
  #
656
732
  # @option params [Types::ExternalEventsDetail] :external_events_detail
657
- # Details for the external events data used for model version training.
733
+ # Details of the external events data used for model version training.
658
734
  # Required if `trainingDataSource` is `EXTERNAL_EVENTS`.
659
735
  #
736
+ # @option params [Types::IngestedEventsDetail] :ingested_events_detail
737
+ # Details of the ingested events data used for model version training.
738
+ # Required if `trainingDataSource` is `INGESTED_EVENTS`.
739
+ #
660
740
  # @option params [Array<Types::Tag>] :tags
661
741
  # A collection of key and value pairs.
662
742
  #
@@ -671,20 +751,27 @@ module Aws::FraudDetector
671
751
  #
672
752
  # resp = client.create_model_version({
673
753
  # 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
754
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
755
+ # training_data_source: "EXTERNAL_EVENTS", # required, accepts EXTERNAL_EVENTS, INGESTED_EVENTS
676
756
  # training_data_schema: { # required
677
757
  # model_variables: ["string"], # required
678
758
  # label_schema: { # required
679
759
  # label_mapper: { # required
680
760
  # "string" => ["string"],
681
761
  # },
762
+ # unlabeled_events_treatment: "IGNORE", # accepts IGNORE, FRAUD, LEGIT
682
763
  # },
683
764
  # },
684
765
  # external_events_detail: {
685
766
  # data_location: "s3BucketLocation", # required
686
767
  # data_access_role_arn: "iamRoleArn", # required
687
768
  # },
769
+ # ingested_events_detail: {
770
+ # ingested_events_time_window: { # required
771
+ # start_time: "time", # required
772
+ # end_time: "time", # required
773
+ # },
774
+ # },
688
775
  # tags: [
689
776
  # {
690
777
  # key: "tagKey", # required
@@ -696,7 +783,7 @@ module Aws::FraudDetector
696
783
  # @example Response structure
697
784
  #
698
785
  # resp.model_id #=> String
699
- # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
786
+ # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS", "TRANSACTION_FRAUD_INSIGHTS"
700
787
  # resp.model_version_number #=> String
701
788
  # resp.status #=> String
702
789
  #
@@ -832,6 +919,28 @@ module Aws::FraudDetector
832
919
  req.send_request(options)
833
920
  end
834
921
 
922
+ # Deletes data that was batch imported to Amazon Fraud Detector.
923
+ #
924
+ # @option params [required, String] :job_id
925
+ # The ID of the batch import job to delete.
926
+ #
927
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
928
+ #
929
+ # @example Request syntax with placeholder values
930
+ #
931
+ # resp = client.delete_batch_import_job({
932
+ # job_id: "identifier", # required
933
+ # })
934
+ #
935
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteBatchImportJob AWS API Documentation
936
+ #
937
+ # @overload delete_batch_import_job(params = {})
938
+ # @param [Hash] params ({})
939
+ def delete_batch_import_job(params = {}, options = {})
940
+ req = build_request(:delete_batch_import_job, params)
941
+ req.send_request(options)
942
+ end
943
+
835
944
  # Deletes a batch prediction job.
836
945
  #
837
946
  # @option params [required, String] :job_id
@@ -953,6 +1062,10 @@ module Aws::FraudDetector
953
1062
  # @option params [required, String] :event_type_name
954
1063
  # The name of the event type.
955
1064
  #
1065
+ # @option params [Boolean] :delete_audit_history
1066
+ # Specifies whether or not to delete any predictions associated with the
1067
+ # event.
1068
+ #
956
1069
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
957
1070
  #
958
1071
  # @example Request syntax with placeholder values
@@ -960,6 +1073,7 @@ module Aws::FraudDetector
960
1073
  # resp = client.delete_event({
961
1074
  # event_id: "identifier", # required
962
1075
  # event_type_name: "identifier", # required
1076
+ # delete_audit_history: false,
963
1077
  # })
964
1078
  #
965
1079
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteEvent AWS API Documentation
@@ -975,8 +1089,8 @@ module Aws::FraudDetector
975
1089
  #
976
1090
  # You cannot delete an event type that is used in a detector or a model.
977
1091
  #
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
1092
+ # When you delete an event type, Amazon Fraud Detector permanently
1093
+ # deletes that event type and the data is no longer stored in Amazon
980
1094
  # Fraud Detector.
981
1095
  #
982
1096
  # @option params [required, String] :name
@@ -999,6 +1113,36 @@ module Aws::FraudDetector
999
1113
  req.send_request(options)
1000
1114
  end
1001
1115
 
1116
+ # Deletes all events of a particular event type.
1117
+ #
1118
+ # @option params [required, String] :event_type_name
1119
+ # The name of the event type.
1120
+ #
1121
+ # @return [Types::DeleteEventsByEventTypeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1122
+ #
1123
+ # * {Types::DeleteEventsByEventTypeResult#event_type_name #event_type_name} => String
1124
+ # * {Types::DeleteEventsByEventTypeResult#events_deletion_status #events_deletion_status} => String
1125
+ #
1126
+ # @example Request syntax with placeholder values
1127
+ #
1128
+ # resp = client.delete_events_by_event_type({
1129
+ # event_type_name: "identifier", # required
1130
+ # })
1131
+ #
1132
+ # @example Response structure
1133
+ #
1134
+ # resp.event_type_name #=> String
1135
+ # resp.events_deletion_status #=> String
1136
+ #
1137
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteEventsByEventType AWS API Documentation
1138
+ #
1139
+ # @overload delete_events_by_event_type(params = {})
1140
+ # @param [Hash] params ({})
1141
+ def delete_events_by_event_type(params = {}, options = {})
1142
+ req = build_request(:delete_events_by_event_type, params)
1143
+ req.send_request(options)
1144
+ end
1145
+
1002
1146
  # Removes a SageMaker model from Amazon Fraud Detector.
1003
1147
  #
1004
1148
  # You can remove an Amazon SageMaker model if it is not associated with
@@ -1076,7 +1220,7 @@ module Aws::FraudDetector
1076
1220
  #
1077
1221
  # resp = client.delete_model({
1078
1222
  # model_id: "modelIdentifier", # required
1079
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1223
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
1080
1224
  # })
1081
1225
  #
1082
1226
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteModel AWS API Documentation
@@ -1112,7 +1256,7 @@ module Aws::FraudDetector
1112
1256
  #
1113
1257
  # resp = client.delete_model_version({
1114
1258
  # model_id: "modelIdentifier", # required
1115
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1259
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
1116
1260
  # model_version_number: "floatVersionString", # required
1117
1261
  # })
1118
1262
  #
@@ -1293,7 +1437,7 @@ module Aws::FraudDetector
1293
1437
  # resp = client.describe_model_versions({
1294
1438
  # model_id: "modelIdentifier",
1295
1439
  # model_version_number: "floatVersionString",
1296
- # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
1440
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
1297
1441
  # next_token: "string",
1298
1442
  # max_results: 1,
1299
1443
  # })
@@ -1302,17 +1446,20 @@ module Aws::FraudDetector
1302
1446
  #
1303
1447
  # resp.model_version_details #=> Array
1304
1448
  # resp.model_version_details[0].model_id #=> String
1305
- # resp.model_version_details[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1449
+ # resp.model_version_details[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS", "TRANSACTION_FRAUD_INSIGHTS"
1306
1450
  # resp.model_version_details[0].model_version_number #=> String
1307
1451
  # resp.model_version_details[0].status #=> String
1308
- # resp.model_version_details[0].training_data_source #=> String, one of "EXTERNAL_EVENTS"
1452
+ # resp.model_version_details[0].training_data_source #=> String, one of "EXTERNAL_EVENTS", "INGESTED_EVENTS"
1309
1453
  # resp.model_version_details[0].training_data_schema.model_variables #=> Array
1310
1454
  # resp.model_version_details[0].training_data_schema.model_variables[0] #=> String
1311
1455
  # resp.model_version_details[0].training_data_schema.label_schema.label_mapper #=> Hash
1312
1456
  # resp.model_version_details[0].training_data_schema.label_schema.label_mapper["string"] #=> Array
1313
1457
  # resp.model_version_details[0].training_data_schema.label_schema.label_mapper["string"][0] #=> String
1458
+ # resp.model_version_details[0].training_data_schema.label_schema.unlabeled_events_treatment #=> String, one of "IGNORE", "FRAUD", "LEGIT"
1314
1459
  # resp.model_version_details[0].external_events_detail.data_location #=> String
1315
1460
  # resp.model_version_details[0].external_events_detail.data_access_role_arn #=> String
1461
+ # resp.model_version_details[0].ingested_events_detail.ingested_events_time_window.start_time #=> String
1462
+ # resp.model_version_details[0].ingested_events_detail.ingested_events_time_window.end_time #=> String
1316
1463
  # resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages #=> Array
1317
1464
  # resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages[0].title #=> String
1318
1465
  # resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages[0].content #=> String
@@ -1347,6 +1494,65 @@ module Aws::FraudDetector
1347
1494
  req.send_request(options)
1348
1495
  end
1349
1496
 
1497
+ # Gets all batch import jobs or a specific job of the specified ID. This
1498
+ # is a paginated API. If you provide a null `maxResults`, this action
1499
+ # retrieves a maximum of 50 records per page. If you provide a
1500
+ # `maxResults`, the value must be between 1 and 50. To get the next page
1501
+ # results, provide the pagination token from the
1502
+ # `GetBatchImportJobsResponse` as part of your request. A null
1503
+ # pagination token fetches the records from the beginning.
1504
+ #
1505
+ # @option params [String] :job_id
1506
+ # The ID of the batch import job to get.
1507
+ #
1508
+ # @option params [Integer] :max_results
1509
+ # The maximum number of objects to return for request.
1510
+ #
1511
+ # @option params [String] :next_token
1512
+ # The next token from the previous request.
1513
+ #
1514
+ # @return [Types::GetBatchImportJobsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1515
+ #
1516
+ # * {Types::GetBatchImportJobsResult#batch_imports #batch_imports} => Array&lt;Types::BatchImport&gt;
1517
+ # * {Types::GetBatchImportJobsResult#next_token #next_token} => String
1518
+ #
1519
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1520
+ #
1521
+ # @example Request syntax with placeholder values
1522
+ #
1523
+ # resp = client.get_batch_import_jobs({
1524
+ # job_id: "identifier",
1525
+ # max_results: 1,
1526
+ # next_token: "string",
1527
+ # })
1528
+ #
1529
+ # @example Response structure
1530
+ #
1531
+ # resp.batch_imports #=> Array
1532
+ # resp.batch_imports[0].job_id #=> String
1533
+ # resp.batch_imports[0].status #=> String, one of "IN_PROGRESS_INITIALIZING", "IN_PROGRESS", "CANCEL_IN_PROGRESS", "CANCELED", "COMPLETE", "FAILED"
1534
+ # resp.batch_imports[0].failure_reason #=> String
1535
+ # resp.batch_imports[0].start_time #=> String
1536
+ # resp.batch_imports[0].completion_time #=> String
1537
+ # resp.batch_imports[0].input_path #=> String
1538
+ # resp.batch_imports[0].output_path #=> String
1539
+ # resp.batch_imports[0].event_type_name #=> String
1540
+ # resp.batch_imports[0].iam_role_arn #=> String
1541
+ # resp.batch_imports[0].arn #=> String
1542
+ # resp.batch_imports[0].processed_records_count #=> Integer
1543
+ # resp.batch_imports[0].failed_records_count #=> Integer
1544
+ # resp.batch_imports[0].total_records_count #=> Integer
1545
+ # resp.next_token #=> String
1546
+ #
1547
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetBatchImportJobs AWS API Documentation
1548
+ #
1549
+ # @overload get_batch_import_jobs(params = {})
1550
+ # @param [Hash] params ({})
1551
+ def get_batch_import_jobs(params = {}, options = {})
1552
+ req = build_request(:get_batch_import_jobs, params)
1553
+ req.send_request(options)
1554
+ end
1555
+
1350
1556
  # Gets all batch prediction jobs or a specific job if you specify a job
1351
1557
  # ID. This is a paginated API. If you provide a null maxResults, this
1352
1558
  # action retrieves a maximum of 50 records per page. If you provide a
@@ -1408,6 +1614,36 @@ module Aws::FraudDetector
1408
1614
  req.send_request(options)
1409
1615
  end
1410
1616
 
1617
+ # Retrieves the status of a `DeleteEventsByEventType` action.
1618
+ #
1619
+ # @option params [required, String] :event_type_name
1620
+ # Name of event type for which to get the deletion status.
1621
+ #
1622
+ # @return [Types::GetDeleteEventsByEventTypeStatusResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1623
+ #
1624
+ # * {Types::GetDeleteEventsByEventTypeStatusResult#event_type_name #event_type_name} => String
1625
+ # * {Types::GetDeleteEventsByEventTypeStatusResult#events_deletion_status #events_deletion_status} => String
1626
+ #
1627
+ # @example Request syntax with placeholder values
1628
+ #
1629
+ # resp = client.get_delete_events_by_event_type_status({
1630
+ # event_type_name: "identifier", # required
1631
+ # })
1632
+ #
1633
+ # @example Response structure
1634
+ #
1635
+ # resp.event_type_name #=> String
1636
+ # resp.events_deletion_status #=> String, one of "IN_PROGRESS_INITIALIZING", "IN_PROGRESS", "CANCEL_IN_PROGRESS", "CANCELED", "COMPLETE", "FAILED"
1637
+ #
1638
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetDeleteEventsByEventTypeStatus AWS API Documentation
1639
+ #
1640
+ # @overload get_delete_events_by_event_type_status(params = {})
1641
+ # @param [Hash] params ({})
1642
+ def get_delete_events_by_event_type_status(params = {}, options = {})
1643
+ req = build_request(:get_delete_events_by_event_type_status, params)
1644
+ req.send_request(options)
1645
+ end
1646
+
1411
1647
  # Gets a particular detector version.
1412
1648
  #
1413
1649
  # @option params [required, String] :detector_id
@@ -1446,7 +1682,7 @@ module Aws::FraudDetector
1446
1682
  # resp.external_model_endpoints[0] #=> String
1447
1683
  # resp.model_versions #=> Array
1448
1684
  # resp.model_versions[0].model_id #=> String
1449
- # resp.model_versions[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1685
+ # resp.model_versions[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS", "TRANSACTION_FRAUD_INSIGHTS"
1450
1686
  # resp.model_versions[0].model_version_number #=> String
1451
1687
  # resp.model_versions[0].arn #=> String
1452
1688
  # resp.rules #=> Array
@@ -1571,6 +1807,48 @@ module Aws::FraudDetector
1571
1807
  req.send_request(options)
1572
1808
  end
1573
1809
 
1810
+ # Retrieves details of events stored with Amazon Fraud Detector. This
1811
+ # action does not retrieve prediction results.
1812
+ #
1813
+ # @option params [required, String] :event_id
1814
+ # The ID of the event to retrieve.
1815
+ #
1816
+ # @option params [required, String] :event_type_name
1817
+ # The event type of the event to retrieve.
1818
+ #
1819
+ # @return [Types::GetEventResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1820
+ #
1821
+ # * {Types::GetEventResult#event #event} => Types::Event
1822
+ #
1823
+ # @example Request syntax with placeholder values
1824
+ #
1825
+ # resp = client.get_event({
1826
+ # event_id: "string", # required
1827
+ # event_type_name: "string", # required
1828
+ # })
1829
+ #
1830
+ # @example Response structure
1831
+ #
1832
+ # resp.event.event_id #=> String
1833
+ # resp.event.event_type_name #=> String
1834
+ # resp.event.event_timestamp #=> String
1835
+ # resp.event.event_variables #=> Hash
1836
+ # resp.event.event_variables["attributeKey"] #=> String
1837
+ # resp.event.current_label #=> String
1838
+ # resp.event.label_timestamp #=> String
1839
+ # resp.event.entities #=> Array
1840
+ # resp.event.entities[0].entity_type #=> String
1841
+ # resp.event.entities[0].entity_id #=> String
1842
+ #
1843
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEvent AWS API Documentation
1844
+ #
1845
+ # @overload get_event(params = {})
1846
+ # @param [Hash] params ({})
1847
+ def get_event(params = {}, options = {})
1848
+ req = build_request(:get_event, params)
1849
+ req.send_request(options)
1850
+ end
1851
+
1574
1852
  # Evaluates an event against a detector version. If a version ID is not
1575
1853
  # provided, the detector’s (`ACTIVE`) version is used.
1576
1854
  #
@@ -1593,19 +1871,17 @@ module Aws::FraudDetector
1593
1871
  # id is not available, use "UNKNOWN."
1594
1872
  #
1595
1873
  # @option params [required, String] :event_timestamp
1596
- # Timestamp that defines when the event under evaluation occurred.
1874
+ # Timestamp that defines when the event under evaluation occurred. The
1875
+ # timestamp must be specified using ISO 8601 standard in UTC.
1597
1876
  #
1598
1877
  # @option params [required, Hash<String,String>] :event_variables
1599
1878
  # Names of the event type's variables you defined in Amazon Fraud
1600
1879
  # Detector to represent data elements and their corresponding values for
1601
1880
  # the event you are sending for evaluation.
1602
1881
  #
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
1882
+ # You must provide at least one eventVariable
1607
1883
  #
1608
- # To ensure highest possible fraud prediction and to simplify your data
1884
+ # To ensure most accurate fraud prediction and to simplify your data
1609
1885
  # preparation, Amazon Fraud Detector will replace all missing variables
1610
1886
  # or values as follows:
1611
1887
  #
@@ -1617,7 +1893,7 @@ module Aws::FraudDetector
1617
1893
  # mean/medians for numeric variables and with special values for
1618
1894
  # categorical variables.
1619
1895
  #
1620
- # **For External models ( for example, imported SageMaker):**
1896
+ # **For imported SageMaker models:**
1621
1897
  #
1622
1898
  # If a null value is provided explicitly for a variable, the model and
1623
1899
  # rules will use “null” as the value. If a variable is not provided (no
@@ -1643,7 +1919,7 @@ module Aws::FraudDetector
1643
1919
  # entities: [ # required
1644
1920
  # {
1645
1921
  # entity_type: "string", # required
1646
- # entity_id: "identifier", # required
1922
+ # entity_id: "entityRestrictedString", # required
1647
1923
  # },
1648
1924
  # ],
1649
1925
  # event_timestamp: "utcTimestampISO8601", # required
@@ -1651,7 +1927,7 @@ module Aws::FraudDetector
1651
1927
  # "variableName" => "variableValue",
1652
1928
  # },
1653
1929
  # external_model_endpoint_data_blobs: {
1654
- # "string" => {
1930
+ # "sageMakerEndpointIdentifier" => {
1655
1931
  # byte_buffer: "data",
1656
1932
  # content_type: "contentType",
1657
1933
  # },
@@ -1662,7 +1938,7 @@ module Aws::FraudDetector
1662
1938
  #
1663
1939
  # resp.model_scores #=> Array
1664
1940
  # resp.model_scores[0].model_version.model_id #=> String
1665
- # resp.model_scores[0].model_version.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1941
+ # resp.model_scores[0].model_version.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS", "TRANSACTION_FRAUD_INSIGHTS"
1666
1942
  # resp.model_scores[0].model_version.model_version_number #=> String
1667
1943
  # resp.model_scores[0].model_version.arn #=> String
1668
1944
  # resp.model_scores[0].scores #=> Hash
@@ -1729,6 +2005,12 @@ module Aws::FraudDetector
1729
2005
  # resp.event_types[0].labels[0] #=> String
1730
2006
  # resp.event_types[0].entity_types #=> Array
1731
2007
  # resp.event_types[0].entity_types[0] #=> String
2008
+ # resp.event_types[0].event_ingestion #=> String, one of "ENABLED", "DISABLED"
2009
+ # resp.event_types[0].ingested_event_statistics.number_of_events #=> Integer
2010
+ # resp.event_types[0].ingested_event_statistics.event_data_size_in_bytes #=> Integer
2011
+ # resp.event_types[0].ingested_event_statistics.least_recent_event #=> String
2012
+ # resp.event_types[0].ingested_event_statistics.most_recent_event #=> String
2013
+ # resp.event_types[0].ingested_event_statistics.last_updated_time #=> String
1732
2014
  # resp.event_types[0].last_updated_time #=> String
1733
2015
  # resp.event_types[0].created_time #=> String
1734
2016
  # resp.event_types[0].arn #=> String
@@ -1806,9 +2088,8 @@ module Aws::FraudDetector
1806
2088
  req.send_request(options)
1807
2089
  end
1808
2090
 
1809
- # Gets the encryption key if a Key Management Service (KMS) customer
1810
- # master key (CMK) has been specified to be used to encrypt content in
1811
- # Amazon Fraud Detector.
2091
+ # Gets the encryption key if a KMS key has been specified to be used to
2092
+ # encrypt content in Amazon Fraud Detector.
1812
2093
  #
1813
2094
  # @return [Types::GetKMSEncryptionKeyResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1814
2095
  #
@@ -1897,6 +2178,7 @@ module Aws::FraudDetector
1897
2178
  # * {Types::GetModelVersionResult#training_data_source #training_data_source} => String
1898
2179
  # * {Types::GetModelVersionResult#training_data_schema #training_data_schema} => Types::TrainingDataSchema
1899
2180
  # * {Types::GetModelVersionResult#external_events_detail #external_events_detail} => Types::ExternalEventsDetail
2181
+ # * {Types::GetModelVersionResult#ingested_events_detail #ingested_events_detail} => Types::IngestedEventsDetail
1900
2182
  # * {Types::GetModelVersionResult#status #status} => String
1901
2183
  # * {Types::GetModelVersionResult#arn #arn} => String
1902
2184
  #
@@ -1904,23 +2186,26 @@ module Aws::FraudDetector
1904
2186
  #
1905
2187
  # resp = client.get_model_version({
1906
2188
  # model_id: "modelIdentifier", # required
1907
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
2189
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
1908
2190
  # model_version_number: "floatVersionString", # required
1909
2191
  # })
1910
2192
  #
1911
2193
  # @example Response structure
1912
2194
  #
1913
2195
  # resp.model_id #=> String
1914
- # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
2196
+ # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS", "TRANSACTION_FRAUD_INSIGHTS"
1915
2197
  # resp.model_version_number #=> String
1916
- # resp.training_data_source #=> String, one of "EXTERNAL_EVENTS"
2198
+ # resp.training_data_source #=> String, one of "EXTERNAL_EVENTS", "INGESTED_EVENTS"
1917
2199
  # resp.training_data_schema.model_variables #=> Array
1918
2200
  # resp.training_data_schema.model_variables[0] #=> String
1919
2201
  # resp.training_data_schema.label_schema.label_mapper #=> Hash
1920
2202
  # resp.training_data_schema.label_schema.label_mapper["string"] #=> Array
1921
2203
  # resp.training_data_schema.label_schema.label_mapper["string"][0] #=> String
2204
+ # resp.training_data_schema.label_schema.unlabeled_events_treatment #=> String, one of "IGNORE", "FRAUD", "LEGIT"
1922
2205
  # resp.external_events_detail.data_location #=> String
1923
2206
  # resp.external_events_detail.data_access_role_arn #=> String
2207
+ # resp.ingested_events_detail.ingested_events_time_window.start_time #=> String
2208
+ # resp.ingested_events_detail.ingested_events_time_window.end_time #=> String
1924
2209
  # resp.status #=> String
1925
2210
  # resp.arn #=> String
1926
2211
  #
@@ -1969,7 +2254,7 @@ module Aws::FraudDetector
1969
2254
  #
1970
2255
  # resp = client.get_models({
1971
2256
  # model_id: "modelIdentifier",
1972
- # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
2257
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
1973
2258
  # next_token: "string",
1974
2259
  # max_results: 1,
1975
2260
  # })
@@ -1979,7 +2264,7 @@ module Aws::FraudDetector
1979
2264
  # resp.next_token #=> String
1980
2265
  # resp.models #=> Array
1981
2266
  # resp.models[0].model_id #=> String
1982
- # resp.models[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
2267
+ # resp.models[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS", "TRANSACTION_FRAUD_INSIGHTS"
1983
2268
  # resp.models[0].description #=> String
1984
2269
  # resp.models[0].event_type_name #=> String
1985
2270
  # resp.models[0].created_time #=> String
@@ -2315,6 +2600,9 @@ module Aws::FraudDetector
2315
2600
  # The entity type for the event type. Example entity types: customer,
2316
2601
  # merchant, account.
2317
2602
  #
2603
+ # @option params [String] :event_ingestion
2604
+ # Specifies if ingenstion is enabled or disabled.
2605
+ #
2318
2606
  # @option params [Array<Types::Tag>] :tags
2319
2607
  # A collection of key and value pairs.
2320
2608
  #
@@ -2328,6 +2616,7 @@ module Aws::FraudDetector
2328
2616
  # event_variables: ["string"], # required
2329
2617
  # labels: ["string"],
2330
2618
  # entity_types: ["string"], # required
2619
+ # event_ingestion: "ENABLED", # accepts ENABLED, DISABLED
2331
2620
  # tags: [
2332
2621
  # {
2333
2622
  # key: "tagKey", # required
@@ -2382,8 +2671,8 @@ module Aws::FraudDetector
2382
2671
  # event_type_name: "identifier",
2383
2672
  # format: "TEXT_CSV", # accepts TEXT_CSV, APPLICATION_JSON
2384
2673
  # use_event_variables: false, # required
2385
- # json_input_template: "string",
2386
- # csv_input_template: "string",
2674
+ # json_input_template: "modelInputTemplate",
2675
+ # csv_input_template: "modelInputTemplate",
2387
2676
  # },
2388
2677
  # output_configuration: { # required
2389
2678
  # format: "TEXT_CSV", # required, accepts TEXT_CSV, APPLICATION_JSONLINES
@@ -2412,8 +2701,8 @@ module Aws::FraudDetector
2412
2701
  req.send_request(options)
2413
2702
  end
2414
2703
 
2415
- # Specifies the Key Management Service (KMS) customer master key (CMK)
2416
- # to be used to encrypt content in Amazon Fraud Detector.
2704
+ # Specifies the KMS key to be used to encrypt content in Amazon Fraud
2705
+ # Detector.
2417
2706
  #
2418
2707
  # @option params [required, String] :kms_encryption_key_arn
2419
2708
  # The KMS encryption key ARN.
@@ -2506,6 +2795,67 @@ module Aws::FraudDetector
2506
2795
  req.send_request(options)
2507
2796
  end
2508
2797
 
2798
+ # Stores events in Amazon Fraud Detector without generating fraud
2799
+ # predictions for those events. For example, you can use `SendEvent` to
2800
+ # upload a historical dataset, which you can then later use to train a
2801
+ # model.
2802
+ #
2803
+ # @option params [required, String] :event_id
2804
+ # The event ID to upload.
2805
+ #
2806
+ # @option params [required, String] :event_type_name
2807
+ # The event type name of the event.
2808
+ #
2809
+ # @option params [required, String] :event_timestamp
2810
+ # The timestamp that defines when the event under evaluation occurred.
2811
+ # The timestamp must be specified using ISO 8601 standard in UTC.
2812
+ #
2813
+ # @option params [required, Hash<String,String>] :event_variables
2814
+ # Names of the event type's variables you defined in Amazon Fraud
2815
+ # Detector to represent data elements and their corresponding values for
2816
+ # the event you are sending for evaluation.
2817
+ #
2818
+ # @option params [String] :assigned_label
2819
+ # The label to associate with the event. Required if specifying
2820
+ # `labelTimestamp`.
2821
+ #
2822
+ # @option params [String] :label_timestamp
2823
+ # The timestamp associated with the label. Required if specifying
2824
+ # `assignedLabel`.
2825
+ #
2826
+ # @option params [required, Array<Types::Entity>] :entities
2827
+ # An array of entities.
2828
+ #
2829
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2830
+ #
2831
+ # @example Request syntax with placeholder values
2832
+ #
2833
+ # resp = client.send_event({
2834
+ # event_id: "identifier", # required
2835
+ # event_type_name: "identifier", # required
2836
+ # event_timestamp: "utcTimestampISO8601", # required
2837
+ # event_variables: { # required
2838
+ # "variableName" => "variableValue",
2839
+ # },
2840
+ # assigned_label: "identifier",
2841
+ # label_timestamp: "utcTimestampISO8601",
2842
+ # entities: [ # required
2843
+ # {
2844
+ # entity_type: "string", # required
2845
+ # entity_id: "entityRestrictedString", # required
2846
+ # },
2847
+ # ],
2848
+ # })
2849
+ #
2850
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/SendEvent AWS API Documentation
2851
+ #
2852
+ # @overload send_event(params = {})
2853
+ # @param [Hash] params ({})
2854
+ def send_event(params = {}, options = {})
2855
+ req = build_request(:send_event, params)
2856
+ req.send_request(options)
2857
+ end
2858
+
2509
2859
  # Assigns tags to a resource.
2510
2860
  #
2511
2861
  # @option params [required, String] :resource_arn
@@ -2621,8 +2971,8 @@ module Aws::FraudDetector
2621
2971
  # model_versions: [
2622
2972
  # {
2623
2973
  # model_id: "modelIdentifier", # required
2624
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
2625
- # model_version_number: "nonEmptyString", # required
2974
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
2975
+ # model_version_number: "floatVersionString", # required
2626
2976
  # arn: "fraudDetectorArn",
2627
2977
  # },
2628
2978
  # ],
@@ -2701,8 +3051,42 @@ module Aws::FraudDetector
2701
3051
  req.send_request(options)
2702
3052
  end
2703
3053
 
2704
- # Updates a model. You can update the description attribute using this
2705
- # action.
3054
+ # Updates the specified event with a new label.
3055
+ #
3056
+ # @option params [required, String] :event_id
3057
+ # The ID of the event associated with the label to update.
3058
+ #
3059
+ # @option params [required, String] :event_type_name
3060
+ # The event type of the event associated with the label to update.
3061
+ #
3062
+ # @option params [required, String] :assigned_label
3063
+ # The new label to assign to the event.
3064
+ #
3065
+ # @option params [required, String] :label_timestamp
3066
+ # The timestamp associated with the label. The timestamp must be
3067
+ # specified using ISO 8601 standard in UTC.
3068
+ #
3069
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3070
+ #
3071
+ # @example Request syntax with placeholder values
3072
+ #
3073
+ # resp = client.update_event_label({
3074
+ # event_id: "identifier", # required
3075
+ # event_type_name: "identifier", # required
3076
+ # assigned_label: "identifier", # required
3077
+ # label_timestamp: "utcTimestampISO8601", # required
3078
+ # })
3079
+ #
3080
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateEventLabel AWS API Documentation
3081
+ #
3082
+ # @overload update_event_label(params = {})
3083
+ # @param [Hash] params ({})
3084
+ def update_event_label(params = {}, options = {})
3085
+ req = build_request(:update_event_label, params)
3086
+ req.send_request(options)
3087
+ end
3088
+
3089
+ # Updates model description.
2706
3090
  #
2707
3091
  # @option params [required, String] :model_id
2708
3092
  # The model ID.
@@ -2719,7 +3103,7 @@ module Aws::FraudDetector
2719
3103
  #
2720
3104
  # resp = client.update_model({
2721
3105
  # model_id: "modelIdentifier", # required
2722
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
3106
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
2723
3107
  # description: "description",
2724
3108
  # })
2725
3109
  #
@@ -2749,7 +3133,12 @@ module Aws::FraudDetector
2749
3133
  # The major version number.
2750
3134
  #
2751
3135
  # @option params [Types::ExternalEventsDetail] :external_events_detail
2752
- # The event details.
3136
+ # The details of the external events data used for training the model
3137
+ # version. Required if `trainingDataSource` is `EXTERNAL_EVENTS`.
3138
+ #
3139
+ # @option params [Types::IngestedEventsDetail] :ingested_events_detail
3140
+ # The details of the ingested event used for training the model version.
3141
+ # Required if your `trainingDataSource` is `INGESTED_EVENTS`.
2753
3142
  #
2754
3143
  # @option params [Array<Types::Tag>] :tags
2755
3144
  # A collection of key and value pairs.
@@ -2765,12 +3154,18 @@ module Aws::FraudDetector
2765
3154
  #
2766
3155
  # resp = client.update_model_version({
2767
3156
  # model_id: "modelIdentifier", # required
2768
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
3157
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
2769
3158
  # major_version_number: "wholeNumberVersionString", # required
2770
3159
  # external_events_detail: {
2771
3160
  # data_location: "s3BucketLocation", # required
2772
3161
  # data_access_role_arn: "iamRoleArn", # required
2773
3162
  # },
3163
+ # ingested_events_detail: {
3164
+ # ingested_events_time_window: { # required
3165
+ # start_time: "time", # required
3166
+ # end_time: "time", # required
3167
+ # },
3168
+ # },
2774
3169
  # tags: [
2775
3170
  # {
2776
3171
  # key: "tagKey", # required
@@ -2782,7 +3177,7 @@ module Aws::FraudDetector
2782
3177
  # @example Response structure
2783
3178
  #
2784
3179
  # resp.model_id #=> String
2785
- # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
3180
+ # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS", "TRANSACTION_FRAUD_INSIGHTS"
2786
3181
  # resp.model_version_number #=> String
2787
3182
  # resp.status #=> String
2788
3183
  #
@@ -2801,7 +3196,7 @@ module Aws::FraudDetector
2801
3196
  #
2802
3197
  # 1. Change the `TRAINING_COMPLETE` status to `ACTIVE`.
2803
3198
  #
2804
- # 2. Change `ACTIVE`to `INACTIVE`.
3199
+ # 2. Change `ACTIVE` to `INACTIVE`.
2805
3200
  #
2806
3201
  # @option params [required, String] :model_id
2807
3202
  # The model ID of the model version to update.
@@ -2821,7 +3216,7 @@ module Aws::FraudDetector
2821
3216
  #
2822
3217
  # resp = client.update_model_version_status({
2823
3218
  # model_id: "modelIdentifier", # required
2824
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
3219
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
2825
3220
  # model_version_number: "floatVersionString", # required
2826
3221
  # status: "ACTIVE", # required, accepts ACTIVE, INACTIVE, TRAINING_CANCELLED
2827
3222
  # })
@@ -2976,7 +3371,7 @@ module Aws::FraudDetector
2976
3371
  params: params,
2977
3372
  config: config)
2978
3373
  context[:gem_name] = 'aws-sdk-frauddetector'
2979
- context[:gem_version] = '1.24.0'
3374
+ context[:gem_version] = '1.25.0'
2980
3375
  Seahorse::Client::Request.new(handlers, context)
2981
3376
  end
2982
3377