aws-sdk-frauddetector 1.4.0 → 1.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: fe18577f2ee8fe666cd1fbed88b23d3a24df2b8c18f7cd433ac9df28a283fe04
4
- data.tar.gz: 1f8dc6086a64d635be16781a8a61f76eb183d44f5fe41b6803d49f687dba77c3
3
+ metadata.gz: 10fbb14e6a72176e19c784edb837788a0961051693362de27d5fd6ab444f038d
4
+ data.tar.gz: 0c1a6fab3d9029f545ffce2b11d471837c703a5e80f6e9f0ca93c614d261eceb
5
5
  SHA512:
6
- metadata.gz: c2e91e47943e45666e8aec2f7e646f5e112ee530d71ea05a9052a47fc407abde52b6b4a66f8844d375e4c3a82dc5d825692cd9ccb31b1c8db7d61d6e0620d178
7
- data.tar.gz: e9daa4f28f0e541ba6614c5891e2f9b1cc392ccc3c91680c10223ae8671d19888d02ffa48f468e56ea47f2e657eab25a78ae26ece5ccd28fe057bccb87618c6b
6
+ metadata.gz: '06977ab1626ac168bc04d6179068a01f376b1bf925cf70d20b0d7612e487ebaf7ac9f5f48ab7aae5a2735f07345abbeffe2b77b016fce444086b37e694d8cb3b'
7
+ data.tar.gz: 426fdca25adfc3899760039b8ef2f0dd41734857882ac8b1c34491f4d98b9633f610b2be57ece34cdf78ffe8d2ea9fcd693a98b5a05b25c97a708a809693a966
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -45,6 +47,6 @@ require_relative 'aws-sdk-frauddetector/customizations'
45
47
  # @service
46
48
  module Aws::FraudDetector
47
49
 
48
- GEM_VERSION = '1.4.0'
50
+ GEM_VERSION = '1.9.0'
49
51
 
50
52
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
26
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
30
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
31
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
29
32
 
@@ -69,6 +72,7 @@ module Aws::FraudDetector
69
72
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
70
73
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
71
74
  add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
72
76
  add_plugin(Aws::Plugins::SignatureV4)
73
77
  add_plugin(Aws::Plugins::Protocols::JsonRpc)
74
78
 
@@ -161,7 +165,7 @@ module Aws::FraudDetector
161
165
  # @option options [String] :endpoint
162
166
  # The client endpoint is normally constructed from the `:region`
163
167
  # option. You should only configure an `:endpoint` when connecting
164
- # to test endpoints. This should be a valid HTTP(S) URI.
168
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
165
169
  #
166
170
  # @option options [Integer] :endpoint_cache_max_entries (1000)
167
171
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -323,6 +327,9 @@ module Aws::FraudDetector
323
327
  # @option params [required, Array<Types::VariableEntry>] :variable_entries
324
328
  # The list of variables for the batch create variable request.
325
329
  #
330
+ # @option params [Array<Types::Tag>] :tags
331
+ # A collection of key and value pairs.
332
+ #
326
333
  # @return [Types::BatchCreateVariableResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
327
334
  #
328
335
  # * {Types::BatchCreateVariableResult#errors #errors} => Array&lt;Types::BatchCreateVariableError&gt;
@@ -340,6 +347,12 @@ module Aws::FraudDetector
340
347
  # variable_type: "string",
341
348
  # },
342
349
  # ],
350
+ # tags: [
351
+ # {
352
+ # key: "tagKey", # required
353
+ # value: "tagValue", # required
354
+ # },
355
+ # ],
343
356
  # })
344
357
  #
345
358
  # @example Response structure
@@ -385,6 +398,7 @@ module Aws::FraudDetector
385
398
  # resp.variables[0].variable_type #=> String
386
399
  # resp.variables[0].last_updated_time #=> String
387
400
  # resp.variables[0].created_time #=> String
401
+ # resp.variables[0].arn #=> String
388
402
  # resp.errors #=> Array
389
403
  # resp.errors[0].name #=> String
390
404
  # resp.errors[0].code #=> Integer
@@ -435,6 +449,9 @@ module Aws::FraudDetector
435
449
  #
436
450
  # The default behavior is `FIRST_MATCHED`.
437
451
  #
452
+ # @option params [Array<Types::Tag>] :tags
453
+ # A collection of key and value pairs.
454
+ #
438
455
  # @return [Types::CreateDetectorVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
439
456
  #
440
457
  # * {Types::CreateDetectorVersionResult#detector_id #detector_id} => String
@@ -451,17 +468,24 @@ module Aws::FraudDetector
451
468
  # {
452
469
  # detector_id: "identifier", # required
453
470
  # rule_id: "identifier", # required
454
- # rule_version: "nonEmptyString", # required
471
+ # rule_version: "wholeNumberVersionString", # required
455
472
  # },
456
473
  # ],
457
474
  # model_versions: [
458
475
  # {
459
- # model_id: "identifier", # required
476
+ # model_id: "modelIdentifier", # required
460
477
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
461
478
  # model_version_number: "nonEmptyString", # required
479
+ # arn: "fraudDetectorArn",
462
480
  # },
463
481
  # ],
464
482
  # rule_execution_mode: "ALL_MATCHED", # accepts ALL_MATCHED, FIRST_MATCHED
483
+ # tags: [
484
+ # {
485
+ # key: "tagKey", # required
486
+ # value: "tagValue", # required
487
+ # },
488
+ # ],
465
489
  # })
466
490
  #
467
491
  # @example Response structure
@@ -479,7 +503,7 @@ module Aws::FraudDetector
479
503
  req.send_request(options)
480
504
  end
481
505
 
482
- # Creates a version of the model using the specified model type.
506
+ # Creates a model using the specified model type.
483
507
  #
484
508
  # @option params [required, String] :model_id
485
509
  # The model ID.
@@ -488,7 +512,61 @@ module Aws::FraudDetector
488
512
  # The model type.
489
513
  #
490
514
  # @option params [String] :description
491
- # The model version description.
515
+ # The model description.
516
+ #
517
+ # @option params [required, String] :event_type_name
518
+ # The name of the event type.
519
+ #
520
+ # @option params [Array<Types::Tag>] :tags
521
+ # A collection of key and value pairs.
522
+ #
523
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
524
+ #
525
+ # @example Request syntax with placeholder values
526
+ #
527
+ # resp = client.create_model({
528
+ # model_id: "modelIdentifier", # required
529
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
530
+ # description: "description",
531
+ # event_type_name: "string", # required
532
+ # tags: [
533
+ # {
534
+ # key: "tagKey", # required
535
+ # value: "tagValue", # required
536
+ # },
537
+ # ],
538
+ # })
539
+ #
540
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateModel AWS API Documentation
541
+ #
542
+ # @overload create_model(params = {})
543
+ # @param [Hash] params ({})
544
+ def create_model(params = {}, options = {})
545
+ req = build_request(:create_model, params)
546
+ req.send_request(options)
547
+ end
548
+
549
+ # Creates a version of the model using the specified model type and
550
+ # model id.
551
+ #
552
+ # @option params [required, String] :model_id
553
+ # The model ID.
554
+ #
555
+ # @option params [required, String] :model_type
556
+ # The model type.
557
+ #
558
+ # @option params [required, String] :training_data_source
559
+ # The training data source location in Amazon S3.
560
+ #
561
+ # @option params [required, Types::TrainingDataSchema] :training_data_schema
562
+ # The training data schema.
563
+ #
564
+ # @option params [Types::ExternalEventsDetail] :external_events_detail
565
+ # Details for the external events data used for model version training.
566
+ # Required if `trainingDataSource` is `EXTERNAL_EVENTS`.
567
+ #
568
+ # @option params [Array<Types::Tag>] :tags
569
+ # A collection of key and value pairs.
492
570
  #
493
571
  # @return [Types::CreateModelVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
494
572
  #
@@ -500,9 +578,27 @@ module Aws::FraudDetector
500
578
  # @example Request syntax with placeholder values
501
579
  #
502
580
  # resp = client.create_model_version({
503
- # model_id: "identifier", # required
581
+ # model_id: "modelIdentifier", # required
504
582
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
505
- # description: "description",
583
+ # training_data_source: "EXTERNAL_EVENTS", # required, accepts EXTERNAL_EVENTS
584
+ # training_data_schema: { # required
585
+ # model_variables: ["string"], # required
586
+ # label_schema: { # required
587
+ # label_mapper: { # required
588
+ # "string" => ["string"],
589
+ # },
590
+ # },
591
+ # },
592
+ # external_events_detail: {
593
+ # data_location: "s3BucketLocation", # required
594
+ # data_access_role_arn: "iamRoleArn", # required
595
+ # },
596
+ # tags: [
597
+ # {
598
+ # key: "tagKey", # required
599
+ # value: "tagValue", # required
600
+ # },
601
+ # ],
506
602
  # })
507
603
  #
508
604
  # @example Response structure
@@ -541,6 +637,9 @@ module Aws::FraudDetector
541
637
  # @option params [required, Array<String>] :outcomes
542
638
  # The outcome or outcomes returned when the rule expression matches.
543
639
  #
640
+ # @option params [Array<Types::Tag>] :tags
641
+ # A collection of key and value pairs.
642
+ #
544
643
  # @return [Types::CreateRuleResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
545
644
  #
546
645
  # * {Types::CreateRuleResult#rule #rule} => Types::Rule
@@ -554,6 +653,12 @@ module Aws::FraudDetector
554
653
  # expression: "ruleExpression", # required
555
654
  # language: "DETECTORPL", # required, accepts DETECTORPL
556
655
  # outcomes: ["string"], # required
656
+ # tags: [
657
+ # {
658
+ # key: "tagKey", # required
659
+ # value: "tagValue", # required
660
+ # },
661
+ # ],
557
662
  # })
558
663
  #
559
664
  # @example Response structure
@@ -589,7 +694,24 @@ module Aws::FraudDetector
589
694
  # The description.
590
695
  #
591
696
  # @option params [String] :variable_type
592
- # The variable type.
697
+ # The variable type. For more information see [Variable types][1].
698
+ #
699
+ # Valid Values: `AUTH_CODE | AVS | BILLING_ADDRESS_L1 |
700
+ # BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME |
701
+ # BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL |
702
+ # CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL |
703
+ # FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE |
704
+ # PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 |
705
+ # SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME
706
+ # | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT |
707
+ # SHIPPING_ZIP | USERAGENT`
708
+ #
709
+ #
710
+ #
711
+ # [1]: https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types
712
+ #
713
+ # @option params [Array<Types::Tag>] :tags
714
+ # A collection of key and value pairs.
593
715
  #
594
716
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
595
717
  #
@@ -602,6 +724,12 @@ module Aws::FraudDetector
602
724
  # default_value: "string", # required
603
725
  # description: "string",
604
726
  # variable_type: "string",
727
+ # tags: [
728
+ # {
729
+ # key: "tagKey", # required
730
+ # value: "tagValue", # required
731
+ # },
732
+ # ],
605
733
  # })
606
734
  #
607
735
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateVariable AWS API Documentation
@@ -652,7 +780,7 @@ module Aws::FraudDetector
652
780
  #
653
781
  # resp = client.delete_detector_version({
654
782
  # detector_id: "identifier", # required
655
- # detector_version_id: "nonEmptyString", # required
783
+ # detector_version_id: "wholeNumberVersionString", # required
656
784
  # })
657
785
  #
658
786
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteDetectorVersion AWS API Documentation
@@ -669,12 +797,16 @@ module Aws::FraudDetector
669
797
  # @option params [required, String] :event_id
670
798
  # The ID of the event to delete.
671
799
  #
800
+ # @option params [required, String] :event_type_name
801
+ # The name of the event type.
802
+ #
672
803
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
673
804
  #
674
805
  # @example Request syntax with placeholder values
675
806
  #
676
807
  # resp = client.delete_event({
677
808
  # event_id: "string", # required
809
+ # event_type_name: "string", # required
678
810
  # })
679
811
  #
680
812
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteEvent AWS API Documentation
@@ -686,34 +818,30 @@ module Aws::FraudDetector
686
818
  req.send_request(options)
687
819
  end
688
820
 
689
- # Deletes the rule version. You cannot delete a rule version if it is
690
- # used by an `ACTIVE` or `INACTIVE` detector version.
691
- #
692
- # @option params [required, String] :detector_id
693
- # The ID of the detector that includes the rule version to delete.
821
+ # Deletes the rule. You cannot delete a rule if it is used by an
822
+ # `ACTIVE` or `INACTIVE` detector version.
694
823
  #
695
- # @option params [required, String] :rule_id
696
- # The rule ID of the rule version to delete.
697
- #
698
- # @option params [required, String] :rule_version
699
- # The rule version to delete.
824
+ # @option params [required, Types::Rule] :rule
825
+ # A rule.
700
826
  #
701
827
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
702
828
  #
703
829
  # @example Request syntax with placeholder values
704
830
  #
705
- # resp = client.delete_rule_version({
706
- # detector_id: "identifier", # required
707
- # rule_id: "identifier", # required
708
- # rule_version: "nonEmptyString", # required
831
+ # resp = client.delete_rule({
832
+ # rule: { # required
833
+ # detector_id: "identifier", # required
834
+ # rule_id: "identifier", # required
835
+ # rule_version: "wholeNumberVersionString", # required
836
+ # },
709
837
  # })
710
838
  #
711
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteRuleVersion AWS API Documentation
839
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteRule AWS API Documentation
712
840
  #
713
- # @overload delete_rule_version(params = {})
841
+ # @overload delete_rule(params = {})
714
842
  # @param [Hash] params ({})
715
- def delete_rule_version(params = {}, options = {})
716
- req = build_request(:delete_rule_version, params)
843
+ def delete_rule(params = {}, options = {})
844
+ req = build_request(:delete_rule, params)
717
845
  req.send_request(options)
718
846
  end
719
847
 
@@ -733,6 +861,7 @@ module Aws::FraudDetector
733
861
  # * {Types::DescribeDetectorResult#detector_id #detector_id} => String
734
862
  # * {Types::DescribeDetectorResult#detector_version_summaries #detector_version_summaries} => Array&lt;Types::DetectorVersionSummary&gt;
735
863
  # * {Types::DescribeDetectorResult#next_token #next_token} => String
864
+ # * {Types::DescribeDetectorResult#arn #arn} => String
736
865
  #
737
866
  # @example Request syntax with placeholder values
738
867
  #
@@ -751,6 +880,7 @@ module Aws::FraudDetector
751
880
  # resp.detector_version_summaries[0].description #=> String
752
881
  # resp.detector_version_summaries[0].last_updated_time #=> String
753
882
  # resp.next_token #=> String
883
+ # resp.arn #=> String
754
884
  #
755
885
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DescribeDetector AWS API Documentation
756
886
  #
@@ -769,7 +899,7 @@ module Aws::FraudDetector
769
899
  # The model ID.
770
900
  #
771
901
  # @option params [String] :model_version_number
772
- # The model version.
902
+ # The model version number.
773
903
  #
774
904
  # @option params [String] :model_type
775
905
  # The model type.
@@ -790,8 +920,8 @@ module Aws::FraudDetector
790
920
  # @example Request syntax with placeholder values
791
921
  #
792
922
  # resp = client.describe_model_versions({
793
- # model_id: "identifier",
794
- # model_version_number: "nonEmptyString",
923
+ # model_id: "modelIdentifier",
924
+ # model_version_number: "floatVersionString",
795
925
  # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
796
926
  # next_token: "string",
797
927
  # max_results: 1,
@@ -803,23 +933,34 @@ module Aws::FraudDetector
803
933
  # resp.model_version_details[0].model_id #=> String
804
934
  # resp.model_version_details[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
805
935
  # resp.model_version_details[0].model_version_number #=> String
806
- # resp.model_version_details[0].description #=> String
807
936
  # resp.model_version_details[0].status #=> String
808
- # resp.model_version_details[0].training_data_source.data_location #=> String
809
- # resp.model_version_details[0].training_data_source.data_access_role_arn #=> String
810
- # resp.model_version_details[0].model_variables #=> Array
811
- # resp.model_version_details[0].model_variables[0].name #=> String
812
- # resp.model_version_details[0].model_variables[0].index #=> Integer
813
- # resp.model_version_details[0].label_schema.label_key #=> String
814
- # resp.model_version_details[0].label_schema.label_mapper #=> Hash
815
- # resp.model_version_details[0].label_schema.label_mapper["string"] #=> Array
816
- # resp.model_version_details[0].label_schema.label_mapper["string"][0] #=> String
817
- # resp.model_version_details[0].validation_metrics #=> Hash
818
- # resp.model_version_details[0].validation_metrics["string"] #=> String
819
- # resp.model_version_details[0].training_metrics #=> Hash
820
- # resp.model_version_details[0].training_metrics["string"] #=> String
937
+ # resp.model_version_details[0].training_data_source #=> String, one of "EXTERNAL_EVENTS"
938
+ # resp.model_version_details[0].training_data_schema.model_variables #=> Array
939
+ # resp.model_version_details[0].training_data_schema.model_variables[0] #=> String
940
+ # resp.model_version_details[0].training_data_schema.label_schema.label_mapper #=> Hash
941
+ # resp.model_version_details[0].training_data_schema.label_schema.label_mapper["string"] #=> Array
942
+ # resp.model_version_details[0].training_data_schema.label_schema.label_mapper["string"][0] #=> String
943
+ # resp.model_version_details[0].external_events_detail.data_location #=> String
944
+ # resp.model_version_details[0].external_events_detail.data_access_role_arn #=> String
945
+ # resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages #=> Array
946
+ # resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages[0].title #=> String
947
+ # resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages[0].content #=> String
948
+ # resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages[0].type #=> String
949
+ # resp.model_version_details[0].training_result.data_validation_metrics.field_level_messages #=> Array
950
+ # resp.model_version_details[0].training_result.data_validation_metrics.field_level_messages[0].field_name #=> String
951
+ # resp.model_version_details[0].training_result.data_validation_metrics.field_level_messages[0].identifier #=> String
952
+ # resp.model_version_details[0].training_result.data_validation_metrics.field_level_messages[0].title #=> String
953
+ # resp.model_version_details[0].training_result.data_validation_metrics.field_level_messages[0].content #=> String
954
+ # resp.model_version_details[0].training_result.data_validation_metrics.field_level_messages[0].type #=> String
955
+ # resp.model_version_details[0].training_result.training_metrics.auc #=> Float
956
+ # resp.model_version_details[0].training_result.training_metrics.metric_data_points #=> Array
957
+ # resp.model_version_details[0].training_result.training_metrics.metric_data_points[0].fpr #=> Float
958
+ # resp.model_version_details[0].training_result.training_metrics.metric_data_points[0].precision #=> Float
959
+ # resp.model_version_details[0].training_result.training_metrics.metric_data_points[0].tpr #=> Float
960
+ # resp.model_version_details[0].training_result.training_metrics.metric_data_points[0].threshold #=> Float
821
961
  # resp.model_version_details[0].last_updated_time #=> String
822
962
  # resp.model_version_details[0].created_time #=> String
963
+ # resp.model_version_details[0].arn #=> String
823
964
  # resp.next_token #=> String
824
965
  #
825
966
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DescribeModelVersions AWS API Documentation
@@ -851,12 +992,13 @@ module Aws::FraudDetector
851
992
  # * {Types::GetDetectorVersionResult#last_updated_time #last_updated_time} => String
852
993
  # * {Types::GetDetectorVersionResult#created_time #created_time} => String
853
994
  # * {Types::GetDetectorVersionResult#rule_execution_mode #rule_execution_mode} => String
995
+ # * {Types::GetDetectorVersionResult#arn #arn} => String
854
996
  #
855
997
  # @example Request syntax with placeholder values
856
998
  #
857
999
  # resp = client.get_detector_version({
858
1000
  # detector_id: "identifier", # required
859
- # detector_version_id: "nonEmptyString", # required
1001
+ # detector_version_id: "wholeNumberVersionString", # required
860
1002
  # })
861
1003
  #
862
1004
  # @example Response structure
@@ -870,6 +1012,7 @@ module Aws::FraudDetector
870
1012
  # resp.model_versions[0].model_id #=> String
871
1013
  # resp.model_versions[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
872
1014
  # resp.model_versions[0].model_version_number #=> String
1015
+ # resp.model_versions[0].arn #=> String
873
1016
  # resp.rules #=> Array
874
1017
  # resp.rules[0].detector_id #=> String
875
1018
  # resp.rules[0].rule_id #=> String
@@ -878,6 +1021,7 @@ module Aws::FraudDetector
878
1021
  # resp.last_updated_time #=> String
879
1022
  # resp.created_time #=> String
880
1023
  # resp.rule_execution_mode #=> String, one of "ALL_MATCHED", "FIRST_MATCHED"
1024
+ # resp.arn #=> String
881
1025
  #
882
1026
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetDetectorVersion AWS API Documentation
883
1027
  #
@@ -888,12 +1032,13 @@ module Aws::FraudDetector
888
1032
  req.send_request(options)
889
1033
  end
890
1034
 
891
- # Gets all of detectors. This is a paginated API. If you provide a null
892
- # `maxSizePerPage`, this actions retrieves a maximum of 10 records per
893
- # page. If you provide a `maxSizePerPage`, the value must be between 5
894
- # and 10. To get the next page results, provide the pagination token
895
- # from the `GetEventTypesResponse` as part of your request. A null
896
- # pagination token fetches the records from the beginning.
1035
+ # Gets all detectors or a single detector if a `detectorId` is
1036
+ # specified. This is a paginated API. If you provide a null
1037
+ # `maxResults`, this action retrieves a maximum of 10 records per page.
1038
+ # If you provide a `maxResults`, the value must be between 5 and 10. To
1039
+ # get the next page results, provide the pagination token from the
1040
+ # `GetDetectorsResponse` as part of your request. A null pagination
1041
+ # token fetches the records from the beginning.
897
1042
  #
898
1043
  # @option params [String] :detector_id
899
1044
  # The detector ID.
@@ -924,8 +1069,10 @@ module Aws::FraudDetector
924
1069
  # resp.detectors #=> Array
925
1070
  # resp.detectors[0].detector_id #=> String
926
1071
  # resp.detectors[0].description #=> String
1072
+ # resp.detectors[0].event_type_name #=> String
927
1073
  # resp.detectors[0].last_updated_time #=> String
928
1074
  # resp.detectors[0].created_time #=> String
1075
+ # resp.detectors[0].arn #=> String
929
1076
  # resp.next_token #=> String
930
1077
  #
931
1078
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetDetectors AWS API Documentation
@@ -937,14 +1084,206 @@ module Aws::FraudDetector
937
1084
  req.send_request(options)
938
1085
  end
939
1086
 
1087
+ # Gets all entity types or a specific entity type if a name is
1088
+ # specified. This is a paginated API. If you provide a null
1089
+ # `maxResults`, this action retrieves a maximum of 10 records per page.
1090
+ # If you provide a `maxResults`, the value must be between 5 and 10. To
1091
+ # get the next page results, provide the pagination token from the
1092
+ # `GetEntityTypesResponse` as part of your request. A null pagination
1093
+ # token fetches the records from the beginning.
1094
+ #
1095
+ # @option params [String] :name
1096
+ # The name.
1097
+ #
1098
+ # @option params [String] :next_token
1099
+ # The next token for the subsequent request.
1100
+ #
1101
+ # @option params [Integer] :max_results
1102
+ # The maximum number of objects to return for the request.
1103
+ #
1104
+ # @return [Types::GetEntityTypesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1105
+ #
1106
+ # * {Types::GetEntityTypesResult#entity_types #entity_types} => Array&lt;Types::EntityType&gt;
1107
+ # * {Types::GetEntityTypesResult#next_token #next_token} => String
1108
+ #
1109
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1110
+ #
1111
+ # @example Request syntax with placeholder values
1112
+ #
1113
+ # resp = client.get_entity_types({
1114
+ # name: "identifier",
1115
+ # next_token: "string",
1116
+ # max_results: 1,
1117
+ # })
1118
+ #
1119
+ # @example Response structure
1120
+ #
1121
+ # resp.entity_types #=> Array
1122
+ # resp.entity_types[0].name #=> String
1123
+ # resp.entity_types[0].description #=> String
1124
+ # resp.entity_types[0].last_updated_time #=> String
1125
+ # resp.entity_types[0].created_time #=> String
1126
+ # resp.entity_types[0].arn #=> String
1127
+ # resp.next_token #=> String
1128
+ #
1129
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEntityTypes AWS API Documentation
1130
+ #
1131
+ # @overload get_entity_types(params = {})
1132
+ # @param [Hash] params ({})
1133
+ def get_entity_types(params = {}, options = {})
1134
+ req = build_request(:get_entity_types, params)
1135
+ req.send_request(options)
1136
+ end
1137
+
1138
+ # Evaluates an event against a detector version. If a version ID is not
1139
+ # provided, the detector’s (`ACTIVE`) version is used.
1140
+ #
1141
+ # @option params [required, String] :detector_id
1142
+ # The detector ID.
1143
+ #
1144
+ # @option params [String] :detector_version_id
1145
+ # The detector version ID.
1146
+ #
1147
+ # @option params [required, String] :event_id
1148
+ # The unique ID used to identify the event.
1149
+ #
1150
+ # @option params [required, String] :event_type_name
1151
+ # The event type associated with the detector specified for the
1152
+ # prediction.
1153
+ #
1154
+ # @option params [required, Array<Types::Entity>] :entities
1155
+ # The entity type (associated with the detector's event type) and
1156
+ # specific entity ID representing who performed the event. If an entity
1157
+ # id is not available, use "UNKNOWN."
1158
+ #
1159
+ # @option params [required, String] :event_timestamp
1160
+ # Timestamp that defines when the event under evaluation occurred.
1161
+ #
1162
+ # @option params [required, Hash<String,String>] :event_variables
1163
+ # Names of the event type's variables you defined in Amazon Fraud
1164
+ # Detector to represent data elements and their corresponding values for
1165
+ # the event you are sending for evaluation.
1166
+ #
1167
+ # @option params [Hash<String,Types::ModelEndpointDataBlob>] :external_model_endpoint_data_blobs
1168
+ # The Amazon SageMaker model endpoint input data blobs.
1169
+ #
1170
+ # @return [Types::GetEventPredictionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1171
+ #
1172
+ # * {Types::GetEventPredictionResult#model_scores #model_scores} => Array&lt;Types::ModelScores&gt;
1173
+ # * {Types::GetEventPredictionResult#rule_results #rule_results} => Array&lt;Types::RuleResult&gt;
1174
+ #
1175
+ # @example Request syntax with placeholder values
1176
+ #
1177
+ # resp = client.get_event_prediction({
1178
+ # detector_id: "string", # required
1179
+ # detector_version_id: "wholeNumberVersionString",
1180
+ # event_id: "string", # required
1181
+ # event_type_name: "string", # required
1182
+ # entities: [ # required
1183
+ # {
1184
+ # entity_type: "string", # required
1185
+ # entity_id: "identifier", # required
1186
+ # },
1187
+ # ],
1188
+ # event_timestamp: "string", # required
1189
+ # event_variables: { # required
1190
+ # "variableName" => "variableValue",
1191
+ # },
1192
+ # external_model_endpoint_data_blobs: {
1193
+ # "string" => {
1194
+ # byte_buffer: "data",
1195
+ # content_type: "contentType",
1196
+ # },
1197
+ # },
1198
+ # })
1199
+ #
1200
+ # @example Response structure
1201
+ #
1202
+ # resp.model_scores #=> Array
1203
+ # resp.model_scores[0].model_version.model_id #=> String
1204
+ # resp.model_scores[0].model_version.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1205
+ # resp.model_scores[0].model_version.model_version_number #=> String
1206
+ # resp.model_scores[0].model_version.arn #=> String
1207
+ # resp.model_scores[0].scores #=> Hash
1208
+ # resp.model_scores[0].scores["string"] #=> Float
1209
+ # resp.rule_results #=> Array
1210
+ # resp.rule_results[0].rule_id #=> String
1211
+ # resp.rule_results[0].outcomes #=> Array
1212
+ # resp.rule_results[0].outcomes[0] #=> String
1213
+ #
1214
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventPrediction AWS API Documentation
1215
+ #
1216
+ # @overload get_event_prediction(params = {})
1217
+ # @param [Hash] params ({})
1218
+ def get_event_prediction(params = {}, options = {})
1219
+ req = build_request(:get_event_prediction, params)
1220
+ req.send_request(options)
1221
+ end
1222
+
1223
+ # Gets all event types or a specific event type if name is provided.
1224
+ # This is a paginated API. If you provide a null `maxResults`, this
1225
+ # action retrieves a maximum of 10 records per page. If you provide a
1226
+ # `maxResults`, the value must be between 5 and 10. To get the next page
1227
+ # results, provide the pagination token from the `GetEventTypesResponse`
1228
+ # as part of your request. A null pagination token fetches the records
1229
+ # from the beginning.
1230
+ #
1231
+ # @option params [String] :name
1232
+ # The name.
1233
+ #
1234
+ # @option params [String] :next_token
1235
+ # The next token for the subsequent request.
1236
+ #
1237
+ # @option params [Integer] :max_results
1238
+ # The maximum number of objects to return for the request.
1239
+ #
1240
+ # @return [Types::GetEventTypesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1241
+ #
1242
+ # * {Types::GetEventTypesResult#event_types #event_types} => Array&lt;Types::EventType&gt;
1243
+ # * {Types::GetEventTypesResult#next_token #next_token} => String
1244
+ #
1245
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1246
+ #
1247
+ # @example Request syntax with placeholder values
1248
+ #
1249
+ # resp = client.get_event_types({
1250
+ # name: "identifier",
1251
+ # next_token: "string",
1252
+ # max_results: 1,
1253
+ # })
1254
+ #
1255
+ # @example Response structure
1256
+ #
1257
+ # resp.event_types #=> Array
1258
+ # resp.event_types[0].name #=> String
1259
+ # resp.event_types[0].description #=> String
1260
+ # resp.event_types[0].event_variables #=> Array
1261
+ # resp.event_types[0].event_variables[0] #=> String
1262
+ # resp.event_types[0].labels #=> Array
1263
+ # resp.event_types[0].labels[0] #=> String
1264
+ # resp.event_types[0].entity_types #=> Array
1265
+ # resp.event_types[0].entity_types[0] #=> String
1266
+ # resp.event_types[0].last_updated_time #=> String
1267
+ # resp.event_types[0].created_time #=> String
1268
+ # resp.event_types[0].arn #=> String
1269
+ # resp.next_token #=> String
1270
+ #
1271
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventTypes AWS API Documentation
1272
+ #
1273
+ # @overload get_event_types(params = {})
1274
+ # @param [Hash] params ({})
1275
+ def get_event_types(params = {}, options = {})
1276
+ req = build_request(:get_event_types, params)
1277
+ req.send_request(options)
1278
+ end
1279
+
940
1280
  # Gets the details for one or more Amazon SageMaker models that have
941
1281
  # been imported into the service. This is a paginated API. If you
942
- # provide a null `maxSizePerPage`, this actions retrieves a maximum of
943
- # 10 records per page. If you provide a `maxSizePerPage`, the value must
944
- # be between 5 and 10. To get the next page results, provide the
945
- # pagination token from the `GetExternalModelsResult` as part of your
946
- # request. A null pagination token fetches the records from the
947
- # beginning.
1282
+ # provide a null `maxResults`, this actions retrieves a maximum of 10
1283
+ # records per page. If you provide a `maxResults`, the value must be
1284
+ # between 5 and 10. To get the next page results, provide the pagination
1285
+ # token from the `GetExternalModelsResult` as part of your request. A
1286
+ # null pagination token fetches the records from the beginning.
948
1287
  #
949
1288
  # @option params [String] :model_endpoint
950
1289
  # The Amazon SageMaker model endpoint.
@@ -975,10 +1314,10 @@ module Aws::FraudDetector
975
1314
  # resp.external_models #=> Array
976
1315
  # resp.external_models[0].model_endpoint #=> String
977
1316
  # resp.external_models[0].model_source #=> String, one of "SAGEMAKER"
978
- # resp.external_models[0].role.arn #=> String
979
- # resp.external_models[0].role.name #=> String
1317
+ # resp.external_models[0].invoke_model_endpoint_role_arn #=> String
1318
+ # resp.external_models[0].input_configuration.event_type_name #=> String
980
1319
  # resp.external_models[0].input_configuration.format #=> String, one of "TEXT_CSV", "APPLICATION_JSON"
981
- # resp.external_models[0].input_configuration.is_opaque #=> Boolean
1320
+ # resp.external_models[0].input_configuration.use_event_variables #=> Boolean
982
1321
  # resp.external_models[0].input_configuration.json_input_template #=> String
983
1322
  # resp.external_models[0].input_configuration.csv_input_template #=> String
984
1323
  # resp.external_models[0].output_configuration.format #=> String, one of "TEXT_CSV", "APPLICATION_JSONLINES"
@@ -989,6 +1328,7 @@ module Aws::FraudDetector
989
1328
  # resp.external_models[0].model_endpoint_status #=> String, one of "ASSOCIATED", "DISSOCIATED"
990
1329
  # resp.external_models[0].last_updated_time #=> String
991
1330
  # resp.external_models[0].created_time #=> String
1331
+ # resp.external_models[0].arn #=> String
992
1332
  # resp.next_token #=> String
993
1333
  #
994
1334
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetExternalModels AWS API Documentation
@@ -1000,7 +1340,79 @@ module Aws::FraudDetector
1000
1340
  req.send_request(options)
1001
1341
  end
1002
1342
 
1003
- # Gets a model version.
1343
+ # Gets the encryption key if a Key Management Service (KMS) customer
1344
+ # master key (CMK) has been specified to be used to encrypt content in
1345
+ # Amazon Fraud Detector.
1346
+ #
1347
+ # @return [Types::GetKMSEncryptionKeyResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1348
+ #
1349
+ # * {Types::GetKMSEncryptionKeyResult#kms_key #kms_key} => Types::KMSKey
1350
+ #
1351
+ # @example Response structure
1352
+ #
1353
+ # resp.kms_key.kms_encryption_key_arn #=> String
1354
+ #
1355
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetKMSEncryptionKey AWS API Documentation
1356
+ #
1357
+ # @overload get_kms_encryption_key(params = {})
1358
+ # @param [Hash] params ({})
1359
+ def get_kms_encryption_key(params = {}, options = {})
1360
+ req = build_request(:get_kms_encryption_key, params)
1361
+ req.send_request(options)
1362
+ end
1363
+
1364
+ # Gets all labels or a specific label if name is provided. This is a
1365
+ # paginated API. If you provide a null `maxResults`, this action
1366
+ # retrieves a maximum of 50 records per page. If you provide a
1367
+ # `maxResults`, the value must be between 10 and 50. To get the next
1368
+ # page results, provide the pagination token from the
1369
+ # `GetGetLabelsResponse` as part of your request. A null pagination
1370
+ # token fetches the records from the beginning.
1371
+ #
1372
+ # @option params [String] :name
1373
+ # The name of the label or labels to get.
1374
+ #
1375
+ # @option params [String] :next_token
1376
+ # The next token for the subsequent request.
1377
+ #
1378
+ # @option params [Integer] :max_results
1379
+ # The maximum number of objects to return for the request.
1380
+ #
1381
+ # @return [Types::GetLabelsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1382
+ #
1383
+ # * {Types::GetLabelsResult#labels #labels} => Array&lt;Types::Label&gt;
1384
+ # * {Types::GetLabelsResult#next_token #next_token} => String
1385
+ #
1386
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1387
+ #
1388
+ # @example Request syntax with placeholder values
1389
+ #
1390
+ # resp = client.get_labels({
1391
+ # name: "identifier",
1392
+ # next_token: "string",
1393
+ # max_results: 1,
1394
+ # })
1395
+ #
1396
+ # @example Response structure
1397
+ #
1398
+ # resp.labels #=> Array
1399
+ # resp.labels[0].name #=> String
1400
+ # resp.labels[0].description #=> String
1401
+ # resp.labels[0].last_updated_time #=> String
1402
+ # resp.labels[0].created_time #=> String
1403
+ # resp.labels[0].arn #=> String
1404
+ # resp.next_token #=> String
1405
+ #
1406
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetLabels AWS API Documentation
1407
+ #
1408
+ # @overload get_labels(params = {})
1409
+ # @param [Hash] params ({})
1410
+ def get_labels(params = {}, options = {})
1411
+ req = build_request(:get_labels, params)
1412
+ req.send_request(options)
1413
+ end
1414
+
1415
+ # Gets the details of the specified model version.
1004
1416
  #
1005
1417
  # @option params [required, String] :model_id
1006
1418
  # The model ID.
@@ -1009,22 +1421,25 @@ module Aws::FraudDetector
1009
1421
  # The model type.
1010
1422
  #
1011
1423
  # @option params [required, String] :model_version_number
1012
- # The model version.
1424
+ # The model version number.
1013
1425
  #
1014
1426
  # @return [Types::GetModelVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1015
1427
  #
1016
1428
  # * {Types::GetModelVersionResult#model_id #model_id} => String
1017
1429
  # * {Types::GetModelVersionResult#model_type #model_type} => String
1018
1430
  # * {Types::GetModelVersionResult#model_version_number #model_version_number} => String
1019
- # * {Types::GetModelVersionResult#description #description} => String
1431
+ # * {Types::GetModelVersionResult#training_data_source #training_data_source} => String
1432
+ # * {Types::GetModelVersionResult#training_data_schema #training_data_schema} => Types::TrainingDataSchema
1433
+ # * {Types::GetModelVersionResult#external_events_detail #external_events_detail} => Types::ExternalEventsDetail
1020
1434
  # * {Types::GetModelVersionResult#status #status} => String
1435
+ # * {Types::GetModelVersionResult#arn #arn} => String
1021
1436
  #
1022
1437
  # @example Request syntax with placeholder values
1023
1438
  #
1024
1439
  # resp = client.get_model_version({
1025
- # model_id: "identifier", # required
1440
+ # model_id: "modelIdentifier", # required
1026
1441
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1027
- # model_version_number: "nonEmptyString", # required
1442
+ # model_version_number: "floatVersionString", # required
1028
1443
  # })
1029
1444
  #
1030
1445
  # @example Response structure
@@ -1032,8 +1447,16 @@ module Aws::FraudDetector
1032
1447
  # resp.model_id #=> String
1033
1448
  # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1034
1449
  # resp.model_version_number #=> String
1035
- # resp.description #=> String
1450
+ # resp.training_data_source #=> String, one of "EXTERNAL_EVENTS"
1451
+ # resp.training_data_schema.model_variables #=> Array
1452
+ # resp.training_data_schema.model_variables[0] #=> String
1453
+ # resp.training_data_schema.label_schema.label_mapper #=> Hash
1454
+ # resp.training_data_schema.label_schema.label_mapper["string"] #=> Array
1455
+ # resp.training_data_schema.label_schema.label_mapper["string"][0] #=> String
1456
+ # resp.external_events_detail.data_location #=> String
1457
+ # resp.external_events_detail.data_access_role_arn #=> String
1036
1458
  # resp.status #=> String
1459
+ # resp.arn #=> String
1037
1460
  #
1038
1461
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModelVersion AWS API Documentation
1039
1462
  #
@@ -1044,21 +1467,30 @@ module Aws::FraudDetector
1044
1467
  req.send_request(options)
1045
1468
  end
1046
1469
 
1047
- # Gets all of the models for the AWS account, or the specified model
1048
- # type, or gets a single model for the specified model type, model ID
1049
- # combination.
1050
- #
1051
- # @option params [String] :model_type
1052
- # The model type.
1470
+ # Gets one or more models. Gets all models for the AWS account if no
1471
+ # model type and no model id provided. Gets all models for the AWS
1472
+ # account and model type, if the model type is specified but model id is
1473
+ # not provided. Gets a specific model if (model type, model id) tuple is
1474
+ # specified.
1475
+ #
1476
+ # This is a paginated API. If you provide a null `maxResults`, this
1477
+ # action retrieves a maximum of 10 records per page. If you provide a
1478
+ # `maxResults`, the value must be between 1 and 10. To get the next page
1479
+ # results, provide the pagination token from the response as part of
1480
+ # your request. A null pagination token fetches the records from the
1481
+ # beginning.
1053
1482
  #
1054
1483
  # @option params [String] :model_id
1055
1484
  # The model ID.
1056
1485
  #
1486
+ # @option params [String] :model_type
1487
+ # The model type.
1488
+ #
1057
1489
  # @option params [String] :next_token
1058
- # The next token for the request.
1490
+ # The next token for the subsequent request.
1059
1491
  #
1060
1492
  # @option params [Integer] :max_results
1061
- # The maximum results to return for the request.
1493
+ # The maximum number of objects to return for the request.
1062
1494
  #
1063
1495
  # @return [Types::GetModelsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1064
1496
  #
@@ -1070,8 +1502,8 @@ module Aws::FraudDetector
1070
1502
  # @example Request syntax with placeholder values
1071
1503
  #
1072
1504
  # resp = client.get_models({
1505
+ # model_id: "modelIdentifier",
1073
1506
  # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
1074
- # model_id: "identifier",
1075
1507
  # next_token: "string",
1076
1508
  # max_results: 1,
1077
1509
  # })
@@ -1083,17 +1515,10 @@ module Aws::FraudDetector
1083
1515
  # resp.models[0].model_id #=> String
1084
1516
  # resp.models[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1085
1517
  # resp.models[0].description #=> String
1086
- # resp.models[0].training_data_source.data_location #=> String
1087
- # resp.models[0].training_data_source.data_access_role_arn #=> String
1088
- # resp.models[0].model_variables #=> Array
1089
- # resp.models[0].model_variables[0].name #=> String
1090
- # resp.models[0].model_variables[0].index #=> Integer
1091
- # resp.models[0].label_schema.label_key #=> String
1092
- # resp.models[0].label_schema.label_mapper #=> Hash
1093
- # resp.models[0].label_schema.label_mapper["string"] #=> Array
1094
- # resp.models[0].label_schema.label_mapper["string"][0] #=> String
1095
- # resp.models[0].last_updated_time #=> String
1518
+ # resp.models[0].event_type_name #=> String
1096
1519
  # resp.models[0].created_time #=> String
1520
+ # resp.models[0].last_updated_time #=> String
1521
+ # resp.models[0].arn #=> String
1097
1522
  #
1098
1523
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModels AWS API Documentation
1099
1524
  #
@@ -1105,11 +1530,11 @@ module Aws::FraudDetector
1105
1530
  end
1106
1531
 
1107
1532
  # Gets one or more outcomes. This is a paginated API. If you provide a
1108
- # null `maxSizePerPage`, this actions retrieves a maximum of 10 records
1109
- # per page. If you provide a `maxSizePerPage`, the value must be between
1110
- # 50 and 100. To get the next page results, provide the pagination token
1111
- # from the `GetOutcomesResult` as part of your request. A null
1112
- # pagination token fetches the records from the beginning.
1533
+ # null `maxResults`, this actions retrieves a maximum of 100 records per
1534
+ # page. If you provide a `maxResults`, the value must be between 50 and
1535
+ # 100. To get the next page results, provide the pagination token from
1536
+ # the `GetOutcomesResult` as part of your request. A null pagination
1537
+ # token fetches the records from the beginning.
1113
1538
  #
1114
1539
  # @option params [String] :name
1115
1540
  # The name of the outcome or outcomes to get.
@@ -1142,6 +1567,7 @@ module Aws::FraudDetector
1142
1567
  # resp.outcomes[0].description #=> String
1143
1568
  # resp.outcomes[0].last_updated_time #=> String
1144
1569
  # resp.outcomes[0].created_time #=> String
1570
+ # resp.outcomes[0].arn #=> String
1145
1571
  # resp.next_token #=> String
1146
1572
  #
1147
1573
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetOutcomes AWS API Documentation
@@ -1153,74 +1579,16 @@ module Aws::FraudDetector
1153
1579
  req.send_request(options)
1154
1580
  end
1155
1581
 
1156
- # Evaluates an event against a detector version. If a version ID is not
1157
- # provided, the detector’s (`ACTIVE`) version is used.
1158
- #
1159
- # @option params [required, String] :detector_id
1160
- # The detector ID.
1161
- #
1162
- # @option params [String] :detector_version_id
1163
- # The detector version ID.
1164
- #
1165
- # @option params [required, String] :event_id
1166
- # The unique ID used to identify the event.
1167
- #
1168
- # @option params [Hash<String,String>] :event_attributes
1169
- # Names of variables you defined in Amazon Fraud Detector to represent
1170
- # event data elements and their corresponding values for the event you
1171
- # are sending for evaluation.
1172
- #
1173
- # @option params [Hash<String,Types::ModelEndpointDataBlob>] :external_model_endpoint_data_blobs
1174
- # The Amazon SageMaker model endpoint input data blobs.
1175
- #
1176
- # @return [Types::GetPredictionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1177
- #
1178
- # * {Types::GetPredictionResult#outcomes #outcomes} => Array&lt;String&gt;
1179
- # * {Types::GetPredictionResult#model_scores #model_scores} => Array&lt;Types::ModelScores&gt;
1180
- # * {Types::GetPredictionResult#rule_results #rule_results} => Array&lt;Types::RuleResult&gt;
1181
- #
1182
- # @example Request syntax with placeholder values
1183
- #
1184
- # resp = client.get_prediction({
1185
- # detector_id: "string", # required
1186
- # detector_version_id: "string",
1187
- # event_id: "string", # required
1188
- # event_attributes: {
1189
- # "attributeKey" => "attributeValue",
1190
- # },
1191
- # external_model_endpoint_data_blobs: {
1192
- # "string" => {
1193
- # byte_buffer: "data",
1194
- # content_type: "contentType",
1195
- # },
1196
- # },
1197
- # })
1198
- #
1199
- # @example Response structure
1200
- #
1201
- # resp.outcomes #=> Array
1202
- # resp.outcomes[0] #=> String
1203
- # resp.model_scores #=> Array
1204
- # resp.model_scores[0].model_version.model_id #=> String
1205
- # resp.model_scores[0].model_version.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1206
- # resp.model_scores[0].model_version.model_version_number #=> String
1207
- # resp.model_scores[0].scores #=> Hash
1208
- # resp.model_scores[0].scores["string"] #=> Float
1209
- # resp.rule_results #=> Array
1210
- # resp.rule_results[0].rule_id #=> String
1211
- # resp.rule_results[0].outcomes #=> Array
1212
- # resp.rule_results[0].outcomes[0] #=> String
1213
- #
1214
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetPrediction AWS API Documentation
1215
- #
1216
- # @overload get_prediction(params = {})
1217
- # @param [Hash] params ({})
1218
- def get_prediction(params = {}, options = {})
1219
- req = build_request(:get_prediction, params)
1220
- req.send_request(options)
1221
- end
1222
-
1223
- # Gets all rules available for the specified detector.
1582
+ # Get all rules for a detector (paginated) if `ruleId` and `ruleVersion`
1583
+ # are not specified. Gets all rules for the detector and the `ruleId` if
1584
+ # present (paginated). Gets a specific rule if both the `ruleId` and the
1585
+ # `ruleVersion` are specified.
1586
+ #
1587
+ # This is a paginated API. Providing null maxResults results in
1588
+ # retrieving maximum of 100 records per page. If you provide maxResults
1589
+ # the value must be between 50 and 100. To get the next page result, a
1590
+ # provide a pagination token from GetRulesResult as part of your
1591
+ # request. Null pagination token fetches the records from the beginning.
1224
1592
  #
1225
1593
  # @option params [String] :rule_id
1226
1594
  # The rule ID.
@@ -1249,7 +1617,7 @@ module Aws::FraudDetector
1249
1617
  # resp = client.get_rules({
1250
1618
  # rule_id: "identifier",
1251
1619
  # detector_id: "identifier", # required
1252
- # rule_version: "nonEmptyString",
1620
+ # rule_version: "wholeNumberVersionString",
1253
1621
  # next_token: "string",
1254
1622
  # max_results: 1,
1255
1623
  # })
@@ -1267,6 +1635,7 @@ module Aws::FraudDetector
1267
1635
  # resp.rule_details[0].outcomes[0] #=> String
1268
1636
  # resp.rule_details[0].last_updated_time #=> String
1269
1637
  # resp.rule_details[0].created_time #=> String
1638
+ # resp.rule_details[0].arn #=> String
1270
1639
  # resp.next_token #=> String
1271
1640
  #
1272
1641
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetRules AWS API Documentation
@@ -1320,6 +1689,7 @@ module Aws::FraudDetector
1320
1689
  # resp.variables[0].variable_type #=> String
1321
1690
  # resp.variables[0].last_updated_time #=> String
1322
1691
  # resp.variables[0].created_time #=> String
1692
+ # resp.variables[0].arn #=> String
1323
1693
  # resp.next_token #=> String
1324
1694
  #
1325
1695
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetVariables AWS API Documentation
@@ -1331,6 +1701,51 @@ module Aws::FraudDetector
1331
1701
  req.send_request(options)
1332
1702
  end
1333
1703
 
1704
+ # Lists all tags associated with the resource. This is a paginated API.
1705
+ # To get the next page results, provide the pagination token from the
1706
+ # response as part of your request. A null pagination token fetches the
1707
+ # records from the beginning.
1708
+ #
1709
+ # @option params [required, String] :resource_arn
1710
+ # The ARN that specifies the resource whose tags you want to list.
1711
+ #
1712
+ # @option params [String] :next_token
1713
+ # The next token from the previous results.
1714
+ #
1715
+ # @option params [Integer] :max_results
1716
+ # The maximum number of objects to return for the request.
1717
+ #
1718
+ # @return [Types::ListTagsForResourceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1719
+ #
1720
+ # * {Types::ListTagsForResourceResult#tags #tags} => Array&lt;Types::Tag&gt;
1721
+ # * {Types::ListTagsForResourceResult#next_token #next_token} => String
1722
+ #
1723
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1724
+ #
1725
+ # @example Request syntax with placeholder values
1726
+ #
1727
+ # resp = client.list_tags_for_resource({
1728
+ # resource_arn: "fraudDetectorArn", # required
1729
+ # next_token: "string",
1730
+ # max_results: 1,
1731
+ # })
1732
+ #
1733
+ # @example Response structure
1734
+ #
1735
+ # resp.tags #=> Array
1736
+ # resp.tags[0].key #=> String
1737
+ # resp.tags[0].value #=> String
1738
+ # resp.next_token #=> String
1739
+ #
1740
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ListTagsForResource AWS API Documentation
1741
+ #
1742
+ # @overload list_tags_for_resource(params = {})
1743
+ # @param [Hash] params ({})
1744
+ def list_tags_for_resource(params = {}, options = {})
1745
+ req = build_request(:list_tags_for_resource, params)
1746
+ req.send_request(options)
1747
+ end
1748
+
1334
1749
  # Creates or updates a detector.
1335
1750
  #
1336
1751
  # @option params [required, String] :detector_id
@@ -1339,6 +1754,12 @@ module Aws::FraudDetector
1339
1754
  # @option params [String] :description
1340
1755
  # The description of the detector.
1341
1756
  #
1757
+ # @option params [required, String] :event_type_name
1758
+ # The name of the event type.
1759
+ #
1760
+ # @option params [Array<Types::Tag>] :tags
1761
+ # A collection of key and value pairs.
1762
+ #
1342
1763
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1343
1764
  #
1344
1765
  # @example Request syntax with placeholder values
@@ -1346,6 +1767,13 @@ module Aws::FraudDetector
1346
1767
  # resp = client.put_detector({
1347
1768
  # detector_id: "identifier", # required
1348
1769
  # description: "description",
1770
+ # event_type_name: "identifier", # required
1771
+ # tags: [
1772
+ # {
1773
+ # key: "tagKey", # required
1774
+ # value: "tagValue", # required
1775
+ # },
1776
+ # ],
1349
1777
  # })
1350
1778
  #
1351
1779
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutDetector AWS API Documentation
@@ -1357,6 +1785,100 @@ module Aws::FraudDetector
1357
1785
  req.send_request(options)
1358
1786
  end
1359
1787
 
1788
+ # Creates or updates an entity type. An entity represents who is
1789
+ # performing the event. As part of a fraud prediction, you pass the
1790
+ # entity ID to indicate the specific entity who performed the event. An
1791
+ # entity type classifies the entity. Example classifications include
1792
+ # customer, merchant, or account.
1793
+ #
1794
+ # @option params [required, String] :name
1795
+ # The name of the entity type.
1796
+ #
1797
+ # @option params [String] :description
1798
+ # The description.
1799
+ #
1800
+ # @option params [Array<Types::Tag>] :tags
1801
+ # A collection of key and value pairs.
1802
+ #
1803
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1804
+ #
1805
+ # @example Request syntax with placeholder values
1806
+ #
1807
+ # resp = client.put_entity_type({
1808
+ # name: "identifier", # required
1809
+ # description: "description",
1810
+ # tags: [
1811
+ # {
1812
+ # key: "tagKey", # required
1813
+ # value: "tagValue", # required
1814
+ # },
1815
+ # ],
1816
+ # })
1817
+ #
1818
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutEntityType AWS API Documentation
1819
+ #
1820
+ # @overload put_entity_type(params = {})
1821
+ # @param [Hash] params ({})
1822
+ def put_entity_type(params = {}, options = {})
1823
+ req = build_request(:put_entity_type, params)
1824
+ req.send_request(options)
1825
+ end
1826
+
1827
+ # Creates or updates an event type. An event is a business activity that
1828
+ # is evaluated for fraud risk. With Amazon Fraud Detector, you generate
1829
+ # fraud predictions for events. An event type defines the structure for
1830
+ # an event sent to Amazon Fraud Detector. This includes the variables
1831
+ # sent as part of the event, the entity performing the event (such as a
1832
+ # customer), and the labels that classify the event. Example event types
1833
+ # include online payment transactions, account registrations, and
1834
+ # authentications.
1835
+ #
1836
+ # @option params [required, String] :name
1837
+ # The name.
1838
+ #
1839
+ # @option params [String] :description
1840
+ # The description of the event type.
1841
+ #
1842
+ # @option params [required, Array<String>] :event_variables
1843
+ # The event type variables.
1844
+ #
1845
+ # @option params [Array<String>] :labels
1846
+ # The event type labels.
1847
+ #
1848
+ # @option params [required, Array<String>] :entity_types
1849
+ # The entity type for the event type. Example entity types: customer,
1850
+ # merchant, account.
1851
+ #
1852
+ # @option params [Array<Types::Tag>] :tags
1853
+ # A collection of key and value pairs.
1854
+ #
1855
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1856
+ #
1857
+ # @example Request syntax with placeholder values
1858
+ #
1859
+ # resp = client.put_event_type({
1860
+ # name: "identifier", # required
1861
+ # description: "description",
1862
+ # event_variables: ["string"], # required
1863
+ # labels: ["string"],
1864
+ # entity_types: ["string"], # required
1865
+ # tags: [
1866
+ # {
1867
+ # key: "tagKey", # required
1868
+ # value: "tagValue", # required
1869
+ # },
1870
+ # ],
1871
+ # })
1872
+ #
1873
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutEventType AWS API Documentation
1874
+ #
1875
+ # @overload put_event_type(params = {})
1876
+ # @param [Hash] params ({})
1877
+ def put_event_type(params = {}, options = {})
1878
+ req = build_request(:put_event_type, params)
1879
+ req.send_request(options)
1880
+ end
1881
+
1360
1882
  # Creates or updates an Amazon SageMaker model endpoint. You can also
1361
1883
  # use this action to update the configuration of the model endpoint,
1362
1884
  # including the IAM role and/or the mapped variables.
@@ -1367,7 +1889,7 @@ module Aws::FraudDetector
1367
1889
  # @option params [required, String] :model_source
1368
1890
  # The source of the model.
1369
1891
  #
1370
- # @option params [required, Types::Role] :role
1892
+ # @option params [required, String] :invoke_model_endpoint_role_arn
1371
1893
  # The IAM role used to invoke the model endpoint.
1372
1894
  #
1373
1895
  # @option params [required, Types::ModelInputConfiguration] :input_configuration
@@ -1379,20 +1901,21 @@ module Aws::FraudDetector
1379
1901
  # @option params [required, String] :model_endpoint_status
1380
1902
  # The model endpoint’s status in Amazon Fraud Detector.
1381
1903
  #
1904
+ # @option params [Array<Types::Tag>] :tags
1905
+ # A collection of key and value pairs.
1906
+ #
1382
1907
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1383
1908
  #
1384
1909
  # @example Request syntax with placeholder values
1385
1910
  #
1386
1911
  # resp = client.put_external_model({
1387
- # model_endpoint: "string", # required
1912
+ # model_endpoint: "sageMakerEndpointIdentifier", # required
1388
1913
  # model_source: "SAGEMAKER", # required, accepts SAGEMAKER
1389
- # role: { # required
1390
- # arn: "string", # required
1391
- # name: "string", # required
1392
- # },
1914
+ # invoke_model_endpoint_role_arn: "string", # required
1393
1915
  # input_configuration: { # required
1916
+ # event_type_name: "identifier",
1394
1917
  # format: "TEXT_CSV", # accepts TEXT_CSV, APPLICATION_JSON
1395
- # is_opaque: false, # required
1918
+ # use_event_variables: false, # required
1396
1919
  # json_input_template: "string",
1397
1920
  # csv_input_template: "string",
1398
1921
  # },
@@ -1406,6 +1929,12 @@ module Aws::FraudDetector
1406
1929
  # },
1407
1930
  # },
1408
1931
  # model_endpoint_status: "ASSOCIATED", # required, accepts ASSOCIATED, DISSOCIATED
1932
+ # tags: [
1933
+ # {
1934
+ # key: "tagKey", # required
1935
+ # value: "tagValue", # required
1936
+ # },
1937
+ # ],
1409
1938
  # })
1410
1939
  #
1411
1940
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutExternalModel AWS API Documentation
@@ -1417,58 +1946,62 @@ module Aws::FraudDetector
1417
1946
  req.send_request(options)
1418
1947
  end
1419
1948
 
1420
- # Creates or updates a model.
1949
+ # Specifies the Key Management Service (KMS) customer master key (CMK)
1950
+ # to be used to encrypt content in Amazon Fraud Detector.
1421
1951
  #
1422
- # @option params [required, String] :model_id
1423
- # The model ID.
1952
+ # @option params [required, String] :kms_encryption_key_arn
1953
+ # The KMS encryption key ARN.
1424
1954
  #
1425
- # @option params [required, String] :model_type
1426
- # The model type.
1955
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1427
1956
  #
1428
- # @option params [String] :description
1429
- # The model description.
1957
+ # @example Request syntax with placeholder values
1430
1958
  #
1431
- # @option params [required, Types::TrainingDataSource] :training_data_source
1432
- # The training data source location in Amazon S3.
1959
+ # resp = client.put_kms_encryption_key({
1960
+ # kms_encryption_key_arn: "KmsEncryptionKeyArn", # required
1961
+ # })
1962
+ #
1963
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutKMSEncryptionKey AWS API Documentation
1964
+ #
1965
+ # @overload put_kms_encryption_key(params = {})
1966
+ # @param [Hash] params ({})
1967
+ def put_kms_encryption_key(params = {}, options = {})
1968
+ req = build_request(:put_kms_encryption_key, params)
1969
+ req.send_request(options)
1970
+ end
1971
+
1972
+ # Creates or updates label. A label classifies an event as fraudulent or
1973
+ # legitimate. Labels are associated with event types and used to train
1974
+ # supervised machine learning models in Amazon Fraud Detector.
1975
+ #
1976
+ # @option params [required, String] :name
1977
+ # The label name.
1433
1978
  #
1434
- # @option params [required, Array<Types::ModelVariable>] :model_variables
1435
- # The model input variables.
1979
+ # @option params [String] :description
1980
+ # The label description.
1436
1981
  #
1437
- # @option params [required, Types::LabelSchema] :label_schema
1438
- # The label schema.
1982
+ # @option params [Array<Types::Tag>] :tags
1439
1983
  #
1440
1984
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1441
1985
  #
1442
1986
  # @example Request syntax with placeholder values
1443
1987
  #
1444
- # resp = client.put_model({
1445
- # model_id: "identifier", # required
1446
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1988
+ # resp = client.put_label({
1989
+ # name: "identifier", # required
1447
1990
  # description: "description",
1448
- # training_data_source: { # required
1449
- # data_location: "s3BucketLocation", # required
1450
- # data_access_role_arn: "iamRoleArn", # required
1451
- # },
1452
- # model_variables: [ # required
1991
+ # tags: [
1453
1992
  # {
1454
- # name: "string", # required
1455
- # index: 1,
1993
+ # key: "tagKey", # required
1994
+ # value: "tagValue", # required
1456
1995
  # },
1457
1996
  # ],
1458
- # label_schema: { # required
1459
- # label_key: "string", # required
1460
- # label_mapper: { # required
1461
- # "string" => ["string"],
1462
- # },
1463
- # },
1464
1997
  # })
1465
1998
  #
1466
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutModel AWS API Documentation
1999
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutLabel AWS API Documentation
1467
2000
  #
1468
- # @overload put_model(params = {})
2001
+ # @overload put_label(params = {})
1469
2002
  # @param [Hash] params ({})
1470
- def put_model(params = {}, options = {})
1471
- req = build_request(:put_model, params)
2003
+ def put_label(params = {}, options = {})
2004
+ req = build_request(:put_label, params)
1472
2005
  req.send_request(options)
1473
2006
  end
1474
2007
 
@@ -1480,6 +2013,9 @@ module Aws::FraudDetector
1480
2013
  # @option params [String] :description
1481
2014
  # The outcome description.
1482
2015
  #
2016
+ # @option params [Array<Types::Tag>] :tags
2017
+ # A collection of key and value pairs.
2018
+ #
1483
2019
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1484
2020
  #
1485
2021
  # @example Request syntax with placeholder values
@@ -1487,6 +2023,12 @@ module Aws::FraudDetector
1487
2023
  # resp = client.put_outcome({
1488
2024
  # name: "identifier", # required
1489
2025
  # description: "description",
2026
+ # tags: [
2027
+ # {
2028
+ # key: "tagKey", # required
2029
+ # value: "tagValue", # required
2030
+ # },
2031
+ # ],
1490
2032
  # })
1491
2033
  #
1492
2034
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutOutcome AWS API Documentation
@@ -1498,9 +2040,67 @@ module Aws::FraudDetector
1498
2040
  req.send_request(options)
1499
2041
  end
1500
2042
 
2043
+ # Assigns tags to a resource.
2044
+ #
2045
+ # @option params [required, String] :resource_arn
2046
+ # The resource ARN.
2047
+ #
2048
+ # @option params [required, Array<Types::Tag>] :tags
2049
+ # The tags to assign to the resource.
2050
+ #
2051
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2052
+ #
2053
+ # @example Request syntax with placeholder values
2054
+ #
2055
+ # resp = client.tag_resource({
2056
+ # resource_arn: "fraudDetectorArn", # required
2057
+ # tags: [ # required
2058
+ # {
2059
+ # key: "tagKey", # required
2060
+ # value: "tagValue", # required
2061
+ # },
2062
+ # ],
2063
+ # })
2064
+ #
2065
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/TagResource AWS API Documentation
2066
+ #
2067
+ # @overload tag_resource(params = {})
2068
+ # @param [Hash] params ({})
2069
+ def tag_resource(params = {}, options = {})
2070
+ req = build_request(:tag_resource, params)
2071
+ req.send_request(options)
2072
+ end
2073
+
2074
+ # Removes tags from a resource.
2075
+ #
2076
+ # @option params [required, String] :resource_arn
2077
+ # The ARN of the resource from which to remove the tag.
2078
+ #
2079
+ # @option params [required, Array<String>] :tag_keys
2080
+ # The resource ARN.
2081
+ #
2082
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2083
+ #
2084
+ # @example Request syntax with placeholder values
2085
+ #
2086
+ # resp = client.untag_resource({
2087
+ # resource_arn: "fraudDetectorArn", # required
2088
+ # tag_keys: ["tagKey"], # required
2089
+ # })
2090
+ #
2091
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UntagResource AWS API Documentation
2092
+ #
2093
+ # @overload untag_resource(params = {})
2094
+ # @param [Hash] params ({})
2095
+ def untag_resource(params = {}, options = {})
2096
+ req = build_request(:untag_resource, params)
2097
+ req.send_request(options)
2098
+ end
2099
+
1501
2100
  # Updates a detector version. The detector version attributes that you
1502
- # can update include models, external model endpoints, rules, and
1503
- # description. You can only update a `DRAFT` detector version.
2101
+ # can update include models, external model endpoints, rules, rule
2102
+ # execution mode, and description. You can only update a `DRAFT`
2103
+ # detector version.
1504
2104
  #
1505
2105
  # @option params [required, String] :detector_id
1506
2106
  # The parent detector ID for the detector version you want to update.
@@ -1542,21 +2142,22 @@ module Aws::FraudDetector
1542
2142
  #
1543
2143
  # resp = client.update_detector_version({
1544
2144
  # detector_id: "identifier", # required
1545
- # detector_version_id: "nonEmptyString", # required
2145
+ # detector_version_id: "wholeNumberVersionString", # required
1546
2146
  # external_model_endpoints: ["string"], # required
1547
2147
  # rules: [ # required
1548
2148
  # {
1549
2149
  # detector_id: "identifier", # required
1550
2150
  # rule_id: "identifier", # required
1551
- # rule_version: "nonEmptyString", # required
2151
+ # rule_version: "wholeNumberVersionString", # required
1552
2152
  # },
1553
2153
  # ],
1554
2154
  # description: "description",
1555
2155
  # model_versions: [
1556
2156
  # {
1557
- # model_id: "identifier", # required
2157
+ # model_id: "modelIdentifier", # required
1558
2158
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1559
2159
  # model_version_number: "nonEmptyString", # required
2160
+ # arn: "fraudDetectorArn",
1560
2161
  # },
1561
2162
  # ],
1562
2163
  # rule_execution_mode: "ALL_MATCHED", # accepts ALL_MATCHED, FIRST_MATCHED
@@ -1589,7 +2190,7 @@ module Aws::FraudDetector
1589
2190
  #
1590
2191
  # resp = client.update_detector_version_metadata({
1591
2192
  # detector_id: "identifier", # required
1592
- # detector_version_id: "nonEmptyString", # required
2193
+ # detector_version_id: "wholeNumberVersionString", # required
1593
2194
  # description: "description", # required
1594
2195
  # })
1595
2196
  #
@@ -1621,7 +2222,7 @@ module Aws::FraudDetector
1621
2222
  #
1622
2223
  # resp = client.update_detector_version_status({
1623
2224
  # detector_id: "identifier", # required
1624
- # detector_version_id: "nonEmptyString", # required
2225
+ # detector_version_id: "wholeNumberVersionString", # required
1625
2226
  # status: "DRAFT", # required, accepts DRAFT, ACTIVE, INACTIVE
1626
2227
  # })
1627
2228
  #
@@ -1634,13 +2235,43 @@ module Aws::FraudDetector
1634
2235
  req.send_request(options)
1635
2236
  end
1636
2237
 
1637
- # Updates a model version. You can update the description and status
1638
- # attributes using this action. You can perform the following status
1639
- # updates:
2238
+ # Updates a model. You can update the description attribute using this
2239
+ # action.
2240
+ #
2241
+ # @option params [required, String] :model_id
2242
+ # The model ID.
2243
+ #
2244
+ # @option params [required, String] :model_type
2245
+ # The model type.
1640
2246
  #
1641
- # 1. Change the `TRAINING_COMPLETE` status to `ACTIVE`
2247
+ # @option params [String] :description
2248
+ # The new model description.
1642
2249
  #
1643
- # 2. Change `ACTIVE` back to `TRAINING_COMPLETE`
2250
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2251
+ #
2252
+ # @example Request syntax with placeholder values
2253
+ #
2254
+ # resp = client.update_model({
2255
+ # model_id: "modelIdentifier", # required
2256
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
2257
+ # description: "description",
2258
+ # })
2259
+ #
2260
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModel AWS API Documentation
2261
+ #
2262
+ # @overload update_model(params = {})
2263
+ # @param [Hash] params ({})
2264
+ def update_model(params = {}, options = {})
2265
+ req = build_request(:update_model, params)
2266
+ req.send_request(options)
2267
+ end
2268
+
2269
+ # Updates a model version. Updating a model version retrains an existing
2270
+ # model version using updated training data and produces a new minor
2271
+ # version of the model. You can update the training data set location
2272
+ # and data access role attributes using this action. This action creates
2273
+ # and trains a new minor version of the model, for example version 1.01,
2274
+ # 1.02, 1.03.
1644
2275
  #
1645
2276
  # @option params [required, String] :model_id
1646
2277
  # The model ID.
@@ -1648,27 +2279,47 @@ module Aws::FraudDetector
1648
2279
  # @option params [required, String] :model_type
1649
2280
  # The model type.
1650
2281
  #
1651
- # @option params [required, String] :model_version_number
1652
- # The model version.
2282
+ # @option params [required, String] :major_version_number
2283
+ # The major version number.
1653
2284
  #
1654
- # @option params [required, String] :description
1655
- # The model description.
2285
+ # @option params [Types::ExternalEventsDetail] :external_events_detail
2286
+ # The event details.
1656
2287
  #
1657
- # @option params [required, String] :status
1658
- # The new model status.
2288
+ # @option params [Array<Types::Tag>] :tags
2289
+ # A collection of key and value pairs.
1659
2290
  #
1660
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2291
+ # @return [Types::UpdateModelVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2292
+ #
2293
+ # * {Types::UpdateModelVersionResult#model_id #model_id} => String
2294
+ # * {Types::UpdateModelVersionResult#model_type #model_type} => String
2295
+ # * {Types::UpdateModelVersionResult#model_version_number #model_version_number} => String
2296
+ # * {Types::UpdateModelVersionResult#status #status} => String
1661
2297
  #
1662
2298
  # @example Request syntax with placeholder values
1663
2299
  #
1664
2300
  # resp = client.update_model_version({
1665
- # model_id: "identifier", # required
2301
+ # model_id: "modelIdentifier", # required
1666
2302
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1667
- # model_version_number: "nonEmptyString", # required
1668
- # description: "description", # required
1669
- # status: "TRAINING_IN_PROGRESS", # required, accepts TRAINING_IN_PROGRESS, TRAINING_COMPLETE, ACTIVATE_REQUESTED, ACTIVATE_IN_PROGRESS, ACTIVE, INACTIVATE_IN_PROGRESS, INACTIVE, ERROR
2303
+ # major_version_number: "wholeNumberVersionString", # required
2304
+ # external_events_detail: {
2305
+ # data_location: "s3BucketLocation", # required
2306
+ # data_access_role_arn: "iamRoleArn", # required
2307
+ # },
2308
+ # tags: [
2309
+ # {
2310
+ # key: "tagKey", # required
2311
+ # value: "tagValue", # required
2312
+ # },
2313
+ # ],
1670
2314
  # })
1671
2315
  #
2316
+ # @example Response structure
2317
+ #
2318
+ # resp.model_id #=> String
2319
+ # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
2320
+ # resp.model_version_number #=> String
2321
+ # resp.status #=> String
2322
+ #
1672
2323
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelVersion AWS API Documentation
1673
2324
  #
1674
2325
  # @overload update_model_version(params = {})
@@ -1678,7 +2329,47 @@ module Aws::FraudDetector
1678
2329
  req.send_request(options)
1679
2330
  end
1680
2331
 
1681
- # Updates a rule's metadata.
2332
+ # Updates the status of a model version.
2333
+ #
2334
+ # You can perform the following status updates:
2335
+ #
2336
+ # 1. Change the `TRAINING_COMPLETE` status to `ACTIVE`.
2337
+ #
2338
+ # 2. Change `ACTIVE`to `INACTIVE`.
2339
+ #
2340
+ # @option params [required, String] :model_id
2341
+ # The model ID of the model version to update.
2342
+ #
2343
+ # @option params [required, String] :model_type
2344
+ # The model type.
2345
+ #
2346
+ # @option params [required, String] :model_version_number
2347
+ # The model version number.
2348
+ #
2349
+ # @option params [required, String] :status
2350
+ # The model version status.
2351
+ #
2352
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2353
+ #
2354
+ # @example Request syntax with placeholder values
2355
+ #
2356
+ # resp = client.update_model_version_status({
2357
+ # model_id: "modelIdentifier", # required
2358
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
2359
+ # model_version_number: "floatVersionString", # required
2360
+ # status: "ACTIVE", # required, accepts ACTIVE, INACTIVE
2361
+ # })
2362
+ #
2363
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelVersionStatus AWS API Documentation
2364
+ #
2365
+ # @overload update_model_version_status(params = {})
2366
+ # @param [Hash] params ({})
2367
+ def update_model_version_status(params = {}, options = {})
2368
+ req = build_request(:update_model_version_status, params)
2369
+ req.send_request(options)
2370
+ end
2371
+
2372
+ # Updates a rule's metadata. The description attribute can be updated.
1682
2373
  #
1683
2374
  # @option params [required, Types::Rule] :rule
1684
2375
  # The rule to update.
@@ -1694,7 +2385,7 @@ module Aws::FraudDetector
1694
2385
  # rule: { # required
1695
2386
  # detector_id: "identifier", # required
1696
2387
  # rule_id: "identifier", # required
1697
- # rule_version: "nonEmptyString", # required
2388
+ # rule_version: "wholeNumberVersionString", # required
1698
2389
  # },
1699
2390
  # description: "description", # required
1700
2391
  # })
@@ -1708,7 +2399,8 @@ module Aws::FraudDetector
1708
2399
  req.send_request(options)
1709
2400
  end
1710
2401
 
1711
- # Updates a rule version resulting in a new rule version.
2402
+ # Updates a rule version resulting in a new rule version. Updates a rule
2403
+ # version resulting in a new rule version (version 1, 2, 3 ...).
1712
2404
  #
1713
2405
  # @option params [required, Types::Rule] :rule
1714
2406
  # The rule to update.
@@ -1725,6 +2417,9 @@ module Aws::FraudDetector
1725
2417
  # @option params [required, Array<String>] :outcomes
1726
2418
  # The outcomes.
1727
2419
  #
2420
+ # @option params [Array<Types::Tag>] :tags
2421
+ # The tags to assign to the rule version.
2422
+ #
1728
2423
  # @return [Types::UpdateRuleVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1729
2424
  #
1730
2425
  # * {Types::UpdateRuleVersionResult#rule #rule} => Types::Rule
@@ -1735,12 +2430,18 @@ module Aws::FraudDetector
1735
2430
  # rule: { # required
1736
2431
  # detector_id: "identifier", # required
1737
2432
  # rule_id: "identifier", # required
1738
- # rule_version: "nonEmptyString", # required
2433
+ # rule_version: "wholeNumberVersionString", # required
1739
2434
  # },
1740
2435
  # description: "description",
1741
2436
  # expression: "ruleExpression", # required
1742
2437
  # language: "DETECTORPL", # required, accepts DETECTORPL
1743
2438
  # outcomes: ["string"], # required
2439
+ # tags: [
2440
+ # {
2441
+ # key: "tagKey", # required
2442
+ # value: "tagValue", # required
2443
+ # },
2444
+ # ],
1744
2445
  # })
1745
2446
  #
1746
2447
  # @example Response structure
@@ -1770,7 +2471,11 @@ module Aws::FraudDetector
1770
2471
  # The new description.
1771
2472
  #
1772
2473
  # @option params [String] :variable_type
1773
- # The variable type.
2474
+ # The variable type. For more information see [Variable types][1].
2475
+ #
2476
+ #
2477
+ #
2478
+ # [1]: https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types
1774
2479
  #
1775
2480
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1776
2481
  #
@@ -1805,7 +2510,7 @@ module Aws::FraudDetector
1805
2510
  params: params,
1806
2511
  config: config)
1807
2512
  context[:gem_name] = 'aws-sdk-frauddetector'
1808
- context[:gem_version] = '1.4.0'
2513
+ context[:gem_version] = '1.9.0'
1809
2514
  Seahorse::Client::Request.new(handlers, context)
1810
2515
  end
1811
2516