aws-sdk-frauddetector 1.24.0 → 1.28.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -119,7 +119,9 @@ module Aws::FraudDetector
119
119
  # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
120
  # are very aggressive. Construct and pass an instance of
121
121
  # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
- # enable retries and extended timeouts.
122
+ # enable retries and extended timeouts. Instance profile credential
123
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
124
+ # to true.
123
125
  #
124
126
  # @option options [required, String] :region
125
127
  # The AWS region to connect to. The configured `:region` is
@@ -285,6 +287,15 @@ module Aws::FraudDetector
285
287
  # ** Please note ** When response stubbing is enabled, no HTTP
286
288
  # requests are made, and retries are disabled.
287
289
  #
290
+ # @option options [Boolean] :use_dualstack_endpoint
291
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
292
+ # will be used if available.
293
+ #
294
+ # @option options [Boolean] :use_fips_endpoint
295
+ # When set to `true`, fips compatible endpoints will be used if available.
296
+ # When a `fips` region is used, the region is normalized and this config
297
+ # is set to `true`.
298
+ #
288
299
  # @option options [Boolean] :validate_params (true)
289
300
  # When `true`, request parameters are validated before
290
301
  # sending the request.
@@ -428,6 +439,31 @@ module Aws::FraudDetector
428
439
  req.send_request(options)
429
440
  end
430
441
 
442
+ # Cancels an in-progress batch import job.
443
+ #
444
+ # @option params [required, String] :job_id
445
+ # The ID of an in-progress batch import job to cancel.
446
+ #
447
+ # Amazon Fraud Detector will throw an error if the batch import job is
448
+ # in `FAILED`, `CANCELED`, or `COMPLETED` state.
449
+ #
450
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
451
+ #
452
+ # @example Request syntax with placeholder values
453
+ #
454
+ # resp = client.cancel_batch_import_job({
455
+ # job_id: "identifier", # required
456
+ # })
457
+ #
458
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CancelBatchImportJob AWS API Documentation
459
+ #
460
+ # @overload cancel_batch_import_job(params = {})
461
+ # @param [Hash] params ({})
462
+ def cancel_batch_import_job(params = {}, options = {})
463
+ req = build_request(:cancel_batch_import_job, params)
464
+ req.send_request(options)
465
+ end
466
+
431
467
  # Cancels the specified batch prediction job.
432
468
  #
433
469
  # @option params [required, String] :job_id
@@ -450,6 +486,57 @@ module Aws::FraudDetector
450
486
  req.send_request(options)
451
487
  end
452
488
 
489
+ # Creates a batch import job.
490
+ #
491
+ # @option params [required, String] :job_id
492
+ # The ID of the batch import job. The ID cannot be of a past job, unless
493
+ # the job exists in `CREATE_FAILED` state.
494
+ #
495
+ # @option params [required, String] :input_path
496
+ # The URI that points to the Amazon S3 location of your data file.
497
+ #
498
+ # @option params [required, String] :output_path
499
+ # The URI that points to the Amazon S3 location for storing your
500
+ # results.
501
+ #
502
+ # @option params [required, String] :event_type_name
503
+ # The name of the event type.
504
+ #
505
+ # @option params [required, String] :iam_role_arn
506
+ # The ARN of the IAM role created for Amazon S3 bucket that holds your
507
+ # data file. The IAM role must have read and write permissions to both
508
+ # input and output S3 buckets.
509
+ #
510
+ # @option params [Array<Types::Tag>] :tags
511
+ # A collection of key-value pairs associated with this request.
512
+ #
513
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
514
+ #
515
+ # @example Request syntax with placeholder values
516
+ #
517
+ # resp = client.create_batch_import_job({
518
+ # job_id: "identifier", # required
519
+ # input_path: "s3BucketLocation", # required
520
+ # output_path: "s3BucketLocation", # required
521
+ # event_type_name: "identifier", # required
522
+ # iam_role_arn: "iamRoleArn", # required
523
+ # tags: [
524
+ # {
525
+ # key: "tagKey", # required
526
+ # value: "tagValue", # required
527
+ # },
528
+ # ],
529
+ # })
530
+ #
531
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateBatchImportJob AWS API Documentation
532
+ #
533
+ # @overload create_batch_import_job(params = {})
534
+ # @param [Hash] params ({})
535
+ def create_batch_import_job(params = {}, options = {})
536
+ req = build_request(:create_batch_import_job, params)
537
+ req.send_request(options)
538
+ end
539
+
453
540
  # Creates a batch prediction job.
454
541
  #
455
542
  # @option params [required, String] :job_id
@@ -566,8 +653,8 @@ module Aws::FraudDetector
566
653
  # model_versions: [
567
654
  # {
568
655
  # model_id: "modelIdentifier", # required
569
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
570
- # model_version_number: "nonEmptyString", # required
656
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
657
+ # model_version_number: "floatVersionString", # required
571
658
  # arn: "fraudDetectorArn",
572
659
  # },
573
660
  # ],
@@ -618,7 +705,7 @@ module Aws::FraudDetector
618
705
  #
619
706
  # resp = client.create_model({
620
707
  # model_id: "modelIdentifier", # required
621
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
708
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
622
709
  # description: "description",
623
710
  # event_type_name: "string", # required
624
711
  # tags: [
@@ -654,9 +741,13 @@ module Aws::FraudDetector
654
741
  # The training data schema.
655
742
  #
656
743
  # @option params [Types::ExternalEventsDetail] :external_events_detail
657
- # Details for the external events data used for model version training.
744
+ # Details of the external events data used for model version training.
658
745
  # Required if `trainingDataSource` is `EXTERNAL_EVENTS`.
659
746
  #
747
+ # @option params [Types::IngestedEventsDetail] :ingested_events_detail
748
+ # Details of the ingested events data used for model version training.
749
+ # Required if `trainingDataSource` is `INGESTED_EVENTS`.
750
+ #
660
751
  # @option params [Array<Types::Tag>] :tags
661
752
  # A collection of key and value pairs.
662
753
  #
@@ -671,20 +762,27 @@ module Aws::FraudDetector
671
762
  #
672
763
  # resp = client.create_model_version({
673
764
  # 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
765
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
766
+ # training_data_source: "EXTERNAL_EVENTS", # required, accepts EXTERNAL_EVENTS, INGESTED_EVENTS
676
767
  # training_data_schema: { # required
677
768
  # model_variables: ["string"], # required
678
769
  # label_schema: { # required
679
770
  # label_mapper: { # required
680
771
  # "string" => ["string"],
681
772
  # },
773
+ # unlabeled_events_treatment: "IGNORE", # accepts IGNORE, FRAUD, LEGIT
682
774
  # },
683
775
  # },
684
776
  # external_events_detail: {
685
777
  # data_location: "s3BucketLocation", # required
686
778
  # data_access_role_arn: "iamRoleArn", # required
687
779
  # },
780
+ # ingested_events_detail: {
781
+ # ingested_events_time_window: { # required
782
+ # start_time: "time", # required
783
+ # end_time: "time", # required
784
+ # },
785
+ # },
688
786
  # tags: [
689
787
  # {
690
788
  # key: "tagKey", # required
@@ -696,7 +794,7 @@ module Aws::FraudDetector
696
794
  # @example Response structure
697
795
  #
698
796
  # resp.model_id #=> String
699
- # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
797
+ # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS", "TRANSACTION_FRAUD_INSIGHTS"
700
798
  # resp.model_version_number #=> String
701
799
  # resp.status #=> String
702
800
  #
@@ -832,6 +930,28 @@ module Aws::FraudDetector
832
930
  req.send_request(options)
833
931
  end
834
932
 
933
+ # Deletes data that was batch imported to Amazon Fraud Detector.
934
+ #
935
+ # @option params [required, String] :job_id
936
+ # The ID of the batch import job to delete.
937
+ #
938
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
939
+ #
940
+ # @example Request syntax with placeholder values
941
+ #
942
+ # resp = client.delete_batch_import_job({
943
+ # job_id: "identifier", # required
944
+ # })
945
+ #
946
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteBatchImportJob AWS API Documentation
947
+ #
948
+ # @overload delete_batch_import_job(params = {})
949
+ # @param [Hash] params ({})
950
+ def delete_batch_import_job(params = {}, options = {})
951
+ req = build_request(:delete_batch_import_job, params)
952
+ req.send_request(options)
953
+ end
954
+
835
955
  # Deletes a batch prediction job.
836
956
  #
837
957
  # @option params [required, String] :job_id
@@ -953,6 +1073,10 @@ module Aws::FraudDetector
953
1073
  # @option params [required, String] :event_type_name
954
1074
  # The name of the event type.
955
1075
  #
1076
+ # @option params [Boolean] :delete_audit_history
1077
+ # Specifies whether or not to delete any predictions associated with the
1078
+ # event.
1079
+ #
956
1080
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
957
1081
  #
958
1082
  # @example Request syntax with placeholder values
@@ -960,6 +1084,7 @@ module Aws::FraudDetector
960
1084
  # resp = client.delete_event({
961
1085
  # event_id: "identifier", # required
962
1086
  # event_type_name: "identifier", # required
1087
+ # delete_audit_history: false,
963
1088
  # })
964
1089
  #
965
1090
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteEvent AWS API Documentation
@@ -975,8 +1100,8 @@ module Aws::FraudDetector
975
1100
  #
976
1101
  # You cannot delete an event type that is used in a detector or a model.
977
1102
  #
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
1103
+ # When you delete an event type, Amazon Fraud Detector permanently
1104
+ # deletes that event type and the data is no longer stored in Amazon
980
1105
  # Fraud Detector.
981
1106
  #
982
1107
  # @option params [required, String] :name
@@ -999,6 +1124,36 @@ module Aws::FraudDetector
999
1124
  req.send_request(options)
1000
1125
  end
1001
1126
 
1127
+ # Deletes all events of a particular event type.
1128
+ #
1129
+ # @option params [required, String] :event_type_name
1130
+ # The name of the event type.
1131
+ #
1132
+ # @return [Types::DeleteEventsByEventTypeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1133
+ #
1134
+ # * {Types::DeleteEventsByEventTypeResult#event_type_name #event_type_name} => String
1135
+ # * {Types::DeleteEventsByEventTypeResult#events_deletion_status #events_deletion_status} => String
1136
+ #
1137
+ # @example Request syntax with placeholder values
1138
+ #
1139
+ # resp = client.delete_events_by_event_type({
1140
+ # event_type_name: "identifier", # required
1141
+ # })
1142
+ #
1143
+ # @example Response structure
1144
+ #
1145
+ # resp.event_type_name #=> String
1146
+ # resp.events_deletion_status #=> String
1147
+ #
1148
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteEventsByEventType AWS API Documentation
1149
+ #
1150
+ # @overload delete_events_by_event_type(params = {})
1151
+ # @param [Hash] params ({})
1152
+ def delete_events_by_event_type(params = {}, options = {})
1153
+ req = build_request(:delete_events_by_event_type, params)
1154
+ req.send_request(options)
1155
+ end
1156
+
1002
1157
  # Removes a SageMaker model from Amazon Fraud Detector.
1003
1158
  #
1004
1159
  # You can remove an Amazon SageMaker model if it is not associated with
@@ -1076,7 +1231,7 @@ module Aws::FraudDetector
1076
1231
  #
1077
1232
  # resp = client.delete_model({
1078
1233
  # model_id: "modelIdentifier", # required
1079
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1234
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
1080
1235
  # })
1081
1236
  #
1082
1237
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteModel AWS API Documentation
@@ -1112,7 +1267,7 @@ module Aws::FraudDetector
1112
1267
  #
1113
1268
  # resp = client.delete_model_version({
1114
1269
  # model_id: "modelIdentifier", # required
1115
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1270
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
1116
1271
  # model_version_number: "floatVersionString", # required
1117
1272
  # })
1118
1273
  #
@@ -1293,7 +1448,7 @@ module Aws::FraudDetector
1293
1448
  # resp = client.describe_model_versions({
1294
1449
  # model_id: "modelIdentifier",
1295
1450
  # model_version_number: "floatVersionString",
1296
- # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
1451
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
1297
1452
  # next_token: "string",
1298
1453
  # max_results: 1,
1299
1454
  # })
@@ -1302,17 +1457,20 @@ module Aws::FraudDetector
1302
1457
  #
1303
1458
  # resp.model_version_details #=> Array
1304
1459
  # resp.model_version_details[0].model_id #=> String
1305
- # resp.model_version_details[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1460
+ # resp.model_version_details[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS", "TRANSACTION_FRAUD_INSIGHTS"
1306
1461
  # resp.model_version_details[0].model_version_number #=> String
1307
1462
  # resp.model_version_details[0].status #=> String
1308
- # resp.model_version_details[0].training_data_source #=> String, one of "EXTERNAL_EVENTS"
1463
+ # resp.model_version_details[0].training_data_source #=> String, one of "EXTERNAL_EVENTS", "INGESTED_EVENTS"
1309
1464
  # resp.model_version_details[0].training_data_schema.model_variables #=> Array
1310
1465
  # resp.model_version_details[0].training_data_schema.model_variables[0] #=> String
1311
1466
  # resp.model_version_details[0].training_data_schema.label_schema.label_mapper #=> Hash
1312
1467
  # resp.model_version_details[0].training_data_schema.label_schema.label_mapper["string"] #=> Array
1313
1468
  # resp.model_version_details[0].training_data_schema.label_schema.label_mapper["string"][0] #=> String
1469
+ # resp.model_version_details[0].training_data_schema.label_schema.unlabeled_events_treatment #=> String, one of "IGNORE", "FRAUD", "LEGIT"
1314
1470
  # resp.model_version_details[0].external_events_detail.data_location #=> String
1315
1471
  # resp.model_version_details[0].external_events_detail.data_access_role_arn #=> String
1472
+ # resp.model_version_details[0].ingested_events_detail.ingested_events_time_window.start_time #=> String
1473
+ # resp.model_version_details[0].ingested_events_detail.ingested_events_time_window.end_time #=> String
1316
1474
  # resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages #=> Array
1317
1475
  # resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages[0].title #=> String
1318
1476
  # resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages[0].content #=> String
@@ -1347,6 +1505,65 @@ module Aws::FraudDetector
1347
1505
  req.send_request(options)
1348
1506
  end
1349
1507
 
1508
+ # Gets all batch import jobs or a specific job of the specified ID. This
1509
+ # is a paginated API. If you provide a null `maxResults`, this action
1510
+ # retrieves a maximum of 50 records per page. If you provide a
1511
+ # `maxResults`, the value must be between 1 and 50. To get the next page
1512
+ # results, provide the pagination token from the
1513
+ # `GetBatchImportJobsResponse` as part of your request. A null
1514
+ # pagination token fetches the records from the beginning.
1515
+ #
1516
+ # @option params [String] :job_id
1517
+ # The ID of the batch import job to get.
1518
+ #
1519
+ # @option params [Integer] :max_results
1520
+ # The maximum number of objects to return for request.
1521
+ #
1522
+ # @option params [String] :next_token
1523
+ # The next token from the previous request.
1524
+ #
1525
+ # @return [Types::GetBatchImportJobsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1526
+ #
1527
+ # * {Types::GetBatchImportJobsResult#batch_imports #batch_imports} => Array&lt;Types::BatchImport&gt;
1528
+ # * {Types::GetBatchImportJobsResult#next_token #next_token} => String
1529
+ #
1530
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1531
+ #
1532
+ # @example Request syntax with placeholder values
1533
+ #
1534
+ # resp = client.get_batch_import_jobs({
1535
+ # job_id: "identifier",
1536
+ # max_results: 1,
1537
+ # next_token: "string",
1538
+ # })
1539
+ #
1540
+ # @example Response structure
1541
+ #
1542
+ # resp.batch_imports #=> Array
1543
+ # resp.batch_imports[0].job_id #=> String
1544
+ # resp.batch_imports[0].status #=> String, one of "IN_PROGRESS_INITIALIZING", "IN_PROGRESS", "CANCEL_IN_PROGRESS", "CANCELED", "COMPLETE", "FAILED"
1545
+ # resp.batch_imports[0].failure_reason #=> String
1546
+ # resp.batch_imports[0].start_time #=> String
1547
+ # resp.batch_imports[0].completion_time #=> String
1548
+ # resp.batch_imports[0].input_path #=> String
1549
+ # resp.batch_imports[0].output_path #=> String
1550
+ # resp.batch_imports[0].event_type_name #=> String
1551
+ # resp.batch_imports[0].iam_role_arn #=> String
1552
+ # resp.batch_imports[0].arn #=> String
1553
+ # resp.batch_imports[0].processed_records_count #=> Integer
1554
+ # resp.batch_imports[0].failed_records_count #=> Integer
1555
+ # resp.batch_imports[0].total_records_count #=> Integer
1556
+ # resp.next_token #=> String
1557
+ #
1558
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetBatchImportJobs AWS API Documentation
1559
+ #
1560
+ # @overload get_batch_import_jobs(params = {})
1561
+ # @param [Hash] params ({})
1562
+ def get_batch_import_jobs(params = {}, options = {})
1563
+ req = build_request(:get_batch_import_jobs, params)
1564
+ req.send_request(options)
1565
+ end
1566
+
1350
1567
  # Gets all batch prediction jobs or a specific job if you specify a job
1351
1568
  # ID. This is a paginated API. If you provide a null maxResults, this
1352
1569
  # action retrieves a maximum of 50 records per page. If you provide a
@@ -1408,6 +1625,36 @@ module Aws::FraudDetector
1408
1625
  req.send_request(options)
1409
1626
  end
1410
1627
 
1628
+ # Retrieves the status of a `DeleteEventsByEventType` action.
1629
+ #
1630
+ # @option params [required, String] :event_type_name
1631
+ # Name of event type for which to get the deletion status.
1632
+ #
1633
+ # @return [Types::GetDeleteEventsByEventTypeStatusResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1634
+ #
1635
+ # * {Types::GetDeleteEventsByEventTypeStatusResult#event_type_name #event_type_name} => String
1636
+ # * {Types::GetDeleteEventsByEventTypeStatusResult#events_deletion_status #events_deletion_status} => String
1637
+ #
1638
+ # @example Request syntax with placeholder values
1639
+ #
1640
+ # resp = client.get_delete_events_by_event_type_status({
1641
+ # event_type_name: "identifier", # required
1642
+ # })
1643
+ #
1644
+ # @example Response structure
1645
+ #
1646
+ # resp.event_type_name #=> String
1647
+ # resp.events_deletion_status #=> String, one of "IN_PROGRESS_INITIALIZING", "IN_PROGRESS", "CANCEL_IN_PROGRESS", "CANCELED", "COMPLETE", "FAILED"
1648
+ #
1649
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetDeleteEventsByEventTypeStatus AWS API Documentation
1650
+ #
1651
+ # @overload get_delete_events_by_event_type_status(params = {})
1652
+ # @param [Hash] params ({})
1653
+ def get_delete_events_by_event_type_status(params = {}, options = {})
1654
+ req = build_request(:get_delete_events_by_event_type_status, params)
1655
+ req.send_request(options)
1656
+ end
1657
+
1411
1658
  # Gets a particular detector version.
1412
1659
  #
1413
1660
  # @option params [required, String] :detector_id
@@ -1446,7 +1693,7 @@ module Aws::FraudDetector
1446
1693
  # resp.external_model_endpoints[0] #=> String
1447
1694
  # resp.model_versions #=> Array
1448
1695
  # resp.model_versions[0].model_id #=> String
1449
- # resp.model_versions[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1696
+ # resp.model_versions[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS", "TRANSACTION_FRAUD_INSIGHTS"
1450
1697
  # resp.model_versions[0].model_version_number #=> String
1451
1698
  # resp.model_versions[0].arn #=> String
1452
1699
  # resp.rules #=> Array
@@ -1571,6 +1818,48 @@ module Aws::FraudDetector
1571
1818
  req.send_request(options)
1572
1819
  end
1573
1820
 
1821
+ # Retrieves details of events stored with Amazon Fraud Detector. This
1822
+ # action does not retrieve prediction results.
1823
+ #
1824
+ # @option params [required, String] :event_id
1825
+ # The ID of the event to retrieve.
1826
+ #
1827
+ # @option params [required, String] :event_type_name
1828
+ # The event type of the event to retrieve.
1829
+ #
1830
+ # @return [Types::GetEventResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1831
+ #
1832
+ # * {Types::GetEventResult#event #event} => Types::Event
1833
+ #
1834
+ # @example Request syntax with placeholder values
1835
+ #
1836
+ # resp = client.get_event({
1837
+ # event_id: "string", # required
1838
+ # event_type_name: "string", # required
1839
+ # })
1840
+ #
1841
+ # @example Response structure
1842
+ #
1843
+ # resp.event.event_id #=> String
1844
+ # resp.event.event_type_name #=> String
1845
+ # resp.event.event_timestamp #=> String
1846
+ # resp.event.event_variables #=> Hash
1847
+ # resp.event.event_variables["attributeKey"] #=> String
1848
+ # resp.event.current_label #=> String
1849
+ # resp.event.label_timestamp #=> String
1850
+ # resp.event.entities #=> Array
1851
+ # resp.event.entities[0].entity_type #=> String
1852
+ # resp.event.entities[0].entity_id #=> String
1853
+ #
1854
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEvent AWS API Documentation
1855
+ #
1856
+ # @overload get_event(params = {})
1857
+ # @param [Hash] params ({})
1858
+ def get_event(params = {}, options = {})
1859
+ req = build_request(:get_event, params)
1860
+ req.send_request(options)
1861
+ end
1862
+
1574
1863
  # Evaluates an event against a detector version. If a version ID is not
1575
1864
  # provided, the detector’s (`ACTIVE`) version is used.
1576
1865
  #
@@ -1593,19 +1882,17 @@ module Aws::FraudDetector
1593
1882
  # id is not available, use "UNKNOWN."
1594
1883
  #
1595
1884
  # @option params [required, String] :event_timestamp
1596
- # Timestamp that defines when the event under evaluation occurred.
1885
+ # Timestamp that defines when the event under evaluation occurred. The
1886
+ # timestamp must be specified using ISO 8601 standard in UTC.
1597
1887
  #
1598
1888
  # @option params [required, Hash<String,String>] :event_variables
1599
1889
  # Names of the event type's variables you defined in Amazon Fraud
1600
1890
  # Detector to represent data elements and their corresponding values for
1601
1891
  # the event you are sending for evaluation.
1602
1892
  #
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
1893
+ # You must provide at least one eventVariable
1607
1894
  #
1608
- # To ensure highest possible fraud prediction and to simplify your data
1895
+ # To ensure most accurate fraud prediction and to simplify your data
1609
1896
  # preparation, Amazon Fraud Detector will replace all missing variables
1610
1897
  # or values as follows:
1611
1898
  #
@@ -1617,7 +1904,7 @@ module Aws::FraudDetector
1617
1904
  # mean/medians for numeric variables and with special values for
1618
1905
  # categorical variables.
1619
1906
  #
1620
- # **For External models ( for example, imported SageMaker):**
1907
+ # **For imported SageMaker models:**
1621
1908
  #
1622
1909
  # If a null value is provided explicitly for a variable, the model and
1623
1910
  # rules will use “null” as the value. If a variable is not provided (no
@@ -1643,7 +1930,7 @@ module Aws::FraudDetector
1643
1930
  # entities: [ # required
1644
1931
  # {
1645
1932
  # entity_type: "string", # required
1646
- # entity_id: "identifier", # required
1933
+ # entity_id: "entityRestrictedString", # required
1647
1934
  # },
1648
1935
  # ],
1649
1936
  # event_timestamp: "utcTimestampISO8601", # required
@@ -1651,7 +1938,7 @@ module Aws::FraudDetector
1651
1938
  # "variableName" => "variableValue",
1652
1939
  # },
1653
1940
  # external_model_endpoint_data_blobs: {
1654
- # "string" => {
1941
+ # "sageMakerEndpointIdentifier" => {
1655
1942
  # byte_buffer: "data",
1656
1943
  # content_type: "contentType",
1657
1944
  # },
@@ -1662,7 +1949,7 @@ module Aws::FraudDetector
1662
1949
  #
1663
1950
  # resp.model_scores #=> Array
1664
1951
  # resp.model_scores[0].model_version.model_id #=> String
1665
- # resp.model_scores[0].model_version.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1952
+ # resp.model_scores[0].model_version.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS", "TRANSACTION_FRAUD_INSIGHTS"
1666
1953
  # resp.model_scores[0].model_version.model_version_number #=> String
1667
1954
  # resp.model_scores[0].model_version.arn #=> String
1668
1955
  # resp.model_scores[0].scores #=> Hash
@@ -1729,6 +2016,12 @@ module Aws::FraudDetector
1729
2016
  # resp.event_types[0].labels[0] #=> String
1730
2017
  # resp.event_types[0].entity_types #=> Array
1731
2018
  # resp.event_types[0].entity_types[0] #=> String
2019
+ # resp.event_types[0].event_ingestion #=> String, one of "ENABLED", "DISABLED"
2020
+ # resp.event_types[0].ingested_event_statistics.number_of_events #=> Integer
2021
+ # resp.event_types[0].ingested_event_statistics.event_data_size_in_bytes #=> Integer
2022
+ # resp.event_types[0].ingested_event_statistics.least_recent_event #=> String
2023
+ # resp.event_types[0].ingested_event_statistics.most_recent_event #=> String
2024
+ # resp.event_types[0].ingested_event_statistics.last_updated_time #=> String
1732
2025
  # resp.event_types[0].last_updated_time #=> String
1733
2026
  # resp.event_types[0].created_time #=> String
1734
2027
  # resp.event_types[0].arn #=> String
@@ -1806,9 +2099,8 @@ module Aws::FraudDetector
1806
2099
  req.send_request(options)
1807
2100
  end
1808
2101
 
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.
2102
+ # Gets the encryption key if a KMS key has been specified to be used to
2103
+ # encrypt content in Amazon Fraud Detector.
1812
2104
  #
1813
2105
  # @return [Types::GetKMSEncryptionKeyResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1814
2106
  #
@@ -1897,6 +2189,7 @@ module Aws::FraudDetector
1897
2189
  # * {Types::GetModelVersionResult#training_data_source #training_data_source} => String
1898
2190
  # * {Types::GetModelVersionResult#training_data_schema #training_data_schema} => Types::TrainingDataSchema
1899
2191
  # * {Types::GetModelVersionResult#external_events_detail #external_events_detail} => Types::ExternalEventsDetail
2192
+ # * {Types::GetModelVersionResult#ingested_events_detail #ingested_events_detail} => Types::IngestedEventsDetail
1900
2193
  # * {Types::GetModelVersionResult#status #status} => String
1901
2194
  # * {Types::GetModelVersionResult#arn #arn} => String
1902
2195
  #
@@ -1904,23 +2197,26 @@ module Aws::FraudDetector
1904
2197
  #
1905
2198
  # resp = client.get_model_version({
1906
2199
  # model_id: "modelIdentifier", # required
1907
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
2200
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
1908
2201
  # model_version_number: "floatVersionString", # required
1909
2202
  # })
1910
2203
  #
1911
2204
  # @example Response structure
1912
2205
  #
1913
2206
  # resp.model_id #=> String
1914
- # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
2207
+ # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS", "TRANSACTION_FRAUD_INSIGHTS"
1915
2208
  # resp.model_version_number #=> String
1916
- # resp.training_data_source #=> String, one of "EXTERNAL_EVENTS"
2209
+ # resp.training_data_source #=> String, one of "EXTERNAL_EVENTS", "INGESTED_EVENTS"
1917
2210
  # resp.training_data_schema.model_variables #=> Array
1918
2211
  # resp.training_data_schema.model_variables[0] #=> String
1919
2212
  # resp.training_data_schema.label_schema.label_mapper #=> Hash
1920
2213
  # resp.training_data_schema.label_schema.label_mapper["string"] #=> Array
1921
2214
  # resp.training_data_schema.label_schema.label_mapper["string"][0] #=> String
2215
+ # resp.training_data_schema.label_schema.unlabeled_events_treatment #=> String, one of "IGNORE", "FRAUD", "LEGIT"
1922
2216
  # resp.external_events_detail.data_location #=> String
1923
2217
  # resp.external_events_detail.data_access_role_arn #=> String
2218
+ # resp.ingested_events_detail.ingested_events_time_window.start_time #=> String
2219
+ # resp.ingested_events_detail.ingested_events_time_window.end_time #=> String
1924
2220
  # resp.status #=> String
1925
2221
  # resp.arn #=> String
1926
2222
  #
@@ -1969,7 +2265,7 @@ module Aws::FraudDetector
1969
2265
  #
1970
2266
  # resp = client.get_models({
1971
2267
  # model_id: "modelIdentifier",
1972
- # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
2268
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
1973
2269
  # next_token: "string",
1974
2270
  # max_results: 1,
1975
2271
  # })
@@ -1979,7 +2275,7 @@ module Aws::FraudDetector
1979
2275
  # resp.next_token #=> String
1980
2276
  # resp.models #=> Array
1981
2277
  # resp.models[0].model_id #=> String
1982
- # resp.models[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
2278
+ # resp.models[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS", "TRANSACTION_FRAUD_INSIGHTS"
1983
2279
  # resp.models[0].description #=> String
1984
2280
  # resp.models[0].event_type_name #=> String
1985
2281
  # resp.models[0].created_time #=> String
@@ -2315,6 +2611,9 @@ module Aws::FraudDetector
2315
2611
  # The entity type for the event type. Example entity types: customer,
2316
2612
  # merchant, account.
2317
2613
  #
2614
+ # @option params [String] :event_ingestion
2615
+ # Specifies if ingenstion is enabled or disabled.
2616
+ #
2318
2617
  # @option params [Array<Types::Tag>] :tags
2319
2618
  # A collection of key and value pairs.
2320
2619
  #
@@ -2328,6 +2627,7 @@ module Aws::FraudDetector
2328
2627
  # event_variables: ["string"], # required
2329
2628
  # labels: ["string"],
2330
2629
  # entity_types: ["string"], # required
2630
+ # event_ingestion: "ENABLED", # accepts ENABLED, DISABLED
2331
2631
  # tags: [
2332
2632
  # {
2333
2633
  # key: "tagKey", # required
@@ -2382,8 +2682,8 @@ module Aws::FraudDetector
2382
2682
  # event_type_name: "identifier",
2383
2683
  # format: "TEXT_CSV", # accepts TEXT_CSV, APPLICATION_JSON
2384
2684
  # use_event_variables: false, # required
2385
- # json_input_template: "string",
2386
- # csv_input_template: "string",
2685
+ # json_input_template: "modelInputTemplate",
2686
+ # csv_input_template: "modelInputTemplate",
2387
2687
  # },
2388
2688
  # output_configuration: { # required
2389
2689
  # format: "TEXT_CSV", # required, accepts TEXT_CSV, APPLICATION_JSONLINES
@@ -2412,8 +2712,8 @@ module Aws::FraudDetector
2412
2712
  req.send_request(options)
2413
2713
  end
2414
2714
 
2415
- # Specifies the Key Management Service (KMS) customer master key (CMK)
2416
- # to be used to encrypt content in Amazon Fraud Detector.
2715
+ # Specifies the KMS key to be used to encrypt content in Amazon Fraud
2716
+ # Detector.
2417
2717
  #
2418
2718
  # @option params [required, String] :kms_encryption_key_arn
2419
2719
  # The KMS encryption key ARN.
@@ -2506,6 +2806,67 @@ module Aws::FraudDetector
2506
2806
  req.send_request(options)
2507
2807
  end
2508
2808
 
2809
+ # Stores events in Amazon Fraud Detector without generating fraud
2810
+ # predictions for those events. For example, you can use `SendEvent` to
2811
+ # upload a historical dataset, which you can then later use to train a
2812
+ # model.
2813
+ #
2814
+ # @option params [required, String] :event_id
2815
+ # The event ID to upload.
2816
+ #
2817
+ # @option params [required, String] :event_type_name
2818
+ # The event type name of the event.
2819
+ #
2820
+ # @option params [required, String] :event_timestamp
2821
+ # The timestamp that defines when the event under evaluation occurred.
2822
+ # The timestamp must be specified using ISO 8601 standard in UTC.
2823
+ #
2824
+ # @option params [required, Hash<String,String>] :event_variables
2825
+ # Names of the event type's variables you defined in Amazon Fraud
2826
+ # Detector to represent data elements and their corresponding values for
2827
+ # the event you are sending for evaluation.
2828
+ #
2829
+ # @option params [String] :assigned_label
2830
+ # The label to associate with the event. Required if specifying
2831
+ # `labelTimestamp`.
2832
+ #
2833
+ # @option params [String] :label_timestamp
2834
+ # The timestamp associated with the label. Required if specifying
2835
+ # `assignedLabel`.
2836
+ #
2837
+ # @option params [required, Array<Types::Entity>] :entities
2838
+ # An array of entities.
2839
+ #
2840
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2841
+ #
2842
+ # @example Request syntax with placeholder values
2843
+ #
2844
+ # resp = client.send_event({
2845
+ # event_id: "identifier", # required
2846
+ # event_type_name: "identifier", # required
2847
+ # event_timestamp: "utcTimestampISO8601", # required
2848
+ # event_variables: { # required
2849
+ # "variableName" => "variableValue",
2850
+ # },
2851
+ # assigned_label: "identifier",
2852
+ # label_timestamp: "utcTimestampISO8601",
2853
+ # entities: [ # required
2854
+ # {
2855
+ # entity_type: "string", # required
2856
+ # entity_id: "entityRestrictedString", # required
2857
+ # },
2858
+ # ],
2859
+ # })
2860
+ #
2861
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/SendEvent AWS API Documentation
2862
+ #
2863
+ # @overload send_event(params = {})
2864
+ # @param [Hash] params ({})
2865
+ def send_event(params = {}, options = {})
2866
+ req = build_request(:send_event, params)
2867
+ req.send_request(options)
2868
+ end
2869
+
2509
2870
  # Assigns tags to a resource.
2510
2871
  #
2511
2872
  # @option params [required, String] :resource_arn
@@ -2621,8 +2982,8 @@ module Aws::FraudDetector
2621
2982
  # model_versions: [
2622
2983
  # {
2623
2984
  # model_id: "modelIdentifier", # required
2624
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
2625
- # model_version_number: "nonEmptyString", # required
2985
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
2986
+ # model_version_number: "floatVersionString", # required
2626
2987
  # arn: "fraudDetectorArn",
2627
2988
  # },
2628
2989
  # ],
@@ -2701,8 +3062,42 @@ module Aws::FraudDetector
2701
3062
  req.send_request(options)
2702
3063
  end
2703
3064
 
2704
- # Updates a model. You can update the description attribute using this
2705
- # action.
3065
+ # Updates the specified event with a new label.
3066
+ #
3067
+ # @option params [required, String] :event_id
3068
+ # The ID of the event associated with the label to update.
3069
+ #
3070
+ # @option params [required, String] :event_type_name
3071
+ # The event type of the event associated with the label to update.
3072
+ #
3073
+ # @option params [required, String] :assigned_label
3074
+ # The new label to assign to the event.
3075
+ #
3076
+ # @option params [required, String] :label_timestamp
3077
+ # The timestamp associated with the label. The timestamp must be
3078
+ # specified using ISO 8601 standard in UTC.
3079
+ #
3080
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3081
+ #
3082
+ # @example Request syntax with placeholder values
3083
+ #
3084
+ # resp = client.update_event_label({
3085
+ # event_id: "identifier", # required
3086
+ # event_type_name: "identifier", # required
3087
+ # assigned_label: "identifier", # required
3088
+ # label_timestamp: "utcTimestampISO8601", # required
3089
+ # })
3090
+ #
3091
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateEventLabel AWS API Documentation
3092
+ #
3093
+ # @overload update_event_label(params = {})
3094
+ # @param [Hash] params ({})
3095
+ def update_event_label(params = {}, options = {})
3096
+ req = build_request(:update_event_label, params)
3097
+ req.send_request(options)
3098
+ end
3099
+
3100
+ # Updates model description.
2706
3101
  #
2707
3102
  # @option params [required, String] :model_id
2708
3103
  # The model ID.
@@ -2719,7 +3114,7 @@ module Aws::FraudDetector
2719
3114
  #
2720
3115
  # resp = client.update_model({
2721
3116
  # model_id: "modelIdentifier", # required
2722
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
3117
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
2723
3118
  # description: "description",
2724
3119
  # })
2725
3120
  #
@@ -2749,7 +3144,12 @@ module Aws::FraudDetector
2749
3144
  # The major version number.
2750
3145
  #
2751
3146
  # @option params [Types::ExternalEventsDetail] :external_events_detail
2752
- # The event details.
3147
+ # The details of the external events data used for training the model
3148
+ # version. Required if `trainingDataSource` is `EXTERNAL_EVENTS`.
3149
+ #
3150
+ # @option params [Types::IngestedEventsDetail] :ingested_events_detail
3151
+ # The details of the ingested event used for training the model version.
3152
+ # Required if your `trainingDataSource` is `INGESTED_EVENTS`.
2753
3153
  #
2754
3154
  # @option params [Array<Types::Tag>] :tags
2755
3155
  # A collection of key and value pairs.
@@ -2765,12 +3165,18 @@ module Aws::FraudDetector
2765
3165
  #
2766
3166
  # resp = client.update_model_version({
2767
3167
  # model_id: "modelIdentifier", # required
2768
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
3168
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
2769
3169
  # major_version_number: "wholeNumberVersionString", # required
2770
3170
  # external_events_detail: {
2771
3171
  # data_location: "s3BucketLocation", # required
2772
3172
  # data_access_role_arn: "iamRoleArn", # required
2773
3173
  # },
3174
+ # ingested_events_detail: {
3175
+ # ingested_events_time_window: { # required
3176
+ # start_time: "time", # required
3177
+ # end_time: "time", # required
3178
+ # },
3179
+ # },
2774
3180
  # tags: [
2775
3181
  # {
2776
3182
  # key: "tagKey", # required
@@ -2782,7 +3188,7 @@ module Aws::FraudDetector
2782
3188
  # @example Response structure
2783
3189
  #
2784
3190
  # resp.model_id #=> String
2785
- # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
3191
+ # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS", "TRANSACTION_FRAUD_INSIGHTS"
2786
3192
  # resp.model_version_number #=> String
2787
3193
  # resp.status #=> String
2788
3194
  #
@@ -2801,7 +3207,7 @@ module Aws::FraudDetector
2801
3207
  #
2802
3208
  # 1. Change the `TRAINING_COMPLETE` status to `ACTIVE`.
2803
3209
  #
2804
- # 2. Change `ACTIVE`to `INACTIVE`.
3210
+ # 2. Change `ACTIVE` to `INACTIVE`.
2805
3211
  #
2806
3212
  # @option params [required, String] :model_id
2807
3213
  # The model ID of the model version to update.
@@ -2821,7 +3227,7 @@ module Aws::FraudDetector
2821
3227
  #
2822
3228
  # resp = client.update_model_version_status({
2823
3229
  # model_id: "modelIdentifier", # required
2824
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
3230
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS
2825
3231
  # model_version_number: "floatVersionString", # required
2826
3232
  # status: "ACTIVE", # required, accepts ACTIVE, INACTIVE, TRAINING_CANCELLED
2827
3233
  # })
@@ -2976,7 +3382,7 @@ module Aws::FraudDetector
2976
3382
  params: params,
2977
3383
  config: config)
2978
3384
  context[:gem_name] = 'aws-sdk-frauddetector'
2979
- context[:gem_version] = '1.24.0'
3385
+ context[:gem_version] = '1.28.0'
2980
3386
  Seahorse::Client::Request.new(handlers, context)
2981
3387
  end
2982
3388