aws-sdk-frauddetector 1.6.0 → 1.7.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: '0409a68fccb6dbf5d58fe22f2d7b29aca40c7044d9c2328ba8b8072cda7cba23'
4
- data.tar.gz: 86fbd876d12219877f9472bbcee5b3d47b061dbaaeac5353d3cd17173c7e1ce5
3
+ metadata.gz: 20d60bb016ec4cef84878c1c235b594250898170cd22524f9a580d473efa0f35
4
+ data.tar.gz: 4f6d0fe162520dcc84c0c56fe89251c51713f8cd7431056e3dde9dbf8599c14d
5
5
  SHA512:
6
- metadata.gz: 4a0db12e0b84ba5ca80e74bb3ce20377fdcb7ee5a539cd1c1a30e3d91f83020142a030ce30beeeecd09dc004f45b465c5f144d2591ee9b2a253a87f632e97e8c
7
- data.tar.gz: c03c2d6044ce8f71ef053621abd9bf683f307ac3359f42fe68e30b23f8373eec4c193f243b3bf1ec82624a2f3dbb7a3f4ad8ad47326297df99d7024214536780
6
+ metadata.gz: 6378bb27bf483ef0d0e3de3e7f30b793f0c579d5a50ce094e2e401c5afb73770d0e2b8df27f54b695dae3b6f4bdd22f551c3c98eccfb6b30309b1f363111f409
7
+ data.tar.gz: dd75d3c92129e984a3b8ebd0957d7c863b7aacb0163cf78107727ed5b71ee608107dfde435400757490aa17afd76be4e29d595f753cabb9d443d406a89be8f3e
@@ -47,6 +47,6 @@ require_relative 'aws-sdk-frauddetector/customizations'
47
47
  # @service
48
48
  module Aws::FraudDetector
49
49
 
50
- GEM_VERSION = '1.6.0'
50
+ GEM_VERSION = '1.7.0'
51
51
 
52
52
  end
@@ -327,6 +327,9 @@ module Aws::FraudDetector
327
327
  # @option params [required, Array<Types::VariableEntry>] :variable_entries
328
328
  # The list of variables for the batch create variable request.
329
329
  #
330
+ # @option params [Array<Types::Tag>] :tags
331
+ # A collection of key and value pairs.
332
+ #
330
333
  # @return [Types::BatchCreateVariableResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
331
334
  #
332
335
  # * {Types::BatchCreateVariableResult#errors #errors} => Array&lt;Types::BatchCreateVariableError&gt;
@@ -344,6 +347,12 @@ module Aws::FraudDetector
344
347
  # variable_type: "string",
345
348
  # },
346
349
  # ],
350
+ # tags: [
351
+ # {
352
+ # key: "tagKey", # required
353
+ # value: "tagValue", # required
354
+ # },
355
+ # ],
347
356
  # })
348
357
  #
349
358
  # @example Response structure
@@ -389,6 +398,7 @@ module Aws::FraudDetector
389
398
  # resp.variables[0].variable_type #=> String
390
399
  # resp.variables[0].last_updated_time #=> String
391
400
  # resp.variables[0].created_time #=> String
401
+ # resp.variables[0].arn #=> String
392
402
  # resp.errors #=> Array
393
403
  # resp.errors[0].name #=> String
394
404
  # resp.errors[0].code #=> Integer
@@ -439,6 +449,9 @@ module Aws::FraudDetector
439
449
  #
440
450
  # The default behavior is `FIRST_MATCHED`.
441
451
  #
452
+ # @option params [Array<Types::Tag>] :tags
453
+ # A collection of key and value pairs.
454
+ #
442
455
  # @return [Types::CreateDetectorVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
443
456
  #
444
457
  # * {Types::CreateDetectorVersionResult#detector_id #detector_id} => String
@@ -455,7 +468,7 @@ module Aws::FraudDetector
455
468
  # {
456
469
  # detector_id: "identifier", # required
457
470
  # rule_id: "identifier", # required
458
- # rule_version: "nonEmptyString", # required
471
+ # rule_version: "wholeNumberVersionString", # required
459
472
  # },
460
473
  # ],
461
474
  # model_versions: [
@@ -463,9 +476,16 @@ module Aws::FraudDetector
463
476
  # model_id: "identifier", # required
464
477
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
465
478
  # model_version_number: "nonEmptyString", # required
479
+ # arn: "fraudDetectorArn",
466
480
  # },
467
481
  # ],
468
482
  # rule_execution_mode: "ALL_MATCHED", # accepts ALL_MATCHED, FIRST_MATCHED
483
+ # tags: [
484
+ # {
485
+ # key: "tagKey", # required
486
+ # value: "tagValue", # required
487
+ # },
488
+ # ],
469
489
  # })
470
490
  #
471
491
  # @example Response structure
@@ -483,7 +503,7 @@ module Aws::FraudDetector
483
503
  req.send_request(options)
484
504
  end
485
505
 
486
- # Creates a version of the model using the specified model type.
506
+ # Creates a model using the specified model type.
487
507
  #
488
508
  # @option params [required, String] :model_id
489
509
  # The model ID.
@@ -492,7 +512,61 @@ module Aws::FraudDetector
492
512
  # The model type.
493
513
  #
494
514
  # @option params [String] :description
495
- # 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: "identifier", # 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.
496
570
  #
497
571
  # @return [Types::CreateModelVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
498
572
  #
@@ -506,7 +580,25 @@ module Aws::FraudDetector
506
580
  # resp = client.create_model_version({
507
581
  # model_id: "identifier", # required
508
582
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
509
- # 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
+ # ],
510
602
  # })
511
603
  #
512
604
  # @example Response structure
@@ -545,6 +637,9 @@ module Aws::FraudDetector
545
637
  # @option params [required, Array<String>] :outcomes
546
638
  # The outcome or outcomes returned when the rule expression matches.
547
639
  #
640
+ # @option params [Array<Types::Tag>] :tags
641
+ # A collection of key and value pairs.
642
+ #
548
643
  # @return [Types::CreateRuleResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
549
644
  #
550
645
  # * {Types::CreateRuleResult#rule #rule} => Types::Rule
@@ -558,6 +653,12 @@ module Aws::FraudDetector
558
653
  # expression: "ruleExpression", # required
559
654
  # language: "DETECTORPL", # required, accepts DETECTORPL
560
655
  # outcomes: ["string"], # required
656
+ # tags: [
657
+ # {
658
+ # key: "tagKey", # required
659
+ # value: "tagValue", # required
660
+ # },
661
+ # ],
561
662
  # })
562
663
  #
563
664
  # @example Response structure
@@ -595,6 +696,19 @@ module Aws::FraudDetector
595
696
  # @option params [String] :variable_type
596
697
  # The variable type.
597
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
+ # @option params [Array<Types::Tag>] :tags
710
+ # A collection of key and value pairs.
711
+ #
598
712
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
599
713
  #
600
714
  # @example Request syntax with placeholder values
@@ -606,6 +720,12 @@ module Aws::FraudDetector
606
720
  # default_value: "string", # required
607
721
  # description: "string",
608
722
  # variable_type: "string",
723
+ # tags: [
724
+ # {
725
+ # key: "tagKey", # required
726
+ # value: "tagValue", # required
727
+ # },
728
+ # ],
609
729
  # })
610
730
  #
611
731
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateVariable AWS API Documentation
@@ -656,7 +776,7 @@ module Aws::FraudDetector
656
776
  #
657
777
  # resp = client.delete_detector_version({
658
778
  # detector_id: "identifier", # required
659
- # detector_version_id: "nonEmptyString", # required
779
+ # detector_version_id: "wholeNumberVersionString", # required
660
780
  # })
661
781
  #
662
782
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteDetectorVersion AWS API Documentation
@@ -673,12 +793,16 @@ module Aws::FraudDetector
673
793
  # @option params [required, String] :event_id
674
794
  # The ID of the event to delete.
675
795
  #
796
+ # @option params [required, String] :event_type_name
797
+ # The name of the event type.
798
+ #
676
799
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
677
800
  #
678
801
  # @example Request syntax with placeholder values
679
802
  #
680
803
  # resp = client.delete_event({
681
804
  # event_id: "string", # required
805
+ # event_type_name: "string", # required
682
806
  # })
683
807
  #
684
808
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteEvent AWS API Documentation
@@ -690,34 +814,30 @@ module Aws::FraudDetector
690
814
  req.send_request(options)
691
815
  end
692
816
 
693
- # Deletes the rule version. You cannot delete a rule version if it is
694
- # used by an `ACTIVE` or `INACTIVE` detector version.
695
- #
696
- # @option params [required, String] :detector_id
697
- # The ID of the detector that includes the rule version to delete.
698
- #
699
- # @option params [required, String] :rule_id
700
- # The rule ID of the rule version to delete.
817
+ # Deletes the rule. You cannot delete a rule if it is used by an
818
+ # `ACTIVE` or `INACTIVE` detector version.
701
819
  #
702
- # @option params [required, String] :rule_version
703
- # The rule version to delete.
820
+ # @option params [required, Types::Rule] :rule
821
+ # A rule.
704
822
  #
705
823
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
706
824
  #
707
825
  # @example Request syntax with placeholder values
708
826
  #
709
- # resp = client.delete_rule_version({
710
- # detector_id: "identifier", # required
711
- # rule_id: "identifier", # required
712
- # rule_version: "nonEmptyString", # required
827
+ # resp = client.delete_rule({
828
+ # rule: { # required
829
+ # detector_id: "identifier", # required
830
+ # rule_id: "identifier", # required
831
+ # rule_version: "wholeNumberVersionString", # required
832
+ # },
713
833
  # })
714
834
  #
715
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteRuleVersion AWS API Documentation
835
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteRule AWS API Documentation
716
836
  #
717
- # @overload delete_rule_version(params = {})
837
+ # @overload delete_rule(params = {})
718
838
  # @param [Hash] params ({})
719
- def delete_rule_version(params = {}, options = {})
720
- req = build_request(:delete_rule_version, params)
839
+ def delete_rule(params = {}, options = {})
840
+ req = build_request(:delete_rule, params)
721
841
  req.send_request(options)
722
842
  end
723
843
 
@@ -737,6 +857,7 @@ module Aws::FraudDetector
737
857
  # * {Types::DescribeDetectorResult#detector_id #detector_id} => String
738
858
  # * {Types::DescribeDetectorResult#detector_version_summaries #detector_version_summaries} => Array&lt;Types::DetectorVersionSummary&gt;
739
859
  # * {Types::DescribeDetectorResult#next_token #next_token} => String
860
+ # * {Types::DescribeDetectorResult#arn #arn} => String
740
861
  #
741
862
  # @example Request syntax with placeholder values
742
863
  #
@@ -755,6 +876,7 @@ module Aws::FraudDetector
755
876
  # resp.detector_version_summaries[0].description #=> String
756
877
  # resp.detector_version_summaries[0].last_updated_time #=> String
757
878
  # resp.next_token #=> String
879
+ # resp.arn #=> String
758
880
  #
759
881
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DescribeDetector AWS API Documentation
760
882
  #
@@ -773,7 +895,7 @@ module Aws::FraudDetector
773
895
  # The model ID.
774
896
  #
775
897
  # @option params [String] :model_version_number
776
- # The model version.
898
+ # The model version number.
777
899
  #
778
900
  # @option params [String] :model_type
779
901
  # The model type.
@@ -795,7 +917,7 @@ module Aws::FraudDetector
795
917
  #
796
918
  # resp = client.describe_model_versions({
797
919
  # model_id: "identifier",
798
- # model_version_number: "nonEmptyString",
920
+ # model_version_number: "floatVersionString",
799
921
  # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
800
922
  # next_token: "string",
801
923
  # max_results: 1,
@@ -807,23 +929,34 @@ module Aws::FraudDetector
807
929
  # resp.model_version_details[0].model_id #=> String
808
930
  # resp.model_version_details[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
809
931
  # resp.model_version_details[0].model_version_number #=> String
810
- # resp.model_version_details[0].description #=> String
811
932
  # resp.model_version_details[0].status #=> String
812
- # resp.model_version_details[0].training_data_source.data_location #=> String
813
- # resp.model_version_details[0].training_data_source.data_access_role_arn #=> String
814
- # resp.model_version_details[0].model_variables #=> Array
815
- # resp.model_version_details[0].model_variables[0].name #=> String
816
- # resp.model_version_details[0].model_variables[0].index #=> Integer
817
- # resp.model_version_details[0].label_schema.label_key #=> String
818
- # resp.model_version_details[0].label_schema.label_mapper #=> Hash
819
- # resp.model_version_details[0].label_schema.label_mapper["string"] #=> Array
820
- # resp.model_version_details[0].label_schema.label_mapper["string"][0] #=> String
821
- # resp.model_version_details[0].validation_metrics #=> Hash
822
- # resp.model_version_details[0].validation_metrics["string"] #=> String
823
- # resp.model_version_details[0].training_metrics #=> Hash
824
- # resp.model_version_details[0].training_metrics["string"] #=> String
933
+ # resp.model_version_details[0].training_data_source #=> String, one of "EXTERNAL_EVENTS"
934
+ # resp.model_version_details[0].training_data_schema.model_variables #=> Array
935
+ # resp.model_version_details[0].training_data_schema.model_variables[0] #=> String
936
+ # resp.model_version_details[0].training_data_schema.label_schema.label_mapper #=> Hash
937
+ # resp.model_version_details[0].training_data_schema.label_schema.label_mapper["string"] #=> Array
938
+ # resp.model_version_details[0].training_data_schema.label_schema.label_mapper["string"][0] #=> String
939
+ # resp.model_version_details[0].external_events_detail.data_location #=> String
940
+ # resp.model_version_details[0].external_events_detail.data_access_role_arn #=> String
941
+ # resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages #=> Array
942
+ # resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages[0].title #=> String
943
+ # resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages[0].content #=> String
944
+ # resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages[0].type #=> String
945
+ # resp.model_version_details[0].training_result.data_validation_metrics.field_level_messages #=> Array
946
+ # resp.model_version_details[0].training_result.data_validation_metrics.field_level_messages[0].field_name #=> String
947
+ # resp.model_version_details[0].training_result.data_validation_metrics.field_level_messages[0].identifier #=> String
948
+ # resp.model_version_details[0].training_result.data_validation_metrics.field_level_messages[0].title #=> String
949
+ # resp.model_version_details[0].training_result.data_validation_metrics.field_level_messages[0].content #=> String
950
+ # resp.model_version_details[0].training_result.data_validation_metrics.field_level_messages[0].type #=> String
951
+ # resp.model_version_details[0].training_result.training_metrics.auc #=> Float
952
+ # resp.model_version_details[0].training_result.training_metrics.metric_data_points #=> Array
953
+ # resp.model_version_details[0].training_result.training_metrics.metric_data_points[0].fpr #=> Float
954
+ # resp.model_version_details[0].training_result.training_metrics.metric_data_points[0].precision #=> Float
955
+ # resp.model_version_details[0].training_result.training_metrics.metric_data_points[0].tpr #=> Float
956
+ # resp.model_version_details[0].training_result.training_metrics.metric_data_points[0].threshold #=> Float
825
957
  # resp.model_version_details[0].last_updated_time #=> String
826
958
  # resp.model_version_details[0].created_time #=> String
959
+ # resp.model_version_details[0].arn #=> String
827
960
  # resp.next_token #=> String
828
961
  #
829
962
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DescribeModelVersions AWS API Documentation
@@ -855,12 +988,13 @@ module Aws::FraudDetector
855
988
  # * {Types::GetDetectorVersionResult#last_updated_time #last_updated_time} => String
856
989
  # * {Types::GetDetectorVersionResult#created_time #created_time} => String
857
990
  # * {Types::GetDetectorVersionResult#rule_execution_mode #rule_execution_mode} => String
991
+ # * {Types::GetDetectorVersionResult#arn #arn} => String
858
992
  #
859
993
  # @example Request syntax with placeholder values
860
994
  #
861
995
  # resp = client.get_detector_version({
862
996
  # detector_id: "identifier", # required
863
- # detector_version_id: "nonEmptyString", # required
997
+ # detector_version_id: "wholeNumberVersionString", # required
864
998
  # })
865
999
  #
866
1000
  # @example Response structure
@@ -874,6 +1008,7 @@ module Aws::FraudDetector
874
1008
  # resp.model_versions[0].model_id #=> String
875
1009
  # resp.model_versions[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
876
1010
  # resp.model_versions[0].model_version_number #=> String
1011
+ # resp.model_versions[0].arn #=> String
877
1012
  # resp.rules #=> Array
878
1013
  # resp.rules[0].detector_id #=> String
879
1014
  # resp.rules[0].rule_id #=> String
@@ -882,6 +1017,7 @@ module Aws::FraudDetector
882
1017
  # resp.last_updated_time #=> String
883
1018
  # resp.created_time #=> String
884
1019
  # resp.rule_execution_mode #=> String, one of "ALL_MATCHED", "FIRST_MATCHED"
1020
+ # resp.arn #=> String
885
1021
  #
886
1022
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetDetectorVersion AWS API Documentation
887
1023
  #
@@ -892,12 +1028,13 @@ module Aws::FraudDetector
892
1028
  req.send_request(options)
893
1029
  end
894
1030
 
895
- # Gets all of detectors. This is a paginated API. If you provide a null
896
- # `maxSizePerPage`, this actions retrieves a maximum of 10 records per
897
- # page. If you provide a `maxSizePerPage`, the value must be between 5
898
- # and 10. To get the next page results, provide the pagination token
899
- # from the `GetEventTypesResponse` as part of your request. A null
900
- # pagination token fetches the records from the beginning.
1031
+ # Gets all detectors or a single detector if a `detectorId` is
1032
+ # specified. This is a paginated API. If you provide a null
1033
+ # `maxResults`, this action retrieves a maximum of 10 records per page.
1034
+ # If you provide a `maxResults`, the value must be between 5 and 10. To
1035
+ # get the next page results, provide the pagination token from the
1036
+ # `GetDetectorsResponse` as part of your request. A null pagination
1037
+ # token fetches the records from the beginning.
901
1038
  #
902
1039
  # @option params [String] :detector_id
903
1040
  # The detector ID.
@@ -928,8 +1065,10 @@ module Aws::FraudDetector
928
1065
  # resp.detectors #=> Array
929
1066
  # resp.detectors[0].detector_id #=> String
930
1067
  # resp.detectors[0].description #=> String
1068
+ # resp.detectors[0].event_type_name #=> String
931
1069
  # resp.detectors[0].last_updated_time #=> String
932
1070
  # resp.detectors[0].created_time #=> String
1071
+ # resp.detectors[0].arn #=> String
933
1072
  # resp.next_token #=> String
934
1073
  #
935
1074
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetDetectors AWS API Documentation
@@ -941,14 +1080,206 @@ module Aws::FraudDetector
941
1080
  req.send_request(options)
942
1081
  end
943
1082
 
1083
+ # Gets all entity types or a specific entity type if a name is
1084
+ # specified. This is a paginated API. If you provide a null
1085
+ # `maxResults`, this action retrieves a maximum of 10 records per page.
1086
+ # If you provide a `maxResults`, the value must be between 5 and 10. To
1087
+ # get the next page results, provide the pagination token from the
1088
+ # `GetEntityTypesResponse` as part of your request. A null pagination
1089
+ # token fetches the records from the beginning.
1090
+ #
1091
+ # @option params [String] :name
1092
+ # The name.
1093
+ #
1094
+ # @option params [String] :next_token
1095
+ # The next token for the subsequent request.
1096
+ #
1097
+ # @option params [Integer] :max_results
1098
+ # The maximum number of objects to return for the request.
1099
+ #
1100
+ # @return [Types::GetEntityTypesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1101
+ #
1102
+ # * {Types::GetEntityTypesResult#entity_types #entity_types} => Array&lt;Types::EntityType&gt;
1103
+ # * {Types::GetEntityTypesResult#next_token #next_token} => String
1104
+ #
1105
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1106
+ #
1107
+ # @example Request syntax with placeholder values
1108
+ #
1109
+ # resp = client.get_entity_types({
1110
+ # name: "identifier",
1111
+ # next_token: "string",
1112
+ # max_results: 1,
1113
+ # })
1114
+ #
1115
+ # @example Response structure
1116
+ #
1117
+ # resp.entity_types #=> Array
1118
+ # resp.entity_types[0].name #=> String
1119
+ # resp.entity_types[0].description #=> String
1120
+ # resp.entity_types[0].last_updated_time #=> String
1121
+ # resp.entity_types[0].created_time #=> String
1122
+ # resp.entity_types[0].arn #=> String
1123
+ # resp.next_token #=> String
1124
+ #
1125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEntityTypes AWS API Documentation
1126
+ #
1127
+ # @overload get_entity_types(params = {})
1128
+ # @param [Hash] params ({})
1129
+ def get_entity_types(params = {}, options = {})
1130
+ req = build_request(:get_entity_types, params)
1131
+ req.send_request(options)
1132
+ end
1133
+
1134
+ # Evaluates an event against a detector version. If a version ID is not
1135
+ # provided, the detector’s (`ACTIVE`) version is used.
1136
+ #
1137
+ # @option params [required, String] :detector_id
1138
+ # The detector ID.
1139
+ #
1140
+ # @option params [String] :detector_version_id
1141
+ # The detector version ID.
1142
+ #
1143
+ # @option params [required, String] :event_id
1144
+ # The unique ID used to identify the event.
1145
+ #
1146
+ # @option params [required, String] :event_type_name
1147
+ # The event type associated with the detector specified for the
1148
+ # prediction.
1149
+ #
1150
+ # @option params [required, Array<Types::Entity>] :entities
1151
+ # The entity type (associated with the detector's event type) and
1152
+ # specific entity ID representing who performed the event. If an entity
1153
+ # id is not available, use "UNKNOWN."
1154
+ #
1155
+ # @option params [required, String] :event_timestamp
1156
+ # Timestamp that defines when the event under evaluation occurred.
1157
+ #
1158
+ # @option params [required, Hash<String,String>] :event_variables
1159
+ # Names of the event type's variables you defined in Amazon Fraud
1160
+ # Detector to represent data elements and their corresponding values for
1161
+ # the event you are sending for evaluation.
1162
+ #
1163
+ # @option params [Hash<String,Types::ModelEndpointDataBlob>] :external_model_endpoint_data_blobs
1164
+ # The Amazon SageMaker model endpoint input data blobs.
1165
+ #
1166
+ # @return [Types::GetEventPredictionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1167
+ #
1168
+ # * {Types::GetEventPredictionResult#model_scores #model_scores} => Array&lt;Types::ModelScores&gt;
1169
+ # * {Types::GetEventPredictionResult#rule_results #rule_results} => Array&lt;Types::RuleResult&gt;
1170
+ #
1171
+ # @example Request syntax with placeholder values
1172
+ #
1173
+ # resp = client.get_event_prediction({
1174
+ # detector_id: "string", # required
1175
+ # detector_version_id: "string",
1176
+ # event_id: "string", # required
1177
+ # event_type_name: "string", # required
1178
+ # entities: [ # required
1179
+ # {
1180
+ # entity_type: "string",
1181
+ # entity_id: "identifier",
1182
+ # },
1183
+ # ],
1184
+ # event_timestamp: "string", # required
1185
+ # event_variables: { # required
1186
+ # "variableName" => "variableValue",
1187
+ # },
1188
+ # external_model_endpoint_data_blobs: {
1189
+ # "string" => {
1190
+ # byte_buffer: "data",
1191
+ # content_type: "contentType",
1192
+ # },
1193
+ # },
1194
+ # })
1195
+ #
1196
+ # @example Response structure
1197
+ #
1198
+ # resp.model_scores #=> Array
1199
+ # resp.model_scores[0].model_version.model_id #=> String
1200
+ # resp.model_scores[0].model_version.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1201
+ # resp.model_scores[0].model_version.model_version_number #=> String
1202
+ # resp.model_scores[0].model_version.arn #=> String
1203
+ # resp.model_scores[0].scores #=> Hash
1204
+ # resp.model_scores[0].scores["string"] #=> Float
1205
+ # resp.rule_results #=> Array
1206
+ # resp.rule_results[0].rule_id #=> String
1207
+ # resp.rule_results[0].outcomes #=> Array
1208
+ # resp.rule_results[0].outcomes[0] #=> String
1209
+ #
1210
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventPrediction AWS API Documentation
1211
+ #
1212
+ # @overload get_event_prediction(params = {})
1213
+ # @param [Hash] params ({})
1214
+ def get_event_prediction(params = {}, options = {})
1215
+ req = build_request(:get_event_prediction, params)
1216
+ req.send_request(options)
1217
+ end
1218
+
1219
+ # Gets all event types or a specific event type if name is provided.
1220
+ # This is a paginated API. If you provide a null `maxResults`, this
1221
+ # action retrieves a maximum of 10 records per page. If you provide a
1222
+ # `maxResults`, the value must be between 5 and 10. To get the next page
1223
+ # results, provide the pagination token from the `GetEventTypesResponse`
1224
+ # as part of your request. A null pagination token fetches the records
1225
+ # from the beginning.
1226
+ #
1227
+ # @option params [String] :name
1228
+ # The name.
1229
+ #
1230
+ # @option params [String] :next_token
1231
+ # The next token for the subsequent request.
1232
+ #
1233
+ # @option params [Integer] :max_results
1234
+ # The maximum number of objects to return for the request.
1235
+ #
1236
+ # @return [Types::GetEventTypesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1237
+ #
1238
+ # * {Types::GetEventTypesResult#event_types #event_types} => Array&lt;Types::EventType&gt;
1239
+ # * {Types::GetEventTypesResult#next_token #next_token} => String
1240
+ #
1241
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1242
+ #
1243
+ # @example Request syntax with placeholder values
1244
+ #
1245
+ # resp = client.get_event_types({
1246
+ # name: "identifier",
1247
+ # next_token: "string",
1248
+ # max_results: 1,
1249
+ # })
1250
+ #
1251
+ # @example Response structure
1252
+ #
1253
+ # resp.event_types #=> Array
1254
+ # resp.event_types[0].name #=> String
1255
+ # resp.event_types[0].description #=> String
1256
+ # resp.event_types[0].event_variables #=> Array
1257
+ # resp.event_types[0].event_variables[0] #=> String
1258
+ # resp.event_types[0].labels #=> Array
1259
+ # resp.event_types[0].labels[0] #=> String
1260
+ # resp.event_types[0].entity_types #=> Array
1261
+ # resp.event_types[0].entity_types[0] #=> String
1262
+ # resp.event_types[0].last_updated_time #=> String
1263
+ # resp.event_types[0].created_time #=> String
1264
+ # resp.event_types[0].arn #=> String
1265
+ # resp.next_token #=> String
1266
+ #
1267
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventTypes AWS API Documentation
1268
+ #
1269
+ # @overload get_event_types(params = {})
1270
+ # @param [Hash] params ({})
1271
+ def get_event_types(params = {}, options = {})
1272
+ req = build_request(:get_event_types, params)
1273
+ req.send_request(options)
1274
+ end
1275
+
944
1276
  # Gets the details for one or more Amazon SageMaker models that have
945
1277
  # been imported into the service. This is a paginated API. If you
946
- # provide a null `maxSizePerPage`, this actions retrieves a maximum of
947
- # 10 records per page. If you provide a `maxSizePerPage`, the value must
948
- # be between 5 and 10. To get the next page results, provide the
949
- # pagination token from the `GetExternalModelsResult` as part of your
950
- # request. A null pagination token fetches the records from the
951
- # beginning.
1278
+ # provide a null `maxResults`, this actions retrieves a maximum of 10
1279
+ # records per page. If you provide a `maxResults`, the value must be
1280
+ # between 5 and 10. To get the next page results, provide the pagination
1281
+ # token from the `GetExternalModelsResult` as part of your request. A
1282
+ # null pagination token fetches the records from the beginning.
952
1283
  #
953
1284
  # @option params [String] :model_endpoint
954
1285
  # The Amazon SageMaker model endpoint.
@@ -978,11 +1309,12 @@ module Aws::FraudDetector
978
1309
  #
979
1310
  # resp.external_models #=> Array
980
1311
  # resp.external_models[0].model_endpoint #=> String
1312
+ # resp.external_models[0].event_type_name #=> String
981
1313
  # resp.external_models[0].model_source #=> String, one of "SAGEMAKER"
982
1314
  # resp.external_models[0].role.arn #=> String
983
1315
  # resp.external_models[0].role.name #=> String
984
1316
  # resp.external_models[0].input_configuration.format #=> String, one of "TEXT_CSV", "APPLICATION_JSON"
985
- # resp.external_models[0].input_configuration.is_opaque #=> Boolean
1317
+ # resp.external_models[0].input_configuration.use_event_variables #=> Boolean
986
1318
  # resp.external_models[0].input_configuration.json_input_template #=> String
987
1319
  # resp.external_models[0].input_configuration.csv_input_template #=> String
988
1320
  # resp.external_models[0].output_configuration.format #=> String, one of "TEXT_CSV", "APPLICATION_JSONLINES"
@@ -993,6 +1325,7 @@ module Aws::FraudDetector
993
1325
  # resp.external_models[0].model_endpoint_status #=> String, one of "ASSOCIATED", "DISSOCIATED"
994
1326
  # resp.external_models[0].last_updated_time #=> String
995
1327
  # resp.external_models[0].created_time #=> String
1328
+ # resp.external_models[0].arn #=> String
996
1329
  # resp.next_token #=> String
997
1330
  #
998
1331
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetExternalModels AWS API Documentation
@@ -1004,7 +1337,79 @@ module Aws::FraudDetector
1004
1337
  req.send_request(options)
1005
1338
  end
1006
1339
 
1007
- # Gets a model version.
1340
+ # Gets the encryption key if a Key Management Service (KMS) customer
1341
+ # master key (CMK) has been specified to be used to encrypt content in
1342
+ # Amazon Fraud Detector.
1343
+ #
1344
+ # @return [Types::GetKMSEncryptionKeyResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1345
+ #
1346
+ # * {Types::GetKMSEncryptionKeyResult#kms_key #kms_key} => Types::KMSKey
1347
+ #
1348
+ # @example Response structure
1349
+ #
1350
+ # resp.kms_key.kms_encryption_key_arn #=> String
1351
+ #
1352
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetKMSEncryptionKey AWS API Documentation
1353
+ #
1354
+ # @overload get_kms_encryption_key(params = {})
1355
+ # @param [Hash] params ({})
1356
+ def get_kms_encryption_key(params = {}, options = {})
1357
+ req = build_request(:get_kms_encryption_key, params)
1358
+ req.send_request(options)
1359
+ end
1360
+
1361
+ # Gets all labels or a specific label if name is provided. This is a
1362
+ # paginated API. If you provide a null `maxResults`, this action
1363
+ # retrieves a maximum of 50 records per page. If you provide a
1364
+ # `maxResults`, the value must be between 10 and 50. To get the next
1365
+ # page results, provide the pagination token from the
1366
+ # `GetGetLabelsResponse` as part of your request. A null pagination
1367
+ # token fetches the records from the beginning.
1368
+ #
1369
+ # @option params [String] :name
1370
+ # The name of the label or labels to get.
1371
+ #
1372
+ # @option params [String] :next_token
1373
+ # The next token for the subsequent request.
1374
+ #
1375
+ # @option params [Integer] :max_results
1376
+ # The maximum number of objects to return for the request.
1377
+ #
1378
+ # @return [Types::GetLabelsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1379
+ #
1380
+ # * {Types::GetLabelsResult#labels #labels} => Array&lt;Types::Label&gt;
1381
+ # * {Types::GetLabelsResult#next_token #next_token} => String
1382
+ #
1383
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1384
+ #
1385
+ # @example Request syntax with placeholder values
1386
+ #
1387
+ # resp = client.get_labels({
1388
+ # name: "identifier",
1389
+ # next_token: "string",
1390
+ # max_results: 1,
1391
+ # })
1392
+ #
1393
+ # @example Response structure
1394
+ #
1395
+ # resp.labels #=> Array
1396
+ # resp.labels[0].name #=> String
1397
+ # resp.labels[0].description #=> String
1398
+ # resp.labels[0].last_updated_time #=> String
1399
+ # resp.labels[0].created_time #=> String
1400
+ # resp.labels[0].arn #=> String
1401
+ # resp.next_token #=> String
1402
+ #
1403
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetLabels AWS API Documentation
1404
+ #
1405
+ # @overload get_labels(params = {})
1406
+ # @param [Hash] params ({})
1407
+ def get_labels(params = {}, options = {})
1408
+ req = build_request(:get_labels, params)
1409
+ req.send_request(options)
1410
+ end
1411
+
1412
+ # Gets the details of the specified model version.
1008
1413
  #
1009
1414
  # @option params [required, String] :model_id
1010
1415
  # The model ID.
@@ -1013,22 +1418,25 @@ module Aws::FraudDetector
1013
1418
  # The model type.
1014
1419
  #
1015
1420
  # @option params [required, String] :model_version_number
1016
- # The model version.
1421
+ # The model version number.
1017
1422
  #
1018
1423
  # @return [Types::GetModelVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1019
1424
  #
1020
1425
  # * {Types::GetModelVersionResult#model_id #model_id} => String
1021
1426
  # * {Types::GetModelVersionResult#model_type #model_type} => String
1022
1427
  # * {Types::GetModelVersionResult#model_version_number #model_version_number} => String
1023
- # * {Types::GetModelVersionResult#description #description} => String
1428
+ # * {Types::GetModelVersionResult#training_data_source #training_data_source} => String
1429
+ # * {Types::GetModelVersionResult#training_data_schema #training_data_schema} => Types::TrainingDataSchema
1430
+ # * {Types::GetModelVersionResult#external_events_detail #external_events_detail} => Types::ExternalEventsDetail
1024
1431
  # * {Types::GetModelVersionResult#status #status} => String
1432
+ # * {Types::GetModelVersionResult#arn #arn} => String
1025
1433
  #
1026
1434
  # @example Request syntax with placeholder values
1027
1435
  #
1028
1436
  # resp = client.get_model_version({
1029
1437
  # model_id: "identifier", # required
1030
1438
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1031
- # model_version_number: "nonEmptyString", # required
1439
+ # model_version_number: "floatVersionString", # required
1032
1440
  # })
1033
1441
  #
1034
1442
  # @example Response structure
@@ -1036,8 +1444,16 @@ module Aws::FraudDetector
1036
1444
  # resp.model_id #=> String
1037
1445
  # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1038
1446
  # resp.model_version_number #=> String
1039
- # resp.description #=> String
1447
+ # resp.training_data_source #=> String, one of "EXTERNAL_EVENTS"
1448
+ # resp.training_data_schema.model_variables #=> Array
1449
+ # resp.training_data_schema.model_variables[0] #=> String
1450
+ # resp.training_data_schema.label_schema.label_mapper #=> Hash
1451
+ # resp.training_data_schema.label_schema.label_mapper["string"] #=> Array
1452
+ # resp.training_data_schema.label_schema.label_mapper["string"][0] #=> String
1453
+ # resp.external_events_detail.data_location #=> String
1454
+ # resp.external_events_detail.data_access_role_arn #=> String
1040
1455
  # resp.status #=> String
1456
+ # resp.arn #=> String
1041
1457
  #
1042
1458
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModelVersion AWS API Documentation
1043
1459
  #
@@ -1048,21 +1464,30 @@ module Aws::FraudDetector
1048
1464
  req.send_request(options)
1049
1465
  end
1050
1466
 
1051
- # Gets all of the models for the AWS account, or the specified model
1052
- # type, or gets a single model for the specified model type, model ID
1053
- # combination.
1054
- #
1055
- # @option params [String] :model_type
1056
- # The model type.
1467
+ # Gets one or more models. Gets all models for the AWS account if no
1468
+ # model type and no model id provided. Gets all models for the AWS
1469
+ # account and model type, if the model type is specified but model id is
1470
+ # not provided. Gets a specific model if (model type, model id) tuple is
1471
+ # specified.
1472
+ #
1473
+ # This is a paginated API. If you provide a null `maxResults`, this
1474
+ # action retrieves a maximum of 10 records per page. If you provide a
1475
+ # `maxResults`, the value must be between 1 and 10. To get the next page
1476
+ # results, provide the pagination token from the response as part of
1477
+ # your request. A null pagination token fetches the records from the
1478
+ # beginning.
1057
1479
  #
1058
1480
  # @option params [String] :model_id
1059
1481
  # The model ID.
1060
1482
  #
1483
+ # @option params [String] :model_type
1484
+ # The model type.
1485
+ #
1061
1486
  # @option params [String] :next_token
1062
- # The next token for the request.
1487
+ # The next token for the subsequent request.
1063
1488
  #
1064
1489
  # @option params [Integer] :max_results
1065
- # The maximum results to return for the request.
1490
+ # The maximum number of objects to return for the request.
1066
1491
  #
1067
1492
  # @return [Types::GetModelsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1068
1493
  #
@@ -1074,8 +1499,8 @@ module Aws::FraudDetector
1074
1499
  # @example Request syntax with placeholder values
1075
1500
  #
1076
1501
  # resp = client.get_models({
1077
- # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
1078
1502
  # model_id: "identifier",
1503
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
1079
1504
  # next_token: "string",
1080
1505
  # max_results: 1,
1081
1506
  # })
@@ -1087,17 +1512,10 @@ module Aws::FraudDetector
1087
1512
  # resp.models[0].model_id #=> String
1088
1513
  # resp.models[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1089
1514
  # resp.models[0].description #=> String
1090
- # resp.models[0].training_data_source.data_location #=> String
1091
- # resp.models[0].training_data_source.data_access_role_arn #=> String
1092
- # resp.models[0].model_variables #=> Array
1093
- # resp.models[0].model_variables[0].name #=> String
1094
- # resp.models[0].model_variables[0].index #=> Integer
1095
- # resp.models[0].label_schema.label_key #=> String
1096
- # resp.models[0].label_schema.label_mapper #=> Hash
1097
- # resp.models[0].label_schema.label_mapper["string"] #=> Array
1098
- # resp.models[0].label_schema.label_mapper["string"][0] #=> String
1099
- # resp.models[0].last_updated_time #=> String
1515
+ # resp.models[0].event_type_name #=> String
1100
1516
  # resp.models[0].created_time #=> String
1517
+ # resp.models[0].last_updated_time #=> String
1518
+ # resp.models[0].arn #=> String
1101
1519
  #
1102
1520
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModels AWS API Documentation
1103
1521
  #
@@ -1109,11 +1527,11 @@ module Aws::FraudDetector
1109
1527
  end
1110
1528
 
1111
1529
  # Gets one or more outcomes. This is a paginated API. If you provide a
1112
- # null `maxSizePerPage`, this actions retrieves a maximum of 10 records
1113
- # per page. If you provide a `maxSizePerPage`, the value must be between
1114
- # 50 and 100. To get the next page results, provide the pagination token
1115
- # from the `GetOutcomesResult` as part of your request. A null
1116
- # pagination token fetches the records from the beginning.
1530
+ # null `maxResults`, this actions retrieves a maximum of 100 records per
1531
+ # page. If you provide a `maxResults`, the value must be between 50 and
1532
+ # 100. To get the next page results, provide the pagination token from
1533
+ # the `GetOutcomesResult` as part of your request. A null pagination
1534
+ # token fetches the records from the beginning.
1117
1535
  #
1118
1536
  # @option params [String] :name
1119
1537
  # The name of the outcome or outcomes to get.
@@ -1146,6 +1564,7 @@ module Aws::FraudDetector
1146
1564
  # resp.outcomes[0].description #=> String
1147
1565
  # resp.outcomes[0].last_updated_time #=> String
1148
1566
  # resp.outcomes[0].created_time #=> String
1567
+ # resp.outcomes[0].arn #=> String
1149
1568
  # resp.next_token #=> String
1150
1569
  #
1151
1570
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetOutcomes AWS API Documentation
@@ -1208,6 +1627,7 @@ module Aws::FraudDetector
1208
1627
  # resp.model_scores[0].model_version.model_id #=> String
1209
1628
  # resp.model_scores[0].model_version.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1210
1629
  # resp.model_scores[0].model_version.model_version_number #=> String
1630
+ # resp.model_scores[0].model_version.arn #=> String
1211
1631
  # resp.model_scores[0].scores #=> Hash
1212
1632
  # resp.model_scores[0].scores["string"] #=> Float
1213
1633
  # resp.rule_results #=> Array
@@ -1224,7 +1644,16 @@ module Aws::FraudDetector
1224
1644
  req.send_request(options)
1225
1645
  end
1226
1646
 
1227
- # Gets all rules available for the specified detector.
1647
+ # Get all rules for a detector (paginated) if `ruleId` and `ruleVersion`
1648
+ # are not specified. Gets all rules for the detector and the `ruleId` if
1649
+ # present (paginated). Gets a specific rule if both the `ruleId` and the
1650
+ # `ruleVersion` are specified.
1651
+ #
1652
+ # This is a paginated API. Providing null maxResults results in
1653
+ # retrieving maximum of 100 records per page. If you provide maxResults
1654
+ # the value must be between 50 and 100. To get the next page result, a
1655
+ # provide a pagination token from GetRulesResult as part of your
1656
+ # request. Null pagination token fetches the records from the beginning.
1228
1657
  #
1229
1658
  # @option params [String] :rule_id
1230
1659
  # The rule ID.
@@ -1253,7 +1682,7 @@ module Aws::FraudDetector
1253
1682
  # resp = client.get_rules({
1254
1683
  # rule_id: "identifier",
1255
1684
  # detector_id: "identifier", # required
1256
- # rule_version: "nonEmptyString",
1685
+ # rule_version: "wholeNumberVersionString",
1257
1686
  # next_token: "string",
1258
1687
  # max_results: 1,
1259
1688
  # })
@@ -1271,6 +1700,7 @@ module Aws::FraudDetector
1271
1700
  # resp.rule_details[0].outcomes[0] #=> String
1272
1701
  # resp.rule_details[0].last_updated_time #=> String
1273
1702
  # resp.rule_details[0].created_time #=> String
1703
+ # resp.rule_details[0].arn #=> String
1274
1704
  # resp.next_token #=> String
1275
1705
  #
1276
1706
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetRules AWS API Documentation
@@ -1324,6 +1754,7 @@ module Aws::FraudDetector
1324
1754
  # resp.variables[0].variable_type #=> String
1325
1755
  # resp.variables[0].last_updated_time #=> String
1326
1756
  # resp.variables[0].created_time #=> String
1757
+ # resp.variables[0].arn #=> String
1327
1758
  # resp.next_token #=> String
1328
1759
  #
1329
1760
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetVariables AWS API Documentation
@@ -1335,6 +1766,51 @@ module Aws::FraudDetector
1335
1766
  req.send_request(options)
1336
1767
  end
1337
1768
 
1769
+ # Lists all tags associated with the resource. This is a paginated API.
1770
+ # To get the next page results, provide the pagination token from the
1771
+ # response as part of your request. A null pagination token fetches the
1772
+ # records from the beginning.
1773
+ #
1774
+ # @option params [required, String] :resource_arn
1775
+ # The ARN that specifies the resource whose tags you want to list.
1776
+ #
1777
+ # @option params [String] :next_token
1778
+ # The next token from the previous results.
1779
+ #
1780
+ # @option params [Integer] :max_results
1781
+ # The maximum number of objects to return for the request.
1782
+ #
1783
+ # @return [Types::ListTagsForResourceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1784
+ #
1785
+ # * {Types::ListTagsForResourceResult#tags #tags} => Array&lt;Types::Tag&gt;
1786
+ # * {Types::ListTagsForResourceResult#next_token #next_token} => String
1787
+ #
1788
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1789
+ #
1790
+ # @example Request syntax with placeholder values
1791
+ #
1792
+ # resp = client.list_tags_for_resource({
1793
+ # resource_arn: "fraudDetectorArn", # required
1794
+ # next_token: "string",
1795
+ # max_results: 1,
1796
+ # })
1797
+ #
1798
+ # @example Response structure
1799
+ #
1800
+ # resp.tags #=> Array
1801
+ # resp.tags[0].key #=> String
1802
+ # resp.tags[0].value #=> String
1803
+ # resp.next_token #=> String
1804
+ #
1805
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ListTagsForResource AWS API Documentation
1806
+ #
1807
+ # @overload list_tags_for_resource(params = {})
1808
+ # @param [Hash] params ({})
1809
+ def list_tags_for_resource(params = {}, options = {})
1810
+ req = build_request(:list_tags_for_resource, params)
1811
+ req.send_request(options)
1812
+ end
1813
+
1338
1814
  # Creates or updates a detector.
1339
1815
  #
1340
1816
  # @option params [required, String] :detector_id
@@ -1343,6 +1819,12 @@ module Aws::FraudDetector
1343
1819
  # @option params [String] :description
1344
1820
  # The description of the detector.
1345
1821
  #
1822
+ # @option params [required, String] :event_type_name
1823
+ # The name of the event type.
1824
+ #
1825
+ # @option params [Array<Types::Tag>] :tags
1826
+ # A collection of key and value pairs.
1827
+ #
1346
1828
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1347
1829
  #
1348
1830
  # @example Request syntax with placeholder values
@@ -1350,6 +1832,13 @@ module Aws::FraudDetector
1350
1832
  # resp = client.put_detector({
1351
1833
  # detector_id: "identifier", # required
1352
1834
  # description: "description",
1835
+ # event_type_name: "identifier", # required
1836
+ # tags: [
1837
+ # {
1838
+ # key: "tagKey", # required
1839
+ # value: "tagValue", # required
1840
+ # },
1841
+ # ],
1353
1842
  # })
1354
1843
  #
1355
1844
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutDetector AWS API Documentation
@@ -1361,6 +1850,100 @@ module Aws::FraudDetector
1361
1850
  req.send_request(options)
1362
1851
  end
1363
1852
 
1853
+ # Creates or updates an entity type. An entity represents who is
1854
+ # performing the event. As part of a fraud prediction, you pass the
1855
+ # entity ID to indicate the specific entity who performed the event. An
1856
+ # entity type classifies the entity. Example classifications include
1857
+ # customer, merchant, or account.
1858
+ #
1859
+ # @option params [required, String] :name
1860
+ # The name of the entity type.
1861
+ #
1862
+ # @option params [String] :description
1863
+ # The description.
1864
+ #
1865
+ # @option params [Array<Types::Tag>] :tags
1866
+ # A collection of key and value pairs.
1867
+ #
1868
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1869
+ #
1870
+ # @example Request syntax with placeholder values
1871
+ #
1872
+ # resp = client.put_entity_type({
1873
+ # name: "identifier", # required
1874
+ # description: "description",
1875
+ # tags: [
1876
+ # {
1877
+ # key: "tagKey", # required
1878
+ # value: "tagValue", # required
1879
+ # },
1880
+ # ],
1881
+ # })
1882
+ #
1883
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutEntityType AWS API Documentation
1884
+ #
1885
+ # @overload put_entity_type(params = {})
1886
+ # @param [Hash] params ({})
1887
+ def put_entity_type(params = {}, options = {})
1888
+ req = build_request(:put_entity_type, params)
1889
+ req.send_request(options)
1890
+ end
1891
+
1892
+ # Creates or updates an event type. An event is a business activity that
1893
+ # is evaluated for fraud risk. With Amazon Fraud Detector, you generate
1894
+ # fraud predictions for events. An event type defines the structure for
1895
+ # an event sent to Amazon Fraud Detector. This includes the variables
1896
+ # sent as part of the event, the entity performing the event (such as a
1897
+ # customer), and the labels that classify the event. Example event types
1898
+ # include online payment transactions, account registrations, and
1899
+ # authentications.
1900
+ #
1901
+ # @option params [required, String] :name
1902
+ # The name.
1903
+ #
1904
+ # @option params [String] :description
1905
+ # The description of the event type.
1906
+ #
1907
+ # @option params [required, Array<String>] :event_variables
1908
+ # The event type variables.
1909
+ #
1910
+ # @option params [Array<String>] :labels
1911
+ # The event type labels.
1912
+ #
1913
+ # @option params [required, Array<String>] :entity_types
1914
+ # The entity type for the event type. Example entity types: customer,
1915
+ # merchant, account.
1916
+ #
1917
+ # @option params [Array<Types::Tag>] :tags
1918
+ # A collection of key and value pairs.
1919
+ #
1920
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1921
+ #
1922
+ # @example Request syntax with placeholder values
1923
+ #
1924
+ # resp = client.put_event_type({
1925
+ # name: "identifier", # required
1926
+ # description: "description",
1927
+ # event_variables: ["string"], # required
1928
+ # labels: ["string"],
1929
+ # entity_types: ["string"], # required
1930
+ # tags: [
1931
+ # {
1932
+ # key: "tagKey", # required
1933
+ # value: "tagValue", # required
1934
+ # },
1935
+ # ],
1936
+ # })
1937
+ #
1938
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutEventType AWS API Documentation
1939
+ #
1940
+ # @overload put_event_type(params = {})
1941
+ # @param [Hash] params ({})
1942
+ def put_event_type(params = {}, options = {})
1943
+ req = build_request(:put_event_type, params)
1944
+ req.send_request(options)
1945
+ end
1946
+
1364
1947
  # Creates or updates an Amazon SageMaker model endpoint. You can also
1365
1948
  # use this action to update the configuration of the model endpoint,
1366
1949
  # including the IAM role and/or the mapped variables.
@@ -1368,6 +1951,9 @@ module Aws::FraudDetector
1368
1951
  # @option params [required, String] :model_endpoint
1369
1952
  # The model endpoints name.
1370
1953
  #
1954
+ # @option params [String] :event_type_name
1955
+ # The event type name.
1956
+ #
1371
1957
  # @option params [required, String] :model_source
1372
1958
  # The source of the model.
1373
1959
  #
@@ -1383,12 +1969,16 @@ module Aws::FraudDetector
1383
1969
  # @option params [required, String] :model_endpoint_status
1384
1970
  # The model endpoint’s status in Amazon Fraud Detector.
1385
1971
  #
1972
+ # @option params [Array<Types::Tag>] :tags
1973
+ # A collection of key and value pairs.
1974
+ #
1386
1975
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1387
1976
  #
1388
1977
  # @example Request syntax with placeholder values
1389
1978
  #
1390
1979
  # resp = client.put_external_model({
1391
- # model_endpoint: "string", # required
1980
+ # model_endpoint: "sageMakerEndpointIdentifier", # required
1981
+ # event_type_name: "identifier",
1392
1982
  # model_source: "SAGEMAKER", # required, accepts SAGEMAKER
1393
1983
  # role: { # required
1394
1984
  # arn: "string", # required
@@ -1396,7 +1986,7 @@ module Aws::FraudDetector
1396
1986
  # },
1397
1987
  # input_configuration: { # required
1398
1988
  # format: "TEXT_CSV", # accepts TEXT_CSV, APPLICATION_JSON
1399
- # is_opaque: false, # required
1989
+ # use_event_variables: false, # required
1400
1990
  # json_input_template: "string",
1401
1991
  # csv_input_template: "string",
1402
1992
  # },
@@ -1410,6 +2000,12 @@ module Aws::FraudDetector
1410
2000
  # },
1411
2001
  # },
1412
2002
  # model_endpoint_status: "ASSOCIATED", # required, accepts ASSOCIATED, DISSOCIATED
2003
+ # tags: [
2004
+ # {
2005
+ # key: "tagKey", # required
2006
+ # value: "tagValue", # required
2007
+ # },
2008
+ # ],
1413
2009
  # })
1414
2010
  #
1415
2011
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutExternalModel AWS API Documentation
@@ -1421,58 +2017,62 @@ module Aws::FraudDetector
1421
2017
  req.send_request(options)
1422
2018
  end
1423
2019
 
1424
- # Creates or updates a model.
2020
+ # Specifies the Key Management Service (KMS) customer master key (CMK)
2021
+ # to be used to encrypt content in Amazon Fraud Detector.
1425
2022
  #
1426
- # @option params [required, String] :model_id
1427
- # The model ID.
2023
+ # @option params [required, String] :kms_encryption_key_arn
2024
+ # The KMS encryption key ARN.
1428
2025
  #
1429
- # @option params [required, String] :model_type
1430
- # The model type.
2026
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1431
2027
  #
1432
- # @option params [String] :description
1433
- # The model description.
2028
+ # @example Request syntax with placeholder values
1434
2029
  #
1435
- # @option params [required, Types::TrainingDataSource] :training_data_source
1436
- # The training data source location in Amazon S3.
2030
+ # resp = client.put_kms_encryption_key({
2031
+ # kms_encryption_key_arn: "KmsEncryptionKeyArn", # required
2032
+ # })
2033
+ #
2034
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutKMSEncryptionKey AWS API Documentation
2035
+ #
2036
+ # @overload put_kms_encryption_key(params = {})
2037
+ # @param [Hash] params ({})
2038
+ def put_kms_encryption_key(params = {}, options = {})
2039
+ req = build_request(:put_kms_encryption_key, params)
2040
+ req.send_request(options)
2041
+ end
2042
+
2043
+ # Creates or updates label. A label classifies an event as fraudulent or
2044
+ # legitimate. Labels are associated with event types and used to train
2045
+ # supervised machine learning models in Amazon Fraud Detector.
1437
2046
  #
1438
- # @option params [required, Array<Types::ModelVariable>] :model_variables
1439
- # The model input variables.
2047
+ # @option params [required, String] :name
2048
+ # The label name.
2049
+ #
2050
+ # @option params [String] :description
2051
+ # The label description.
1440
2052
  #
1441
- # @option params [required, Types::LabelSchema] :label_schema
1442
- # The label schema.
2053
+ # @option params [Array<Types::Tag>] :tags
1443
2054
  #
1444
2055
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1445
2056
  #
1446
2057
  # @example Request syntax with placeholder values
1447
2058
  #
1448
- # resp = client.put_model({
1449
- # model_id: "identifier", # required
1450
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
2059
+ # resp = client.put_label({
2060
+ # name: "identifier", # required
1451
2061
  # description: "description",
1452
- # training_data_source: { # required
1453
- # data_location: "s3BucketLocation", # required
1454
- # data_access_role_arn: "iamRoleArn", # required
1455
- # },
1456
- # model_variables: [ # required
2062
+ # tags: [
1457
2063
  # {
1458
- # name: "string", # required
1459
- # index: 1,
2064
+ # key: "tagKey", # required
2065
+ # value: "tagValue", # required
1460
2066
  # },
1461
2067
  # ],
1462
- # label_schema: { # required
1463
- # label_key: "string", # required
1464
- # label_mapper: { # required
1465
- # "string" => ["string"],
1466
- # },
1467
- # },
1468
2068
  # })
1469
2069
  #
1470
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutModel AWS API Documentation
2070
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutLabel AWS API Documentation
1471
2071
  #
1472
- # @overload put_model(params = {})
2072
+ # @overload put_label(params = {})
1473
2073
  # @param [Hash] params ({})
1474
- def put_model(params = {}, options = {})
1475
- req = build_request(:put_model, params)
2074
+ def put_label(params = {}, options = {})
2075
+ req = build_request(:put_label, params)
1476
2076
  req.send_request(options)
1477
2077
  end
1478
2078
 
@@ -1484,6 +2084,9 @@ module Aws::FraudDetector
1484
2084
  # @option params [String] :description
1485
2085
  # The outcome description.
1486
2086
  #
2087
+ # @option params [Array<Types::Tag>] :tags
2088
+ # A collection of key and value pairs.
2089
+ #
1487
2090
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1488
2091
  #
1489
2092
  # @example Request syntax with placeholder values
@@ -1491,6 +2094,12 @@ module Aws::FraudDetector
1491
2094
  # resp = client.put_outcome({
1492
2095
  # name: "identifier", # required
1493
2096
  # description: "description",
2097
+ # tags: [
2098
+ # {
2099
+ # key: "tagKey", # required
2100
+ # value: "tagValue", # required
2101
+ # },
2102
+ # ],
1494
2103
  # })
1495
2104
  #
1496
2105
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutOutcome AWS API Documentation
@@ -1502,9 +2111,67 @@ module Aws::FraudDetector
1502
2111
  req.send_request(options)
1503
2112
  end
1504
2113
 
2114
+ # Assigns tags to a resource.
2115
+ #
2116
+ # @option params [required, String] :resource_arn
2117
+ # The resource ARN.
2118
+ #
2119
+ # @option params [required, Array<Types::Tag>] :tags
2120
+ # The tags to assign to the resource.
2121
+ #
2122
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2123
+ #
2124
+ # @example Request syntax with placeholder values
2125
+ #
2126
+ # resp = client.tag_resource({
2127
+ # resource_arn: "fraudDetectorArn", # required
2128
+ # tags: [ # required
2129
+ # {
2130
+ # key: "tagKey", # required
2131
+ # value: "tagValue", # required
2132
+ # },
2133
+ # ],
2134
+ # })
2135
+ #
2136
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/TagResource AWS API Documentation
2137
+ #
2138
+ # @overload tag_resource(params = {})
2139
+ # @param [Hash] params ({})
2140
+ def tag_resource(params = {}, options = {})
2141
+ req = build_request(:tag_resource, params)
2142
+ req.send_request(options)
2143
+ end
2144
+
2145
+ # Removes tags from a resource.
2146
+ #
2147
+ # @option params [required, String] :resource_arn
2148
+ # The ARN of the resource from which to remove the tag.
2149
+ #
2150
+ # @option params [required, Array<String>] :tag_keys
2151
+ # The resource ARN.
2152
+ #
2153
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2154
+ #
2155
+ # @example Request syntax with placeholder values
2156
+ #
2157
+ # resp = client.untag_resource({
2158
+ # resource_arn: "fraudDetectorArn", # required
2159
+ # tag_keys: ["tagKey"], # required
2160
+ # })
2161
+ #
2162
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UntagResource AWS API Documentation
2163
+ #
2164
+ # @overload untag_resource(params = {})
2165
+ # @param [Hash] params ({})
2166
+ def untag_resource(params = {}, options = {})
2167
+ req = build_request(:untag_resource, params)
2168
+ req.send_request(options)
2169
+ end
2170
+
1505
2171
  # Updates a detector version. The detector version attributes that you
1506
- # can update include models, external model endpoints, rules, and
1507
- # description. You can only update a `DRAFT` detector version.
2172
+ # can update include models, external model endpoints, rules, rule
2173
+ # execution mode, and description. You can only update a `DRAFT`
2174
+ # detector version.
1508
2175
  #
1509
2176
  # @option params [required, String] :detector_id
1510
2177
  # The parent detector ID for the detector version you want to update.
@@ -1546,13 +2213,13 @@ module Aws::FraudDetector
1546
2213
  #
1547
2214
  # resp = client.update_detector_version({
1548
2215
  # detector_id: "identifier", # required
1549
- # detector_version_id: "nonEmptyString", # required
2216
+ # detector_version_id: "wholeNumberVersionString", # required
1550
2217
  # external_model_endpoints: ["string"], # required
1551
2218
  # rules: [ # required
1552
2219
  # {
1553
2220
  # detector_id: "identifier", # required
1554
2221
  # rule_id: "identifier", # required
1555
- # rule_version: "nonEmptyString", # required
2222
+ # rule_version: "wholeNumberVersionString", # required
1556
2223
  # },
1557
2224
  # ],
1558
2225
  # description: "description",
@@ -1561,6 +2228,7 @@ module Aws::FraudDetector
1561
2228
  # model_id: "identifier", # required
1562
2229
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1563
2230
  # model_version_number: "nonEmptyString", # required
2231
+ # arn: "fraudDetectorArn",
1564
2232
  # },
1565
2233
  # ],
1566
2234
  # rule_execution_mode: "ALL_MATCHED", # accepts ALL_MATCHED, FIRST_MATCHED
@@ -1593,7 +2261,7 @@ module Aws::FraudDetector
1593
2261
  #
1594
2262
  # resp = client.update_detector_version_metadata({
1595
2263
  # detector_id: "identifier", # required
1596
- # detector_version_id: "nonEmptyString", # required
2264
+ # detector_version_id: "wholeNumberVersionString", # required
1597
2265
  # description: "description", # required
1598
2266
  # })
1599
2267
  #
@@ -1625,7 +2293,7 @@ module Aws::FraudDetector
1625
2293
  #
1626
2294
  # resp = client.update_detector_version_status({
1627
2295
  # detector_id: "identifier", # required
1628
- # detector_version_id: "nonEmptyString", # required
2296
+ # detector_version_id: "wholeNumberVersionString", # required
1629
2297
  # status: "DRAFT", # required, accepts DRAFT, ACTIVE, INACTIVE
1630
2298
  # })
1631
2299
  #
@@ -1638,13 +2306,43 @@ module Aws::FraudDetector
1638
2306
  req.send_request(options)
1639
2307
  end
1640
2308
 
1641
- # Updates a model version. You can update the description and status
1642
- # attributes using this action. You can perform the following status
1643
- # updates:
2309
+ # Updates a model. You can update the description attribute using this
2310
+ # action.
2311
+ #
2312
+ # @option params [required, String] :model_id
2313
+ # The model ID.
2314
+ #
2315
+ # @option params [required, String] :model_type
2316
+ # The model type.
2317
+ #
2318
+ # @option params [String] :description
2319
+ # The new model description.
2320
+ #
2321
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2322
+ #
2323
+ # @example Request syntax with placeholder values
2324
+ #
2325
+ # resp = client.update_model({
2326
+ # model_id: "identifier", # required
2327
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
2328
+ # description: "description",
2329
+ # })
1644
2330
  #
1645
- # 1. Change the `TRAINING_COMPLETE` status to `ACTIVE`
2331
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModel AWS API Documentation
1646
2332
  #
1647
- # 2. Change `ACTIVE` back to `TRAINING_COMPLETE`
2333
+ # @overload update_model(params = {})
2334
+ # @param [Hash] params ({})
2335
+ def update_model(params = {}, options = {})
2336
+ req = build_request(:update_model, params)
2337
+ req.send_request(options)
2338
+ end
2339
+
2340
+ # Updates a model version. Updating a model version retrains an existing
2341
+ # model version using updated training data and produces a new minor
2342
+ # version of the model. You can update the training data set location
2343
+ # and data access role attributes using this action. This action creates
2344
+ # and trains a new minor version of the model, for example version 1.01,
2345
+ # 1.02, 1.03.
1648
2346
  #
1649
2347
  # @option params [required, String] :model_id
1650
2348
  # The model ID.
@@ -1652,27 +2350,47 @@ module Aws::FraudDetector
1652
2350
  # @option params [required, String] :model_type
1653
2351
  # The model type.
1654
2352
  #
1655
- # @option params [required, String] :model_version_number
1656
- # The model version.
2353
+ # @option params [required, String] :major_version_number
2354
+ # The major version number.
1657
2355
  #
1658
- # @option params [required, String] :description
1659
- # The model description.
2356
+ # @option params [Types::ExternalEventsDetail] :external_events_detail
2357
+ # The event details.
1660
2358
  #
1661
- # @option params [required, String] :status
1662
- # The new model status.
2359
+ # @option params [Array<Types::Tag>] :tags
2360
+ # A collection of key and value pairs.
1663
2361
  #
1664
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2362
+ # @return [Types::UpdateModelVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2363
+ #
2364
+ # * {Types::UpdateModelVersionResult#model_id #model_id} => String
2365
+ # * {Types::UpdateModelVersionResult#model_type #model_type} => String
2366
+ # * {Types::UpdateModelVersionResult#model_version_number #model_version_number} => String
2367
+ # * {Types::UpdateModelVersionResult#status #status} => String
1665
2368
  #
1666
2369
  # @example Request syntax with placeholder values
1667
2370
  #
1668
2371
  # resp = client.update_model_version({
1669
2372
  # model_id: "identifier", # required
1670
2373
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1671
- # model_version_number: "nonEmptyString", # required
1672
- # description: "description", # required
1673
- # status: "TRAINING_IN_PROGRESS", # required, accepts TRAINING_IN_PROGRESS, TRAINING_COMPLETE, ACTIVATE_REQUESTED, ACTIVATE_IN_PROGRESS, ACTIVE, INACTIVATE_IN_PROGRESS, INACTIVE, ERROR
2374
+ # major_version_number: "wholeNumberVersionString", # required
2375
+ # external_events_detail: {
2376
+ # data_location: "s3BucketLocation", # required
2377
+ # data_access_role_arn: "iamRoleArn", # required
2378
+ # },
2379
+ # tags: [
2380
+ # {
2381
+ # key: "tagKey", # required
2382
+ # value: "tagValue", # required
2383
+ # },
2384
+ # ],
1674
2385
  # })
1675
2386
  #
2387
+ # @example Response structure
2388
+ #
2389
+ # resp.model_id #=> String
2390
+ # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
2391
+ # resp.model_version_number #=> String
2392
+ # resp.status #=> String
2393
+ #
1676
2394
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelVersion AWS API Documentation
1677
2395
  #
1678
2396
  # @overload update_model_version(params = {})
@@ -1682,7 +2400,47 @@ module Aws::FraudDetector
1682
2400
  req.send_request(options)
1683
2401
  end
1684
2402
 
1685
- # Updates a rule's metadata.
2403
+ # Updates the status of a model version.
2404
+ #
2405
+ # You can perform the following status updates:
2406
+ #
2407
+ # 1. Change the `TRAINING_COMPLETE` status to `ACTIVE`.
2408
+ #
2409
+ # 2. Change `ACTIVE`to `INACTIVE`.
2410
+ #
2411
+ # @option params [required, String] :model_id
2412
+ # The model ID of the model version to update.
2413
+ #
2414
+ # @option params [required, String] :model_type
2415
+ # The model type.
2416
+ #
2417
+ # @option params [required, String] :model_version_number
2418
+ # The model version number.
2419
+ #
2420
+ # @option params [required, String] :status
2421
+ # The model version status.
2422
+ #
2423
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2424
+ #
2425
+ # @example Request syntax with placeholder values
2426
+ #
2427
+ # resp = client.update_model_version_status({
2428
+ # model_id: "identifier", # required
2429
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
2430
+ # model_version_number: "floatVersionString", # required
2431
+ # status: "TRAINING_IN_PROGRESS", # required, accepts TRAINING_IN_PROGRESS, TRAINING_COMPLETE, ACTIVATE_REQUESTED, ACTIVATE_IN_PROGRESS, ACTIVE, INACTIVATE_IN_PROGRESS, INACTIVE, DELETE_REQUESTED, DELETE_IN_PROGRESS, ERROR
2432
+ # })
2433
+ #
2434
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelVersionStatus AWS API Documentation
2435
+ #
2436
+ # @overload update_model_version_status(params = {})
2437
+ # @param [Hash] params ({})
2438
+ def update_model_version_status(params = {}, options = {})
2439
+ req = build_request(:update_model_version_status, params)
2440
+ req.send_request(options)
2441
+ end
2442
+
2443
+ # Updates a rule's metadata. The description attribute can be updated.
1686
2444
  #
1687
2445
  # @option params [required, Types::Rule] :rule
1688
2446
  # The rule to update.
@@ -1698,7 +2456,7 @@ module Aws::FraudDetector
1698
2456
  # rule: { # required
1699
2457
  # detector_id: "identifier", # required
1700
2458
  # rule_id: "identifier", # required
1701
- # rule_version: "nonEmptyString", # required
2459
+ # rule_version: "wholeNumberVersionString", # required
1702
2460
  # },
1703
2461
  # description: "description", # required
1704
2462
  # })
@@ -1712,7 +2470,8 @@ module Aws::FraudDetector
1712
2470
  req.send_request(options)
1713
2471
  end
1714
2472
 
1715
- # Updates a rule version resulting in a new rule version.
2473
+ # Updates a rule version resulting in a new rule version. Updates a rule
2474
+ # version resulting in a new rule version (version 1, 2, 3 ...).
1716
2475
  #
1717
2476
  # @option params [required, Types::Rule] :rule
1718
2477
  # The rule to update.
@@ -1729,6 +2488,9 @@ module Aws::FraudDetector
1729
2488
  # @option params [required, Array<String>] :outcomes
1730
2489
  # The outcomes.
1731
2490
  #
2491
+ # @option params [Array<Types::Tag>] :tags
2492
+ # The tags to assign to the rule version.
2493
+ #
1732
2494
  # @return [Types::UpdateRuleVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1733
2495
  #
1734
2496
  # * {Types::UpdateRuleVersionResult#rule #rule} => Types::Rule
@@ -1739,12 +2501,18 @@ module Aws::FraudDetector
1739
2501
  # rule: { # required
1740
2502
  # detector_id: "identifier", # required
1741
2503
  # rule_id: "identifier", # required
1742
- # rule_version: "nonEmptyString", # required
2504
+ # rule_version: "wholeNumberVersionString", # required
1743
2505
  # },
1744
2506
  # description: "description",
1745
2507
  # expression: "ruleExpression", # required
1746
2508
  # language: "DETECTORPL", # required, accepts DETECTORPL
1747
2509
  # outcomes: ["string"], # required
2510
+ # tags: [
2511
+ # {
2512
+ # key: "tagKey", # required
2513
+ # value: "tagValue", # required
2514
+ # },
2515
+ # ],
1748
2516
  # })
1749
2517
  #
1750
2518
  # @example Response structure
@@ -1809,7 +2577,7 @@ module Aws::FraudDetector
1809
2577
  params: params,
1810
2578
  config: config)
1811
2579
  context[:gem_name] = 'aws-sdk-frauddetector'
1812
- context[:gem_version] = '1.6.0'
2580
+ context[:gem_version] = '1.7.0'
1813
2581
  Seahorse::Client::Request.new(handlers, context)
1814
2582
  end
1815
2583