aws-sdk-frauddetector 1.5.1 → 1.10.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: a7bc9c837a2dced26995dd842a379e5a09605fad2408ba063973a87890c20b6b
4
- data.tar.gz: 6f82f982139961b3fb9df5214167e547ef330f95823554687c494a7cc2e29830
3
+ metadata.gz: 0dde17627f67ac65d95237188c57e283c8ef62d2f9acd43e397592b6f76e0332
4
+ data.tar.gz: 1fee3ee226b414fcafa4f015ca47e94bfb7145a51062100ea397c61fb3153ca5
5
5
  SHA512:
6
- metadata.gz: 84ccf4578bdb206fc1ae2ea2dfb628d7aecf83fe97e738ce21ab226e64fa3d5b273d4bb8687e1c59b43aa40083e748ff43c01b13b975252ab2b272f4727e5ddc
7
- data.tar.gz: 235dfcb901764d14ed09720384a226effefa87f2b59897345905bf17dc37b91ff87f56a722e0482fff576854e0a7d9375606ccf62a76d86d9518f5b2bc35cc70
6
+ metadata.gz: dd2834139eba5748d270f7ec3f42f0102ff17db109b20d19263cb1e7c70a767a1912044c4d6e1503a69a2e1aa3ebfecf2bc8966ff5632e3c12ebb336141e048d
7
+ data.tar.gz: 1f4fae56f0167fae4102ae9d5a478de4e303d47edd16820d63f414dbc260690bcec58f9d72fc6120a33d4eb595c3525d444117f5d38fe6fa70856abfac7bbb8b
@@ -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:
@@ -42,9 +44,9 @@ require_relative 'aws-sdk-frauddetector/customizations'
42
44
  #
43
45
  # See {Errors} for more information.
44
46
  #
45
- # @service
47
+ # @!group service
46
48
  module Aws::FraudDetector
47
49
 
48
- GEM_VERSION = '1.5.1'
50
+ GEM_VERSION = '1.10.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:
@@ -83,13 +85,28 @@ module Aws::FraudDetector
83
85
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
84
86
  # credentials.
85
87
  #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
86
102
  # * `Aws::InstanceProfileCredentials` - Used for loading credentials
87
103
  # from an EC2 IMDS on an EC2 instance.
88
104
  #
89
- # * `Aws::SharedCredentials` - Used for loading credentials from a
90
- # shared file, such as `~/.aws/config`.
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
91
107
  #
92
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
93
110
  #
94
111
  # When `:credentials` are not configured directly, the following
95
112
  # locations will be searched for credentials:
@@ -99,10 +116,10 @@ module Aws::FraudDetector
99
116
  # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
100
117
  # * `~/.aws/credentials`
101
118
  # * `~/.aws/config`
102
- # * EC2 IMDS instance profile - When used by default, the timeouts are
103
- # very aggressive. Construct and pass an instance of
104
- # `Aws::InstanceProfileCredentails` to enable retries and extended
105
- # timeouts.
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
106
123
  #
107
124
  # @option options [required, String] :region
108
125
  # The AWS region to connect to. The configured `:region` is
@@ -325,6 +342,9 @@ module Aws::FraudDetector
325
342
  # @option params [required, Array<Types::VariableEntry>] :variable_entries
326
343
  # The list of variables for the batch create variable request.
327
344
  #
345
+ # @option params [Array<Types::Tag>] :tags
346
+ # A collection of key and value pairs.
347
+ #
328
348
  # @return [Types::BatchCreateVariableResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
329
349
  #
330
350
  # * {Types::BatchCreateVariableResult#errors #errors} => Array&lt;Types::BatchCreateVariableError&gt;
@@ -342,6 +362,12 @@ module Aws::FraudDetector
342
362
  # variable_type: "string",
343
363
  # },
344
364
  # ],
365
+ # tags: [
366
+ # {
367
+ # key: "tagKey", # required
368
+ # value: "tagValue", # required
369
+ # },
370
+ # ],
345
371
  # })
346
372
  #
347
373
  # @example Response structure
@@ -387,6 +413,7 @@ module Aws::FraudDetector
387
413
  # resp.variables[0].variable_type #=> String
388
414
  # resp.variables[0].last_updated_time #=> String
389
415
  # resp.variables[0].created_time #=> String
416
+ # resp.variables[0].arn #=> String
390
417
  # resp.errors #=> Array
391
418
  # resp.errors[0].name #=> String
392
419
  # resp.errors[0].code #=> Integer
@@ -437,6 +464,9 @@ module Aws::FraudDetector
437
464
  #
438
465
  # The default behavior is `FIRST_MATCHED`.
439
466
  #
467
+ # @option params [Array<Types::Tag>] :tags
468
+ # A collection of key and value pairs.
469
+ #
440
470
  # @return [Types::CreateDetectorVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
441
471
  #
442
472
  # * {Types::CreateDetectorVersionResult#detector_id #detector_id} => String
@@ -453,17 +483,24 @@ module Aws::FraudDetector
453
483
  # {
454
484
  # detector_id: "identifier", # required
455
485
  # rule_id: "identifier", # required
456
- # rule_version: "nonEmptyString", # required
486
+ # rule_version: "wholeNumberVersionString", # required
457
487
  # },
458
488
  # ],
459
489
  # model_versions: [
460
490
  # {
461
- # model_id: "identifier", # required
491
+ # model_id: "modelIdentifier", # required
462
492
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
463
493
  # model_version_number: "nonEmptyString", # required
494
+ # arn: "fraudDetectorArn",
464
495
  # },
465
496
  # ],
466
497
  # rule_execution_mode: "ALL_MATCHED", # accepts ALL_MATCHED, FIRST_MATCHED
498
+ # tags: [
499
+ # {
500
+ # key: "tagKey", # required
501
+ # value: "tagValue", # required
502
+ # },
503
+ # ],
467
504
  # })
468
505
  #
469
506
  # @example Response structure
@@ -481,7 +518,7 @@ module Aws::FraudDetector
481
518
  req.send_request(options)
482
519
  end
483
520
 
484
- # Creates a version of the model using the specified model type.
521
+ # Creates a model using the specified model type.
485
522
  #
486
523
  # @option params [required, String] :model_id
487
524
  # The model ID.
@@ -490,7 +527,61 @@ module Aws::FraudDetector
490
527
  # The model type.
491
528
  #
492
529
  # @option params [String] :description
493
- # The model version description.
530
+ # The model description.
531
+ #
532
+ # @option params [required, String] :event_type_name
533
+ # The name of the event type.
534
+ #
535
+ # @option params [Array<Types::Tag>] :tags
536
+ # A collection of key and value pairs.
537
+ #
538
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
539
+ #
540
+ # @example Request syntax with placeholder values
541
+ #
542
+ # resp = client.create_model({
543
+ # model_id: "modelIdentifier", # required
544
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
545
+ # description: "description",
546
+ # event_type_name: "string", # required
547
+ # tags: [
548
+ # {
549
+ # key: "tagKey", # required
550
+ # value: "tagValue", # required
551
+ # },
552
+ # ],
553
+ # })
554
+ #
555
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateModel AWS API Documentation
556
+ #
557
+ # @overload create_model(params = {})
558
+ # @param [Hash] params ({})
559
+ def create_model(params = {}, options = {})
560
+ req = build_request(:create_model, params)
561
+ req.send_request(options)
562
+ end
563
+
564
+ # Creates a version of the model using the specified model type and
565
+ # model id.
566
+ #
567
+ # @option params [required, String] :model_id
568
+ # The model ID.
569
+ #
570
+ # @option params [required, String] :model_type
571
+ # The model type.
572
+ #
573
+ # @option params [required, String] :training_data_source
574
+ # The training data source location in Amazon S3.
575
+ #
576
+ # @option params [required, Types::TrainingDataSchema] :training_data_schema
577
+ # The training data schema.
578
+ #
579
+ # @option params [Types::ExternalEventsDetail] :external_events_detail
580
+ # Details for the external events data used for model version training.
581
+ # Required if `trainingDataSource` is `EXTERNAL_EVENTS`.
582
+ #
583
+ # @option params [Array<Types::Tag>] :tags
584
+ # A collection of key and value pairs.
494
585
  #
495
586
  # @return [Types::CreateModelVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
496
587
  #
@@ -502,9 +593,27 @@ module Aws::FraudDetector
502
593
  # @example Request syntax with placeholder values
503
594
  #
504
595
  # resp = client.create_model_version({
505
- # model_id: "identifier", # required
596
+ # model_id: "modelIdentifier", # required
506
597
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
507
- # description: "description",
598
+ # training_data_source: "EXTERNAL_EVENTS", # required, accepts EXTERNAL_EVENTS
599
+ # training_data_schema: { # required
600
+ # model_variables: ["string"], # required
601
+ # label_schema: { # required
602
+ # label_mapper: { # required
603
+ # "string" => ["string"],
604
+ # },
605
+ # },
606
+ # },
607
+ # external_events_detail: {
608
+ # data_location: "s3BucketLocation", # required
609
+ # data_access_role_arn: "iamRoleArn", # required
610
+ # },
611
+ # tags: [
612
+ # {
613
+ # key: "tagKey", # required
614
+ # value: "tagValue", # required
615
+ # },
616
+ # ],
508
617
  # })
509
618
  #
510
619
  # @example Response structure
@@ -543,6 +652,9 @@ module Aws::FraudDetector
543
652
  # @option params [required, Array<String>] :outcomes
544
653
  # The outcome or outcomes returned when the rule expression matches.
545
654
  #
655
+ # @option params [Array<Types::Tag>] :tags
656
+ # A collection of key and value pairs.
657
+ #
546
658
  # @return [Types::CreateRuleResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
547
659
  #
548
660
  # * {Types::CreateRuleResult#rule #rule} => Types::Rule
@@ -556,6 +668,12 @@ module Aws::FraudDetector
556
668
  # expression: "ruleExpression", # required
557
669
  # language: "DETECTORPL", # required, accepts DETECTORPL
558
670
  # outcomes: ["string"], # required
671
+ # tags: [
672
+ # {
673
+ # key: "tagKey", # required
674
+ # value: "tagValue", # required
675
+ # },
676
+ # ],
559
677
  # })
560
678
  #
561
679
  # @example Response structure
@@ -591,7 +709,24 @@ module Aws::FraudDetector
591
709
  # The description.
592
710
  #
593
711
  # @option params [String] :variable_type
594
- # The variable type.
712
+ # The variable type. For more information see [Variable types][1].
713
+ #
714
+ # Valid Values: `AUTH_CODE | AVS | BILLING_ADDRESS_L1 |
715
+ # BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME |
716
+ # BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL |
717
+ # CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL |
718
+ # FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE |
719
+ # PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 |
720
+ # SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME
721
+ # | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT |
722
+ # SHIPPING_ZIP | USERAGENT`
723
+ #
724
+ #
725
+ #
726
+ # [1]: https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types
727
+ #
728
+ # @option params [Array<Types::Tag>] :tags
729
+ # A collection of key and value pairs.
595
730
  #
596
731
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
597
732
  #
@@ -604,6 +739,12 @@ module Aws::FraudDetector
604
739
  # default_value: "string", # required
605
740
  # description: "string",
606
741
  # variable_type: "string",
742
+ # tags: [
743
+ # {
744
+ # key: "tagKey", # required
745
+ # value: "tagValue", # required
746
+ # },
747
+ # ],
607
748
  # })
608
749
  #
609
750
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateVariable AWS API Documentation
@@ -654,7 +795,7 @@ module Aws::FraudDetector
654
795
  #
655
796
  # resp = client.delete_detector_version({
656
797
  # detector_id: "identifier", # required
657
- # detector_version_id: "nonEmptyString", # required
798
+ # detector_version_id: "wholeNumberVersionString", # required
658
799
  # })
659
800
  #
660
801
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteDetectorVersion AWS API Documentation
@@ -671,12 +812,16 @@ module Aws::FraudDetector
671
812
  # @option params [required, String] :event_id
672
813
  # The ID of the event to delete.
673
814
  #
815
+ # @option params [required, String] :event_type_name
816
+ # The name of the event type.
817
+ #
674
818
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
675
819
  #
676
820
  # @example Request syntax with placeholder values
677
821
  #
678
822
  # resp = client.delete_event({
679
823
  # event_id: "string", # required
824
+ # event_type_name: "string", # required
680
825
  # })
681
826
  #
682
827
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteEvent AWS API Documentation
@@ -688,34 +833,30 @@ module Aws::FraudDetector
688
833
  req.send_request(options)
689
834
  end
690
835
 
691
- # Deletes the rule version. You cannot delete a rule version if it is
692
- # used by an `ACTIVE` or `INACTIVE` detector version.
693
- #
694
- # @option params [required, String] :detector_id
695
- # The ID of the detector that includes the rule version to delete.
696
- #
697
- # @option params [required, String] :rule_id
698
- # The rule ID of the rule version to delete.
836
+ # Deletes the rule. You cannot delete a rule if it is used by an
837
+ # `ACTIVE` or `INACTIVE` detector version.
699
838
  #
700
- # @option params [required, String] :rule_version
701
- # The rule version to delete.
839
+ # @option params [required, Types::Rule] :rule
840
+ # A rule.
702
841
  #
703
842
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
704
843
  #
705
844
  # @example Request syntax with placeholder values
706
845
  #
707
- # resp = client.delete_rule_version({
708
- # detector_id: "identifier", # required
709
- # rule_id: "identifier", # required
710
- # rule_version: "nonEmptyString", # required
846
+ # resp = client.delete_rule({
847
+ # rule: { # required
848
+ # detector_id: "identifier", # required
849
+ # rule_id: "identifier", # required
850
+ # rule_version: "wholeNumberVersionString", # required
851
+ # },
711
852
  # })
712
853
  #
713
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteRuleVersion AWS API Documentation
854
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteRule AWS API Documentation
714
855
  #
715
- # @overload delete_rule_version(params = {})
856
+ # @overload delete_rule(params = {})
716
857
  # @param [Hash] params ({})
717
- def delete_rule_version(params = {}, options = {})
718
- req = build_request(:delete_rule_version, params)
858
+ def delete_rule(params = {}, options = {})
859
+ req = build_request(:delete_rule, params)
719
860
  req.send_request(options)
720
861
  end
721
862
 
@@ -735,6 +876,7 @@ module Aws::FraudDetector
735
876
  # * {Types::DescribeDetectorResult#detector_id #detector_id} => String
736
877
  # * {Types::DescribeDetectorResult#detector_version_summaries #detector_version_summaries} => Array&lt;Types::DetectorVersionSummary&gt;
737
878
  # * {Types::DescribeDetectorResult#next_token #next_token} => String
879
+ # * {Types::DescribeDetectorResult#arn #arn} => String
738
880
  #
739
881
  # @example Request syntax with placeholder values
740
882
  #
@@ -753,6 +895,7 @@ module Aws::FraudDetector
753
895
  # resp.detector_version_summaries[0].description #=> String
754
896
  # resp.detector_version_summaries[0].last_updated_time #=> String
755
897
  # resp.next_token #=> String
898
+ # resp.arn #=> String
756
899
  #
757
900
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DescribeDetector AWS API Documentation
758
901
  #
@@ -771,7 +914,7 @@ module Aws::FraudDetector
771
914
  # The model ID.
772
915
  #
773
916
  # @option params [String] :model_version_number
774
- # The model version.
917
+ # The model version number.
775
918
  #
776
919
  # @option params [String] :model_type
777
920
  # The model type.
@@ -792,8 +935,8 @@ module Aws::FraudDetector
792
935
  # @example Request syntax with placeholder values
793
936
  #
794
937
  # resp = client.describe_model_versions({
795
- # model_id: "identifier",
796
- # model_version_number: "nonEmptyString",
938
+ # model_id: "modelIdentifier",
939
+ # model_version_number: "floatVersionString",
797
940
  # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
798
941
  # next_token: "string",
799
942
  # max_results: 1,
@@ -805,23 +948,34 @@ module Aws::FraudDetector
805
948
  # resp.model_version_details[0].model_id #=> String
806
949
  # resp.model_version_details[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
807
950
  # resp.model_version_details[0].model_version_number #=> String
808
- # resp.model_version_details[0].description #=> String
809
951
  # resp.model_version_details[0].status #=> String
810
- # resp.model_version_details[0].training_data_source.data_location #=> String
811
- # resp.model_version_details[0].training_data_source.data_access_role_arn #=> String
812
- # resp.model_version_details[0].model_variables #=> Array
813
- # resp.model_version_details[0].model_variables[0].name #=> String
814
- # resp.model_version_details[0].model_variables[0].index #=> Integer
815
- # resp.model_version_details[0].label_schema.label_key #=> String
816
- # resp.model_version_details[0].label_schema.label_mapper #=> Hash
817
- # resp.model_version_details[0].label_schema.label_mapper["string"] #=> Array
818
- # resp.model_version_details[0].label_schema.label_mapper["string"][0] #=> String
819
- # resp.model_version_details[0].validation_metrics #=> Hash
820
- # resp.model_version_details[0].validation_metrics["string"] #=> String
821
- # resp.model_version_details[0].training_metrics #=> Hash
822
- # resp.model_version_details[0].training_metrics["string"] #=> String
952
+ # resp.model_version_details[0].training_data_source #=> String, one of "EXTERNAL_EVENTS"
953
+ # resp.model_version_details[0].training_data_schema.model_variables #=> Array
954
+ # resp.model_version_details[0].training_data_schema.model_variables[0] #=> String
955
+ # resp.model_version_details[0].training_data_schema.label_schema.label_mapper #=> Hash
956
+ # resp.model_version_details[0].training_data_schema.label_schema.label_mapper["string"] #=> Array
957
+ # resp.model_version_details[0].training_data_schema.label_schema.label_mapper["string"][0] #=> String
958
+ # resp.model_version_details[0].external_events_detail.data_location #=> String
959
+ # resp.model_version_details[0].external_events_detail.data_access_role_arn #=> String
960
+ # resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages #=> Array
961
+ # resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages[0].title #=> String
962
+ # resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages[0].content #=> String
963
+ # resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages[0].type #=> String
964
+ # resp.model_version_details[0].training_result.data_validation_metrics.field_level_messages #=> Array
965
+ # resp.model_version_details[0].training_result.data_validation_metrics.field_level_messages[0].field_name #=> String
966
+ # resp.model_version_details[0].training_result.data_validation_metrics.field_level_messages[0].identifier #=> String
967
+ # resp.model_version_details[0].training_result.data_validation_metrics.field_level_messages[0].title #=> String
968
+ # resp.model_version_details[0].training_result.data_validation_metrics.field_level_messages[0].content #=> String
969
+ # resp.model_version_details[0].training_result.data_validation_metrics.field_level_messages[0].type #=> String
970
+ # resp.model_version_details[0].training_result.training_metrics.auc #=> Float
971
+ # resp.model_version_details[0].training_result.training_metrics.metric_data_points #=> Array
972
+ # resp.model_version_details[0].training_result.training_metrics.metric_data_points[0].fpr #=> Float
973
+ # resp.model_version_details[0].training_result.training_metrics.metric_data_points[0].precision #=> Float
974
+ # resp.model_version_details[0].training_result.training_metrics.metric_data_points[0].tpr #=> Float
975
+ # resp.model_version_details[0].training_result.training_metrics.metric_data_points[0].threshold #=> Float
823
976
  # resp.model_version_details[0].last_updated_time #=> String
824
977
  # resp.model_version_details[0].created_time #=> String
978
+ # resp.model_version_details[0].arn #=> String
825
979
  # resp.next_token #=> String
826
980
  #
827
981
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DescribeModelVersions AWS API Documentation
@@ -853,12 +1007,13 @@ module Aws::FraudDetector
853
1007
  # * {Types::GetDetectorVersionResult#last_updated_time #last_updated_time} => String
854
1008
  # * {Types::GetDetectorVersionResult#created_time #created_time} => String
855
1009
  # * {Types::GetDetectorVersionResult#rule_execution_mode #rule_execution_mode} => String
1010
+ # * {Types::GetDetectorVersionResult#arn #arn} => String
856
1011
  #
857
1012
  # @example Request syntax with placeholder values
858
1013
  #
859
1014
  # resp = client.get_detector_version({
860
1015
  # detector_id: "identifier", # required
861
- # detector_version_id: "nonEmptyString", # required
1016
+ # detector_version_id: "wholeNumberVersionString", # required
862
1017
  # })
863
1018
  #
864
1019
  # @example Response structure
@@ -872,6 +1027,7 @@ module Aws::FraudDetector
872
1027
  # resp.model_versions[0].model_id #=> String
873
1028
  # resp.model_versions[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
874
1029
  # resp.model_versions[0].model_version_number #=> String
1030
+ # resp.model_versions[0].arn #=> String
875
1031
  # resp.rules #=> Array
876
1032
  # resp.rules[0].detector_id #=> String
877
1033
  # resp.rules[0].rule_id #=> String
@@ -880,6 +1036,7 @@ module Aws::FraudDetector
880
1036
  # resp.last_updated_time #=> String
881
1037
  # resp.created_time #=> String
882
1038
  # resp.rule_execution_mode #=> String, one of "ALL_MATCHED", "FIRST_MATCHED"
1039
+ # resp.arn #=> String
883
1040
  #
884
1041
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetDetectorVersion AWS API Documentation
885
1042
  #
@@ -890,12 +1047,13 @@ module Aws::FraudDetector
890
1047
  req.send_request(options)
891
1048
  end
892
1049
 
893
- # Gets all of detectors. This is a paginated API. If you provide a null
894
- # `maxSizePerPage`, this actions retrieves a maximum of 10 records per
895
- # page. If you provide a `maxSizePerPage`, the value must be between 5
896
- # and 10. To get the next page results, provide the pagination token
897
- # from the `GetEventTypesResponse` as part of your request. A null
898
- # pagination token fetches the records from the beginning.
1050
+ # Gets all detectors or a single detector if a `detectorId` is
1051
+ # specified. This is a paginated API. If you provide a null
1052
+ # `maxResults`, this action retrieves a maximum of 10 records per page.
1053
+ # If you provide a `maxResults`, the value must be between 5 and 10. To
1054
+ # get the next page results, provide the pagination token from the
1055
+ # `GetDetectorsResponse` as part of your request. A null pagination
1056
+ # token fetches the records from the beginning.
899
1057
  #
900
1058
  # @option params [String] :detector_id
901
1059
  # The detector ID.
@@ -926,8 +1084,10 @@ module Aws::FraudDetector
926
1084
  # resp.detectors #=> Array
927
1085
  # resp.detectors[0].detector_id #=> String
928
1086
  # resp.detectors[0].description #=> String
1087
+ # resp.detectors[0].event_type_name #=> String
929
1088
  # resp.detectors[0].last_updated_time #=> String
930
1089
  # resp.detectors[0].created_time #=> String
1090
+ # resp.detectors[0].arn #=> String
931
1091
  # resp.next_token #=> String
932
1092
  #
933
1093
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetDetectors AWS API Documentation
@@ -939,14 +1099,206 @@ module Aws::FraudDetector
939
1099
  req.send_request(options)
940
1100
  end
941
1101
 
1102
+ # Gets all entity types or a specific entity type if a name is
1103
+ # specified. This is a paginated API. If you provide a null
1104
+ # `maxResults`, this action retrieves a maximum of 10 records per page.
1105
+ # If you provide a `maxResults`, the value must be between 5 and 10. To
1106
+ # get the next page results, provide the pagination token from the
1107
+ # `GetEntityTypesResponse` as part of your request. A null pagination
1108
+ # token fetches the records from the beginning.
1109
+ #
1110
+ # @option params [String] :name
1111
+ # The name.
1112
+ #
1113
+ # @option params [String] :next_token
1114
+ # The next token for the subsequent request.
1115
+ #
1116
+ # @option params [Integer] :max_results
1117
+ # The maximum number of objects to return for the request.
1118
+ #
1119
+ # @return [Types::GetEntityTypesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1120
+ #
1121
+ # * {Types::GetEntityTypesResult#entity_types #entity_types} => Array&lt;Types::EntityType&gt;
1122
+ # * {Types::GetEntityTypesResult#next_token #next_token} => String
1123
+ #
1124
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1125
+ #
1126
+ # @example Request syntax with placeholder values
1127
+ #
1128
+ # resp = client.get_entity_types({
1129
+ # name: "identifier",
1130
+ # next_token: "string",
1131
+ # max_results: 1,
1132
+ # })
1133
+ #
1134
+ # @example Response structure
1135
+ #
1136
+ # resp.entity_types #=> Array
1137
+ # resp.entity_types[0].name #=> String
1138
+ # resp.entity_types[0].description #=> String
1139
+ # resp.entity_types[0].last_updated_time #=> String
1140
+ # resp.entity_types[0].created_time #=> String
1141
+ # resp.entity_types[0].arn #=> String
1142
+ # resp.next_token #=> String
1143
+ #
1144
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEntityTypes AWS API Documentation
1145
+ #
1146
+ # @overload get_entity_types(params = {})
1147
+ # @param [Hash] params ({})
1148
+ def get_entity_types(params = {}, options = {})
1149
+ req = build_request(:get_entity_types, params)
1150
+ req.send_request(options)
1151
+ end
1152
+
1153
+ # Evaluates an event against a detector version. If a version ID is not
1154
+ # provided, the detector’s (`ACTIVE`) version is used.
1155
+ #
1156
+ # @option params [required, String] :detector_id
1157
+ # The detector ID.
1158
+ #
1159
+ # @option params [String] :detector_version_id
1160
+ # The detector version ID.
1161
+ #
1162
+ # @option params [required, String] :event_id
1163
+ # The unique ID used to identify the event.
1164
+ #
1165
+ # @option params [required, String] :event_type_name
1166
+ # The event type associated with the detector specified for the
1167
+ # prediction.
1168
+ #
1169
+ # @option params [required, Array<Types::Entity>] :entities
1170
+ # The entity type (associated with the detector's event type) and
1171
+ # specific entity ID representing who performed the event. If an entity
1172
+ # id is not available, use "UNKNOWN."
1173
+ #
1174
+ # @option params [required, String] :event_timestamp
1175
+ # Timestamp that defines when the event under evaluation occurred.
1176
+ #
1177
+ # @option params [required, Hash<String,String>] :event_variables
1178
+ # Names of the event type's variables you defined in Amazon Fraud
1179
+ # Detector to represent data elements and their corresponding values for
1180
+ # the event you are sending for evaluation.
1181
+ #
1182
+ # @option params [Hash<String,Types::ModelEndpointDataBlob>] :external_model_endpoint_data_blobs
1183
+ # The Amazon SageMaker model endpoint input data blobs.
1184
+ #
1185
+ # @return [Types::GetEventPredictionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1186
+ #
1187
+ # * {Types::GetEventPredictionResult#model_scores #model_scores} => Array&lt;Types::ModelScores&gt;
1188
+ # * {Types::GetEventPredictionResult#rule_results #rule_results} => Array&lt;Types::RuleResult&gt;
1189
+ #
1190
+ # @example Request syntax with placeholder values
1191
+ #
1192
+ # resp = client.get_event_prediction({
1193
+ # detector_id: "string", # required
1194
+ # detector_version_id: "wholeNumberVersionString",
1195
+ # event_id: "string", # required
1196
+ # event_type_name: "string", # required
1197
+ # entities: [ # required
1198
+ # {
1199
+ # entity_type: "string", # required
1200
+ # entity_id: "identifier", # required
1201
+ # },
1202
+ # ],
1203
+ # event_timestamp: "string", # required
1204
+ # event_variables: { # required
1205
+ # "variableName" => "variableValue",
1206
+ # },
1207
+ # external_model_endpoint_data_blobs: {
1208
+ # "string" => {
1209
+ # byte_buffer: "data",
1210
+ # content_type: "contentType",
1211
+ # },
1212
+ # },
1213
+ # })
1214
+ #
1215
+ # @example Response structure
1216
+ #
1217
+ # resp.model_scores #=> Array
1218
+ # resp.model_scores[0].model_version.model_id #=> String
1219
+ # resp.model_scores[0].model_version.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1220
+ # resp.model_scores[0].model_version.model_version_number #=> String
1221
+ # resp.model_scores[0].model_version.arn #=> String
1222
+ # resp.model_scores[0].scores #=> Hash
1223
+ # resp.model_scores[0].scores["string"] #=> Float
1224
+ # resp.rule_results #=> Array
1225
+ # resp.rule_results[0].rule_id #=> String
1226
+ # resp.rule_results[0].outcomes #=> Array
1227
+ # resp.rule_results[0].outcomes[0] #=> String
1228
+ #
1229
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventPrediction AWS API Documentation
1230
+ #
1231
+ # @overload get_event_prediction(params = {})
1232
+ # @param [Hash] params ({})
1233
+ def get_event_prediction(params = {}, options = {})
1234
+ req = build_request(:get_event_prediction, params)
1235
+ req.send_request(options)
1236
+ end
1237
+
1238
+ # Gets all event types or a specific event type if name is provided.
1239
+ # This is a paginated API. If you provide a null `maxResults`, this
1240
+ # action retrieves a maximum of 10 records per page. If you provide a
1241
+ # `maxResults`, the value must be between 5 and 10. To get the next page
1242
+ # results, provide the pagination token from the `GetEventTypesResponse`
1243
+ # as part of your request. A null pagination token fetches the records
1244
+ # from the beginning.
1245
+ #
1246
+ # @option params [String] :name
1247
+ # The name.
1248
+ #
1249
+ # @option params [String] :next_token
1250
+ # The next token for the subsequent request.
1251
+ #
1252
+ # @option params [Integer] :max_results
1253
+ # The maximum number of objects to return for the request.
1254
+ #
1255
+ # @return [Types::GetEventTypesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1256
+ #
1257
+ # * {Types::GetEventTypesResult#event_types #event_types} => Array&lt;Types::EventType&gt;
1258
+ # * {Types::GetEventTypesResult#next_token #next_token} => String
1259
+ #
1260
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1261
+ #
1262
+ # @example Request syntax with placeholder values
1263
+ #
1264
+ # resp = client.get_event_types({
1265
+ # name: "identifier",
1266
+ # next_token: "string",
1267
+ # max_results: 1,
1268
+ # })
1269
+ #
1270
+ # @example Response structure
1271
+ #
1272
+ # resp.event_types #=> Array
1273
+ # resp.event_types[0].name #=> String
1274
+ # resp.event_types[0].description #=> String
1275
+ # resp.event_types[0].event_variables #=> Array
1276
+ # resp.event_types[0].event_variables[0] #=> String
1277
+ # resp.event_types[0].labels #=> Array
1278
+ # resp.event_types[0].labels[0] #=> String
1279
+ # resp.event_types[0].entity_types #=> Array
1280
+ # resp.event_types[0].entity_types[0] #=> String
1281
+ # resp.event_types[0].last_updated_time #=> String
1282
+ # resp.event_types[0].created_time #=> String
1283
+ # resp.event_types[0].arn #=> String
1284
+ # resp.next_token #=> String
1285
+ #
1286
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventTypes AWS API Documentation
1287
+ #
1288
+ # @overload get_event_types(params = {})
1289
+ # @param [Hash] params ({})
1290
+ def get_event_types(params = {}, options = {})
1291
+ req = build_request(:get_event_types, params)
1292
+ req.send_request(options)
1293
+ end
1294
+
942
1295
  # Gets the details for one or more Amazon SageMaker models that have
943
1296
  # been imported into the service. This is a paginated API. If you
944
- # provide a null `maxSizePerPage`, this actions retrieves a maximum of
945
- # 10 records per page. If you provide a `maxSizePerPage`, the value must
946
- # be between 5 and 10. To get the next page results, provide the
947
- # pagination token from the `GetExternalModelsResult` as part of your
948
- # request. A null pagination token fetches the records from the
949
- # beginning.
1297
+ # provide a null `maxResults`, this actions retrieves a maximum of 10
1298
+ # records per page. If you provide a `maxResults`, the value must be
1299
+ # between 5 and 10. To get the next page results, provide the pagination
1300
+ # token from the `GetExternalModelsResult` as part of your request. A
1301
+ # null pagination token fetches the records from the beginning.
950
1302
  #
951
1303
  # @option params [String] :model_endpoint
952
1304
  # The Amazon SageMaker model endpoint.
@@ -977,10 +1329,10 @@ module Aws::FraudDetector
977
1329
  # resp.external_models #=> Array
978
1330
  # resp.external_models[0].model_endpoint #=> String
979
1331
  # resp.external_models[0].model_source #=> String, one of "SAGEMAKER"
980
- # resp.external_models[0].role.arn #=> String
981
- # resp.external_models[0].role.name #=> String
1332
+ # resp.external_models[0].invoke_model_endpoint_role_arn #=> String
1333
+ # resp.external_models[0].input_configuration.event_type_name #=> String
982
1334
  # resp.external_models[0].input_configuration.format #=> String, one of "TEXT_CSV", "APPLICATION_JSON"
983
- # resp.external_models[0].input_configuration.is_opaque #=> Boolean
1335
+ # resp.external_models[0].input_configuration.use_event_variables #=> Boolean
984
1336
  # resp.external_models[0].input_configuration.json_input_template #=> String
985
1337
  # resp.external_models[0].input_configuration.csv_input_template #=> String
986
1338
  # resp.external_models[0].output_configuration.format #=> String, one of "TEXT_CSV", "APPLICATION_JSONLINES"
@@ -991,6 +1343,7 @@ module Aws::FraudDetector
991
1343
  # resp.external_models[0].model_endpoint_status #=> String, one of "ASSOCIATED", "DISSOCIATED"
992
1344
  # resp.external_models[0].last_updated_time #=> String
993
1345
  # resp.external_models[0].created_time #=> String
1346
+ # resp.external_models[0].arn #=> String
994
1347
  # resp.next_token #=> String
995
1348
  #
996
1349
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetExternalModels AWS API Documentation
@@ -1002,7 +1355,79 @@ module Aws::FraudDetector
1002
1355
  req.send_request(options)
1003
1356
  end
1004
1357
 
1005
- # Gets a model version.
1358
+ # Gets the encryption key if a Key Management Service (KMS) customer
1359
+ # master key (CMK) has been specified to be used to encrypt content in
1360
+ # Amazon Fraud Detector.
1361
+ #
1362
+ # @return [Types::GetKMSEncryptionKeyResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1363
+ #
1364
+ # * {Types::GetKMSEncryptionKeyResult#kms_key #kms_key} => Types::KMSKey
1365
+ #
1366
+ # @example Response structure
1367
+ #
1368
+ # resp.kms_key.kms_encryption_key_arn #=> String
1369
+ #
1370
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetKMSEncryptionKey AWS API Documentation
1371
+ #
1372
+ # @overload get_kms_encryption_key(params = {})
1373
+ # @param [Hash] params ({})
1374
+ def get_kms_encryption_key(params = {}, options = {})
1375
+ req = build_request(:get_kms_encryption_key, params)
1376
+ req.send_request(options)
1377
+ end
1378
+
1379
+ # Gets all labels or a specific label if name is provided. This is a
1380
+ # paginated API. If you provide a null `maxResults`, this action
1381
+ # retrieves a maximum of 50 records per page. If you provide a
1382
+ # `maxResults`, the value must be between 10 and 50. To get the next
1383
+ # page results, provide the pagination token from the
1384
+ # `GetGetLabelsResponse` as part of your request. A null pagination
1385
+ # token fetches the records from the beginning.
1386
+ #
1387
+ # @option params [String] :name
1388
+ # The name of the label or labels to get.
1389
+ #
1390
+ # @option params [String] :next_token
1391
+ # The next token for the subsequent request.
1392
+ #
1393
+ # @option params [Integer] :max_results
1394
+ # The maximum number of objects to return for the request.
1395
+ #
1396
+ # @return [Types::GetLabelsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1397
+ #
1398
+ # * {Types::GetLabelsResult#labels #labels} => Array&lt;Types::Label&gt;
1399
+ # * {Types::GetLabelsResult#next_token #next_token} => String
1400
+ #
1401
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1402
+ #
1403
+ # @example Request syntax with placeholder values
1404
+ #
1405
+ # resp = client.get_labels({
1406
+ # name: "identifier",
1407
+ # next_token: "string",
1408
+ # max_results: 1,
1409
+ # })
1410
+ #
1411
+ # @example Response structure
1412
+ #
1413
+ # resp.labels #=> Array
1414
+ # resp.labels[0].name #=> String
1415
+ # resp.labels[0].description #=> String
1416
+ # resp.labels[0].last_updated_time #=> String
1417
+ # resp.labels[0].created_time #=> String
1418
+ # resp.labels[0].arn #=> String
1419
+ # resp.next_token #=> String
1420
+ #
1421
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetLabels AWS API Documentation
1422
+ #
1423
+ # @overload get_labels(params = {})
1424
+ # @param [Hash] params ({})
1425
+ def get_labels(params = {}, options = {})
1426
+ req = build_request(:get_labels, params)
1427
+ req.send_request(options)
1428
+ end
1429
+
1430
+ # Gets the details of the specified model version.
1006
1431
  #
1007
1432
  # @option params [required, String] :model_id
1008
1433
  # The model ID.
@@ -1011,22 +1436,25 @@ module Aws::FraudDetector
1011
1436
  # The model type.
1012
1437
  #
1013
1438
  # @option params [required, String] :model_version_number
1014
- # The model version.
1439
+ # The model version number.
1015
1440
  #
1016
1441
  # @return [Types::GetModelVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1017
1442
  #
1018
1443
  # * {Types::GetModelVersionResult#model_id #model_id} => String
1019
1444
  # * {Types::GetModelVersionResult#model_type #model_type} => String
1020
1445
  # * {Types::GetModelVersionResult#model_version_number #model_version_number} => String
1021
- # * {Types::GetModelVersionResult#description #description} => String
1446
+ # * {Types::GetModelVersionResult#training_data_source #training_data_source} => String
1447
+ # * {Types::GetModelVersionResult#training_data_schema #training_data_schema} => Types::TrainingDataSchema
1448
+ # * {Types::GetModelVersionResult#external_events_detail #external_events_detail} => Types::ExternalEventsDetail
1022
1449
  # * {Types::GetModelVersionResult#status #status} => String
1450
+ # * {Types::GetModelVersionResult#arn #arn} => String
1023
1451
  #
1024
1452
  # @example Request syntax with placeholder values
1025
1453
  #
1026
1454
  # resp = client.get_model_version({
1027
- # model_id: "identifier", # required
1455
+ # model_id: "modelIdentifier", # required
1028
1456
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1029
- # model_version_number: "nonEmptyString", # required
1457
+ # model_version_number: "floatVersionString", # required
1030
1458
  # })
1031
1459
  #
1032
1460
  # @example Response structure
@@ -1034,8 +1462,16 @@ module Aws::FraudDetector
1034
1462
  # resp.model_id #=> String
1035
1463
  # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1036
1464
  # resp.model_version_number #=> String
1037
- # resp.description #=> String
1465
+ # resp.training_data_source #=> String, one of "EXTERNAL_EVENTS"
1466
+ # resp.training_data_schema.model_variables #=> Array
1467
+ # resp.training_data_schema.model_variables[0] #=> String
1468
+ # resp.training_data_schema.label_schema.label_mapper #=> Hash
1469
+ # resp.training_data_schema.label_schema.label_mapper["string"] #=> Array
1470
+ # resp.training_data_schema.label_schema.label_mapper["string"][0] #=> String
1471
+ # resp.external_events_detail.data_location #=> String
1472
+ # resp.external_events_detail.data_access_role_arn #=> String
1038
1473
  # resp.status #=> String
1474
+ # resp.arn #=> String
1039
1475
  #
1040
1476
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModelVersion AWS API Documentation
1041
1477
  #
@@ -1046,21 +1482,30 @@ module Aws::FraudDetector
1046
1482
  req.send_request(options)
1047
1483
  end
1048
1484
 
1049
- # Gets all of the models for the AWS account, or the specified model
1050
- # type, or gets a single model for the specified model type, model ID
1051
- # combination.
1052
- #
1053
- # @option params [String] :model_type
1054
- # The model type.
1485
+ # Gets one or more models. Gets all models for the AWS account if no
1486
+ # model type and no model id provided. Gets all models for the AWS
1487
+ # account and model type, if the model type is specified but model id is
1488
+ # not provided. Gets a specific model if (model type, model id) tuple is
1489
+ # specified.
1490
+ #
1491
+ # This is a paginated API. If you provide a null `maxResults`, this
1492
+ # action retrieves a maximum of 10 records per page. If you provide a
1493
+ # `maxResults`, the value must be between 1 and 10. To get the next page
1494
+ # results, provide the pagination token from the response as part of
1495
+ # your request. A null pagination token fetches the records from the
1496
+ # beginning.
1055
1497
  #
1056
1498
  # @option params [String] :model_id
1057
1499
  # The model ID.
1058
1500
  #
1501
+ # @option params [String] :model_type
1502
+ # The model type.
1503
+ #
1059
1504
  # @option params [String] :next_token
1060
- # The next token for the request.
1505
+ # The next token for the subsequent request.
1061
1506
  #
1062
1507
  # @option params [Integer] :max_results
1063
- # The maximum results to return for the request.
1508
+ # The maximum number of objects to return for the request.
1064
1509
  #
1065
1510
  # @return [Types::GetModelsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1066
1511
  #
@@ -1072,8 +1517,8 @@ module Aws::FraudDetector
1072
1517
  # @example Request syntax with placeholder values
1073
1518
  #
1074
1519
  # resp = client.get_models({
1520
+ # model_id: "modelIdentifier",
1075
1521
  # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
1076
- # model_id: "identifier",
1077
1522
  # next_token: "string",
1078
1523
  # max_results: 1,
1079
1524
  # })
@@ -1085,17 +1530,10 @@ module Aws::FraudDetector
1085
1530
  # resp.models[0].model_id #=> String
1086
1531
  # resp.models[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1087
1532
  # resp.models[0].description #=> String
1088
- # resp.models[0].training_data_source.data_location #=> String
1089
- # resp.models[0].training_data_source.data_access_role_arn #=> String
1090
- # resp.models[0].model_variables #=> Array
1091
- # resp.models[0].model_variables[0].name #=> String
1092
- # resp.models[0].model_variables[0].index #=> Integer
1093
- # resp.models[0].label_schema.label_key #=> String
1094
- # resp.models[0].label_schema.label_mapper #=> Hash
1095
- # resp.models[0].label_schema.label_mapper["string"] #=> Array
1096
- # resp.models[0].label_schema.label_mapper["string"][0] #=> String
1097
- # resp.models[0].last_updated_time #=> String
1533
+ # resp.models[0].event_type_name #=> String
1098
1534
  # resp.models[0].created_time #=> String
1535
+ # resp.models[0].last_updated_time #=> String
1536
+ # resp.models[0].arn #=> String
1099
1537
  #
1100
1538
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModels AWS API Documentation
1101
1539
  #
@@ -1107,11 +1545,11 @@ module Aws::FraudDetector
1107
1545
  end
1108
1546
 
1109
1547
  # Gets one or more outcomes. This is a paginated API. If you provide a
1110
- # null `maxSizePerPage`, this actions retrieves a maximum of 10 records
1111
- # per page. If you provide a `maxSizePerPage`, the value must be between
1112
- # 50 and 100. To get the next page results, provide the pagination token
1113
- # from the `GetOutcomesResult` as part of your request. A null
1114
- # pagination token fetches the records from the beginning.
1548
+ # null `maxResults`, this actions retrieves a maximum of 100 records per
1549
+ # page. If you provide a `maxResults`, the value must be between 50 and
1550
+ # 100. To get the next page results, provide the pagination token from
1551
+ # the `GetOutcomesResult` as part of your request. A null pagination
1552
+ # token fetches the records from the beginning.
1115
1553
  #
1116
1554
  # @option params [String] :name
1117
1555
  # The name of the outcome or outcomes to get.
@@ -1144,6 +1582,7 @@ module Aws::FraudDetector
1144
1582
  # resp.outcomes[0].description #=> String
1145
1583
  # resp.outcomes[0].last_updated_time #=> String
1146
1584
  # resp.outcomes[0].created_time #=> String
1585
+ # resp.outcomes[0].arn #=> String
1147
1586
  # resp.next_token #=> String
1148
1587
  #
1149
1588
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetOutcomes AWS API Documentation
@@ -1155,77 +1594,19 @@ module Aws::FraudDetector
1155
1594
  req.send_request(options)
1156
1595
  end
1157
1596
 
1158
- # Evaluates an event against a detector version. If a version ID is not
1159
- # provided, the detector’s (`ACTIVE`) version is used.
1160
- #
1161
- # @option params [required, String] :detector_id
1162
- # The detector ID.
1163
- #
1164
- # @option params [String] :detector_version_id
1165
- # The detector version ID.
1166
- #
1167
- # @option params [required, String] :event_id
1168
- # The unique ID used to identify the event.
1169
- #
1170
- # @option params [Hash<String,String>] :event_attributes
1171
- # Names of variables you defined in Amazon Fraud Detector to represent
1172
- # event data elements and their corresponding values for the event you
1173
- # are sending for evaluation.
1174
- #
1175
- # @option params [Hash<String,Types::ModelEndpointDataBlob>] :external_model_endpoint_data_blobs
1176
- # The Amazon SageMaker model endpoint input data blobs.
1177
- #
1178
- # @return [Types::GetPredictionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1179
- #
1180
- # * {Types::GetPredictionResult#outcomes #outcomes} => Array&lt;String&gt;
1181
- # * {Types::GetPredictionResult#model_scores #model_scores} => Array&lt;Types::ModelScores&gt;
1182
- # * {Types::GetPredictionResult#rule_results #rule_results} => Array&lt;Types::RuleResult&gt;
1183
- #
1184
- # @example Request syntax with placeholder values
1185
- #
1186
- # resp = client.get_prediction({
1187
- # detector_id: "string", # required
1188
- # detector_version_id: "string",
1189
- # event_id: "string", # required
1190
- # event_attributes: {
1191
- # "attributeKey" => "attributeValue",
1192
- # },
1193
- # external_model_endpoint_data_blobs: {
1194
- # "string" => {
1195
- # byte_buffer: "data",
1196
- # content_type: "contentType",
1197
- # },
1198
- # },
1199
- # })
1200
- #
1201
- # @example Response structure
1202
- #
1203
- # resp.outcomes #=> Array
1204
- # resp.outcomes[0] #=> String
1205
- # resp.model_scores #=> Array
1206
- # resp.model_scores[0].model_version.model_id #=> String
1207
- # resp.model_scores[0].model_version.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1208
- # resp.model_scores[0].model_version.model_version_number #=> String
1209
- # resp.model_scores[0].scores #=> Hash
1210
- # resp.model_scores[0].scores["string"] #=> Float
1211
- # resp.rule_results #=> Array
1212
- # resp.rule_results[0].rule_id #=> String
1213
- # resp.rule_results[0].outcomes #=> Array
1214
- # resp.rule_results[0].outcomes[0] #=> String
1215
- #
1216
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetPrediction AWS API Documentation
1217
- #
1218
- # @overload get_prediction(params = {})
1219
- # @param [Hash] params ({})
1220
- def get_prediction(params = {}, options = {})
1221
- req = build_request(:get_prediction, params)
1222
- req.send_request(options)
1223
- end
1224
-
1225
- # Gets all rules available for the specified detector.
1226
- #
1227
- # @option params [String] :rule_id
1228
- # The rule ID.
1597
+ # Get all rules for a detector (paginated) if `ruleId` and `ruleVersion`
1598
+ # are not specified. Gets all rules for the detector and the `ruleId` if
1599
+ # present (paginated). Gets a specific rule if both the `ruleId` and the
1600
+ # `ruleVersion` are specified.
1601
+ #
1602
+ # This is a paginated API. Providing null maxResults results in
1603
+ # retrieving maximum of 100 records per page. If you provide maxResults
1604
+ # the value must be between 50 and 100. To get the next page result, a
1605
+ # provide a pagination token from GetRulesResult as part of your
1606
+ # request. Null pagination token fetches the records from the beginning.
1607
+ #
1608
+ # @option params [String] :rule_id
1609
+ # The rule ID.
1229
1610
  #
1230
1611
  # @option params [required, String] :detector_id
1231
1612
  # The detector ID.
@@ -1251,7 +1632,7 @@ module Aws::FraudDetector
1251
1632
  # resp = client.get_rules({
1252
1633
  # rule_id: "identifier",
1253
1634
  # detector_id: "identifier", # required
1254
- # rule_version: "nonEmptyString",
1635
+ # rule_version: "wholeNumberVersionString",
1255
1636
  # next_token: "string",
1256
1637
  # max_results: 1,
1257
1638
  # })
@@ -1269,6 +1650,7 @@ module Aws::FraudDetector
1269
1650
  # resp.rule_details[0].outcomes[0] #=> String
1270
1651
  # resp.rule_details[0].last_updated_time #=> String
1271
1652
  # resp.rule_details[0].created_time #=> String
1653
+ # resp.rule_details[0].arn #=> String
1272
1654
  # resp.next_token #=> String
1273
1655
  #
1274
1656
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetRules AWS API Documentation
@@ -1322,6 +1704,7 @@ module Aws::FraudDetector
1322
1704
  # resp.variables[0].variable_type #=> String
1323
1705
  # resp.variables[0].last_updated_time #=> String
1324
1706
  # resp.variables[0].created_time #=> String
1707
+ # resp.variables[0].arn #=> String
1325
1708
  # resp.next_token #=> String
1326
1709
  #
1327
1710
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetVariables AWS API Documentation
@@ -1333,6 +1716,51 @@ module Aws::FraudDetector
1333
1716
  req.send_request(options)
1334
1717
  end
1335
1718
 
1719
+ # Lists all tags associated with the resource. This is a paginated API.
1720
+ # To get the next page results, provide the pagination token from the
1721
+ # response as part of your request. A null pagination token fetches the
1722
+ # records from the beginning.
1723
+ #
1724
+ # @option params [required, String] :resource_arn
1725
+ # The ARN that specifies the resource whose tags you want to list.
1726
+ #
1727
+ # @option params [String] :next_token
1728
+ # The next token from the previous results.
1729
+ #
1730
+ # @option params [Integer] :max_results
1731
+ # The maximum number of objects to return for the request.
1732
+ #
1733
+ # @return [Types::ListTagsForResourceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1734
+ #
1735
+ # * {Types::ListTagsForResourceResult#tags #tags} => Array&lt;Types::Tag&gt;
1736
+ # * {Types::ListTagsForResourceResult#next_token #next_token} => String
1737
+ #
1738
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1739
+ #
1740
+ # @example Request syntax with placeholder values
1741
+ #
1742
+ # resp = client.list_tags_for_resource({
1743
+ # resource_arn: "fraudDetectorArn", # required
1744
+ # next_token: "string",
1745
+ # max_results: 1,
1746
+ # })
1747
+ #
1748
+ # @example Response structure
1749
+ #
1750
+ # resp.tags #=> Array
1751
+ # resp.tags[0].key #=> String
1752
+ # resp.tags[0].value #=> String
1753
+ # resp.next_token #=> String
1754
+ #
1755
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ListTagsForResource AWS API Documentation
1756
+ #
1757
+ # @overload list_tags_for_resource(params = {})
1758
+ # @param [Hash] params ({})
1759
+ def list_tags_for_resource(params = {}, options = {})
1760
+ req = build_request(:list_tags_for_resource, params)
1761
+ req.send_request(options)
1762
+ end
1763
+
1336
1764
  # Creates or updates a detector.
1337
1765
  #
1338
1766
  # @option params [required, String] :detector_id
@@ -1341,6 +1769,12 @@ module Aws::FraudDetector
1341
1769
  # @option params [String] :description
1342
1770
  # The description of the detector.
1343
1771
  #
1772
+ # @option params [required, String] :event_type_name
1773
+ # The name of the event type.
1774
+ #
1775
+ # @option params [Array<Types::Tag>] :tags
1776
+ # A collection of key and value pairs.
1777
+ #
1344
1778
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1345
1779
  #
1346
1780
  # @example Request syntax with placeholder values
@@ -1348,6 +1782,13 @@ module Aws::FraudDetector
1348
1782
  # resp = client.put_detector({
1349
1783
  # detector_id: "identifier", # required
1350
1784
  # description: "description",
1785
+ # event_type_name: "identifier", # required
1786
+ # tags: [
1787
+ # {
1788
+ # key: "tagKey", # required
1789
+ # value: "tagValue", # required
1790
+ # },
1791
+ # ],
1351
1792
  # })
1352
1793
  #
1353
1794
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutDetector AWS API Documentation
@@ -1359,6 +1800,100 @@ module Aws::FraudDetector
1359
1800
  req.send_request(options)
1360
1801
  end
1361
1802
 
1803
+ # Creates or updates an entity type. An entity represents who is
1804
+ # performing the event. As part of a fraud prediction, you pass the
1805
+ # entity ID to indicate the specific entity who performed the event. An
1806
+ # entity type classifies the entity. Example classifications include
1807
+ # customer, merchant, or account.
1808
+ #
1809
+ # @option params [required, String] :name
1810
+ # The name of the entity type.
1811
+ #
1812
+ # @option params [String] :description
1813
+ # The description.
1814
+ #
1815
+ # @option params [Array<Types::Tag>] :tags
1816
+ # A collection of key and value pairs.
1817
+ #
1818
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1819
+ #
1820
+ # @example Request syntax with placeholder values
1821
+ #
1822
+ # resp = client.put_entity_type({
1823
+ # name: "identifier", # required
1824
+ # description: "description",
1825
+ # tags: [
1826
+ # {
1827
+ # key: "tagKey", # required
1828
+ # value: "tagValue", # required
1829
+ # },
1830
+ # ],
1831
+ # })
1832
+ #
1833
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutEntityType AWS API Documentation
1834
+ #
1835
+ # @overload put_entity_type(params = {})
1836
+ # @param [Hash] params ({})
1837
+ def put_entity_type(params = {}, options = {})
1838
+ req = build_request(:put_entity_type, params)
1839
+ req.send_request(options)
1840
+ end
1841
+
1842
+ # Creates or updates an event type. An event is a business activity that
1843
+ # is evaluated for fraud risk. With Amazon Fraud Detector, you generate
1844
+ # fraud predictions for events. An event type defines the structure for
1845
+ # an event sent to Amazon Fraud Detector. This includes the variables
1846
+ # sent as part of the event, the entity performing the event (such as a
1847
+ # customer), and the labels that classify the event. Example event types
1848
+ # include online payment transactions, account registrations, and
1849
+ # authentications.
1850
+ #
1851
+ # @option params [required, String] :name
1852
+ # The name.
1853
+ #
1854
+ # @option params [String] :description
1855
+ # The description of the event type.
1856
+ #
1857
+ # @option params [required, Array<String>] :event_variables
1858
+ # The event type variables.
1859
+ #
1860
+ # @option params [Array<String>] :labels
1861
+ # The event type labels.
1862
+ #
1863
+ # @option params [required, Array<String>] :entity_types
1864
+ # The entity type for the event type. Example entity types: customer,
1865
+ # merchant, account.
1866
+ #
1867
+ # @option params [Array<Types::Tag>] :tags
1868
+ # A collection of key and value pairs.
1869
+ #
1870
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1871
+ #
1872
+ # @example Request syntax with placeholder values
1873
+ #
1874
+ # resp = client.put_event_type({
1875
+ # name: "identifier", # required
1876
+ # description: "description",
1877
+ # event_variables: ["string"], # required
1878
+ # labels: ["string"],
1879
+ # entity_types: ["string"], # required
1880
+ # tags: [
1881
+ # {
1882
+ # key: "tagKey", # required
1883
+ # value: "tagValue", # required
1884
+ # },
1885
+ # ],
1886
+ # })
1887
+ #
1888
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutEventType AWS API Documentation
1889
+ #
1890
+ # @overload put_event_type(params = {})
1891
+ # @param [Hash] params ({})
1892
+ def put_event_type(params = {}, options = {})
1893
+ req = build_request(:put_event_type, params)
1894
+ req.send_request(options)
1895
+ end
1896
+
1362
1897
  # Creates or updates an Amazon SageMaker model endpoint. You can also
1363
1898
  # use this action to update the configuration of the model endpoint,
1364
1899
  # including the IAM role and/or the mapped variables.
@@ -1369,7 +1904,7 @@ module Aws::FraudDetector
1369
1904
  # @option params [required, String] :model_source
1370
1905
  # The source of the model.
1371
1906
  #
1372
- # @option params [required, Types::Role] :role
1907
+ # @option params [required, String] :invoke_model_endpoint_role_arn
1373
1908
  # The IAM role used to invoke the model endpoint.
1374
1909
  #
1375
1910
  # @option params [required, Types::ModelInputConfiguration] :input_configuration
@@ -1381,20 +1916,21 @@ module Aws::FraudDetector
1381
1916
  # @option params [required, String] :model_endpoint_status
1382
1917
  # The model endpoint’s status in Amazon Fraud Detector.
1383
1918
  #
1919
+ # @option params [Array<Types::Tag>] :tags
1920
+ # A collection of key and value pairs.
1921
+ #
1384
1922
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1385
1923
  #
1386
1924
  # @example Request syntax with placeholder values
1387
1925
  #
1388
1926
  # resp = client.put_external_model({
1389
- # model_endpoint: "string", # required
1927
+ # model_endpoint: "sageMakerEndpointIdentifier", # required
1390
1928
  # model_source: "SAGEMAKER", # required, accepts SAGEMAKER
1391
- # role: { # required
1392
- # arn: "string", # required
1393
- # name: "string", # required
1394
- # },
1929
+ # invoke_model_endpoint_role_arn: "string", # required
1395
1930
  # input_configuration: { # required
1931
+ # event_type_name: "identifier",
1396
1932
  # format: "TEXT_CSV", # accepts TEXT_CSV, APPLICATION_JSON
1397
- # is_opaque: false, # required
1933
+ # use_event_variables: false, # required
1398
1934
  # json_input_template: "string",
1399
1935
  # csv_input_template: "string",
1400
1936
  # },
@@ -1408,6 +1944,12 @@ module Aws::FraudDetector
1408
1944
  # },
1409
1945
  # },
1410
1946
  # model_endpoint_status: "ASSOCIATED", # required, accepts ASSOCIATED, DISSOCIATED
1947
+ # tags: [
1948
+ # {
1949
+ # key: "tagKey", # required
1950
+ # value: "tagValue", # required
1951
+ # },
1952
+ # ],
1411
1953
  # })
1412
1954
  #
1413
1955
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutExternalModel AWS API Documentation
@@ -1419,58 +1961,62 @@ module Aws::FraudDetector
1419
1961
  req.send_request(options)
1420
1962
  end
1421
1963
 
1422
- # Creates or updates a model.
1964
+ # Specifies the Key Management Service (KMS) customer master key (CMK)
1965
+ # to be used to encrypt content in Amazon Fraud Detector.
1423
1966
  #
1424
- # @option params [required, String] :model_id
1425
- # The model ID.
1967
+ # @option params [required, String] :kms_encryption_key_arn
1968
+ # The KMS encryption key ARN.
1426
1969
  #
1427
- # @option params [required, String] :model_type
1428
- # The model type.
1970
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1429
1971
  #
1430
- # @option params [String] :description
1431
- # The model description.
1972
+ # @example Request syntax with placeholder values
1432
1973
  #
1433
- # @option params [required, Types::TrainingDataSource] :training_data_source
1434
- # The training data source location in Amazon S3.
1974
+ # resp = client.put_kms_encryption_key({
1975
+ # kms_encryption_key_arn: "KmsEncryptionKeyArn", # required
1976
+ # })
1977
+ #
1978
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutKMSEncryptionKey AWS API Documentation
1979
+ #
1980
+ # @overload put_kms_encryption_key(params = {})
1981
+ # @param [Hash] params ({})
1982
+ def put_kms_encryption_key(params = {}, options = {})
1983
+ req = build_request(:put_kms_encryption_key, params)
1984
+ req.send_request(options)
1985
+ end
1986
+
1987
+ # Creates or updates label. A label classifies an event as fraudulent or
1988
+ # legitimate. Labels are associated with event types and used to train
1989
+ # supervised machine learning models in Amazon Fraud Detector.
1990
+ #
1991
+ # @option params [required, String] :name
1992
+ # The label name.
1435
1993
  #
1436
- # @option params [required, Array<Types::ModelVariable>] :model_variables
1437
- # The model input variables.
1994
+ # @option params [String] :description
1995
+ # The label description.
1438
1996
  #
1439
- # @option params [required, Types::LabelSchema] :label_schema
1440
- # The label schema.
1997
+ # @option params [Array<Types::Tag>] :tags
1441
1998
  #
1442
1999
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1443
2000
  #
1444
2001
  # @example Request syntax with placeholder values
1445
2002
  #
1446
- # resp = client.put_model({
1447
- # model_id: "identifier", # required
1448
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
2003
+ # resp = client.put_label({
2004
+ # name: "identifier", # required
1449
2005
  # description: "description",
1450
- # training_data_source: { # required
1451
- # data_location: "s3BucketLocation", # required
1452
- # data_access_role_arn: "iamRoleArn", # required
1453
- # },
1454
- # model_variables: [ # required
2006
+ # tags: [
1455
2007
  # {
1456
- # name: "string", # required
1457
- # index: 1,
2008
+ # key: "tagKey", # required
2009
+ # value: "tagValue", # required
1458
2010
  # },
1459
2011
  # ],
1460
- # label_schema: { # required
1461
- # label_key: "string", # required
1462
- # label_mapper: { # required
1463
- # "string" => ["string"],
1464
- # },
1465
- # },
1466
2012
  # })
1467
2013
  #
1468
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutModel AWS API Documentation
2014
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutLabel AWS API Documentation
1469
2015
  #
1470
- # @overload put_model(params = {})
2016
+ # @overload put_label(params = {})
1471
2017
  # @param [Hash] params ({})
1472
- def put_model(params = {}, options = {})
1473
- req = build_request(:put_model, params)
2018
+ def put_label(params = {}, options = {})
2019
+ req = build_request(:put_label, params)
1474
2020
  req.send_request(options)
1475
2021
  end
1476
2022
 
@@ -1482,6 +2028,9 @@ module Aws::FraudDetector
1482
2028
  # @option params [String] :description
1483
2029
  # The outcome description.
1484
2030
  #
2031
+ # @option params [Array<Types::Tag>] :tags
2032
+ # A collection of key and value pairs.
2033
+ #
1485
2034
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1486
2035
  #
1487
2036
  # @example Request syntax with placeholder values
@@ -1489,6 +2038,12 @@ module Aws::FraudDetector
1489
2038
  # resp = client.put_outcome({
1490
2039
  # name: "identifier", # required
1491
2040
  # description: "description",
2041
+ # tags: [
2042
+ # {
2043
+ # key: "tagKey", # required
2044
+ # value: "tagValue", # required
2045
+ # },
2046
+ # ],
1492
2047
  # })
1493
2048
  #
1494
2049
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutOutcome AWS API Documentation
@@ -1500,9 +2055,67 @@ module Aws::FraudDetector
1500
2055
  req.send_request(options)
1501
2056
  end
1502
2057
 
2058
+ # Assigns tags to a resource.
2059
+ #
2060
+ # @option params [required, String] :resource_arn
2061
+ # The resource ARN.
2062
+ #
2063
+ # @option params [required, Array<Types::Tag>] :tags
2064
+ # The tags to assign to the resource.
2065
+ #
2066
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2067
+ #
2068
+ # @example Request syntax with placeholder values
2069
+ #
2070
+ # resp = client.tag_resource({
2071
+ # resource_arn: "fraudDetectorArn", # required
2072
+ # tags: [ # required
2073
+ # {
2074
+ # key: "tagKey", # required
2075
+ # value: "tagValue", # required
2076
+ # },
2077
+ # ],
2078
+ # })
2079
+ #
2080
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/TagResource AWS API Documentation
2081
+ #
2082
+ # @overload tag_resource(params = {})
2083
+ # @param [Hash] params ({})
2084
+ def tag_resource(params = {}, options = {})
2085
+ req = build_request(:tag_resource, params)
2086
+ req.send_request(options)
2087
+ end
2088
+
2089
+ # Removes tags from a resource.
2090
+ #
2091
+ # @option params [required, String] :resource_arn
2092
+ # The ARN of the resource from which to remove the tag.
2093
+ #
2094
+ # @option params [required, Array<String>] :tag_keys
2095
+ # The resource ARN.
2096
+ #
2097
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2098
+ #
2099
+ # @example Request syntax with placeholder values
2100
+ #
2101
+ # resp = client.untag_resource({
2102
+ # resource_arn: "fraudDetectorArn", # required
2103
+ # tag_keys: ["tagKey"], # required
2104
+ # })
2105
+ #
2106
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UntagResource AWS API Documentation
2107
+ #
2108
+ # @overload untag_resource(params = {})
2109
+ # @param [Hash] params ({})
2110
+ def untag_resource(params = {}, options = {})
2111
+ req = build_request(:untag_resource, params)
2112
+ req.send_request(options)
2113
+ end
2114
+
1503
2115
  # Updates a detector version. The detector version attributes that you
1504
- # can update include models, external model endpoints, rules, and
1505
- # description. You can only update a `DRAFT` detector version.
2116
+ # can update include models, external model endpoints, rules, rule
2117
+ # execution mode, and description. You can only update a `DRAFT`
2118
+ # detector version.
1506
2119
  #
1507
2120
  # @option params [required, String] :detector_id
1508
2121
  # The parent detector ID for the detector version you want to update.
@@ -1544,21 +2157,22 @@ module Aws::FraudDetector
1544
2157
  #
1545
2158
  # resp = client.update_detector_version({
1546
2159
  # detector_id: "identifier", # required
1547
- # detector_version_id: "nonEmptyString", # required
2160
+ # detector_version_id: "wholeNumberVersionString", # required
1548
2161
  # external_model_endpoints: ["string"], # required
1549
2162
  # rules: [ # required
1550
2163
  # {
1551
2164
  # detector_id: "identifier", # required
1552
2165
  # rule_id: "identifier", # required
1553
- # rule_version: "nonEmptyString", # required
2166
+ # rule_version: "wholeNumberVersionString", # required
1554
2167
  # },
1555
2168
  # ],
1556
2169
  # description: "description",
1557
2170
  # model_versions: [
1558
2171
  # {
1559
- # model_id: "identifier", # required
2172
+ # model_id: "modelIdentifier", # required
1560
2173
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1561
2174
  # model_version_number: "nonEmptyString", # required
2175
+ # arn: "fraudDetectorArn",
1562
2176
  # },
1563
2177
  # ],
1564
2178
  # rule_execution_mode: "ALL_MATCHED", # accepts ALL_MATCHED, FIRST_MATCHED
@@ -1591,7 +2205,7 @@ module Aws::FraudDetector
1591
2205
  #
1592
2206
  # resp = client.update_detector_version_metadata({
1593
2207
  # detector_id: "identifier", # required
1594
- # detector_version_id: "nonEmptyString", # required
2208
+ # detector_version_id: "wholeNumberVersionString", # required
1595
2209
  # description: "description", # required
1596
2210
  # })
1597
2211
  #
@@ -1623,7 +2237,7 @@ module Aws::FraudDetector
1623
2237
  #
1624
2238
  # resp = client.update_detector_version_status({
1625
2239
  # detector_id: "identifier", # required
1626
- # detector_version_id: "nonEmptyString", # required
2240
+ # detector_version_id: "wholeNumberVersionString", # required
1627
2241
  # status: "DRAFT", # required, accepts DRAFT, ACTIVE, INACTIVE
1628
2242
  # })
1629
2243
  #
@@ -1636,13 +2250,43 @@ module Aws::FraudDetector
1636
2250
  req.send_request(options)
1637
2251
  end
1638
2252
 
1639
- # Updates a model version. You can update the description and status
1640
- # attributes using this action. You can perform the following status
1641
- # updates:
2253
+ # Updates a model. You can update the description attribute using this
2254
+ # action.
2255
+ #
2256
+ # @option params [required, String] :model_id
2257
+ # The model ID.
1642
2258
  #
1643
- # 1. Change the `TRAINING_COMPLETE` status to `ACTIVE`
2259
+ # @option params [required, String] :model_type
2260
+ # The model type.
1644
2261
  #
1645
- # 2. Change `ACTIVE` back to `TRAINING_COMPLETE`
2262
+ # @option params [String] :description
2263
+ # The new model description.
2264
+ #
2265
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2266
+ #
2267
+ # @example Request syntax with placeholder values
2268
+ #
2269
+ # resp = client.update_model({
2270
+ # model_id: "modelIdentifier", # required
2271
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
2272
+ # description: "description",
2273
+ # })
2274
+ #
2275
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModel AWS API Documentation
2276
+ #
2277
+ # @overload update_model(params = {})
2278
+ # @param [Hash] params ({})
2279
+ def update_model(params = {}, options = {})
2280
+ req = build_request(:update_model, params)
2281
+ req.send_request(options)
2282
+ end
2283
+
2284
+ # Updates a model version. Updating a model version retrains an existing
2285
+ # model version using updated training data and produces a new minor
2286
+ # version of the model. You can update the training data set location
2287
+ # and data access role attributes using this action. This action creates
2288
+ # and trains a new minor version of the model, for example version 1.01,
2289
+ # 1.02, 1.03.
1646
2290
  #
1647
2291
  # @option params [required, String] :model_id
1648
2292
  # The model ID.
@@ -1650,27 +2294,47 @@ module Aws::FraudDetector
1650
2294
  # @option params [required, String] :model_type
1651
2295
  # The model type.
1652
2296
  #
1653
- # @option params [required, String] :model_version_number
1654
- # The model version.
2297
+ # @option params [required, String] :major_version_number
2298
+ # The major version number.
1655
2299
  #
1656
- # @option params [required, String] :description
1657
- # The model description.
2300
+ # @option params [Types::ExternalEventsDetail] :external_events_detail
2301
+ # The event details.
1658
2302
  #
1659
- # @option params [required, String] :status
1660
- # The new model status.
2303
+ # @option params [Array<Types::Tag>] :tags
2304
+ # A collection of key and value pairs.
1661
2305
  #
1662
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2306
+ # @return [Types::UpdateModelVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2307
+ #
2308
+ # * {Types::UpdateModelVersionResult#model_id #model_id} => String
2309
+ # * {Types::UpdateModelVersionResult#model_type #model_type} => String
2310
+ # * {Types::UpdateModelVersionResult#model_version_number #model_version_number} => String
2311
+ # * {Types::UpdateModelVersionResult#status #status} => String
1663
2312
  #
1664
2313
  # @example Request syntax with placeholder values
1665
2314
  #
1666
2315
  # resp = client.update_model_version({
1667
- # model_id: "identifier", # required
2316
+ # model_id: "modelIdentifier", # required
1668
2317
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1669
- # model_version_number: "nonEmptyString", # required
1670
- # description: "description", # required
1671
- # status: "TRAINING_IN_PROGRESS", # required, accepts TRAINING_IN_PROGRESS, TRAINING_COMPLETE, ACTIVATE_REQUESTED, ACTIVATE_IN_PROGRESS, ACTIVE, INACTIVATE_IN_PROGRESS, INACTIVE, ERROR
2318
+ # major_version_number: "wholeNumberVersionString", # required
2319
+ # external_events_detail: {
2320
+ # data_location: "s3BucketLocation", # required
2321
+ # data_access_role_arn: "iamRoleArn", # required
2322
+ # },
2323
+ # tags: [
2324
+ # {
2325
+ # key: "tagKey", # required
2326
+ # value: "tagValue", # required
2327
+ # },
2328
+ # ],
1672
2329
  # })
1673
2330
  #
2331
+ # @example Response structure
2332
+ #
2333
+ # resp.model_id #=> String
2334
+ # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
2335
+ # resp.model_version_number #=> String
2336
+ # resp.status #=> String
2337
+ #
1674
2338
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelVersion AWS API Documentation
1675
2339
  #
1676
2340
  # @overload update_model_version(params = {})
@@ -1680,7 +2344,47 @@ module Aws::FraudDetector
1680
2344
  req.send_request(options)
1681
2345
  end
1682
2346
 
1683
- # Updates a rule's metadata.
2347
+ # Updates the status of a model version.
2348
+ #
2349
+ # You can perform the following status updates:
2350
+ #
2351
+ # 1. Change the `TRAINING_COMPLETE` status to `ACTIVE`.
2352
+ #
2353
+ # 2. Change `ACTIVE`to `INACTIVE`.
2354
+ #
2355
+ # @option params [required, String] :model_id
2356
+ # The model ID of the model version to update.
2357
+ #
2358
+ # @option params [required, String] :model_type
2359
+ # The model type.
2360
+ #
2361
+ # @option params [required, String] :model_version_number
2362
+ # The model version number.
2363
+ #
2364
+ # @option params [required, String] :status
2365
+ # The model version status.
2366
+ #
2367
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2368
+ #
2369
+ # @example Request syntax with placeholder values
2370
+ #
2371
+ # resp = client.update_model_version_status({
2372
+ # model_id: "modelIdentifier", # required
2373
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
2374
+ # model_version_number: "floatVersionString", # required
2375
+ # status: "ACTIVE", # required, accepts ACTIVE, INACTIVE
2376
+ # })
2377
+ #
2378
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelVersionStatus AWS API Documentation
2379
+ #
2380
+ # @overload update_model_version_status(params = {})
2381
+ # @param [Hash] params ({})
2382
+ def update_model_version_status(params = {}, options = {})
2383
+ req = build_request(:update_model_version_status, params)
2384
+ req.send_request(options)
2385
+ end
2386
+
2387
+ # Updates a rule's metadata. The description attribute can be updated.
1684
2388
  #
1685
2389
  # @option params [required, Types::Rule] :rule
1686
2390
  # The rule to update.
@@ -1696,7 +2400,7 @@ module Aws::FraudDetector
1696
2400
  # rule: { # required
1697
2401
  # detector_id: "identifier", # required
1698
2402
  # rule_id: "identifier", # required
1699
- # rule_version: "nonEmptyString", # required
2403
+ # rule_version: "wholeNumberVersionString", # required
1700
2404
  # },
1701
2405
  # description: "description", # required
1702
2406
  # })
@@ -1710,7 +2414,8 @@ module Aws::FraudDetector
1710
2414
  req.send_request(options)
1711
2415
  end
1712
2416
 
1713
- # Updates a rule version resulting in a new rule version.
2417
+ # Updates a rule version resulting in a new rule version. Updates a rule
2418
+ # version resulting in a new rule version (version 1, 2, 3 ...).
1714
2419
  #
1715
2420
  # @option params [required, Types::Rule] :rule
1716
2421
  # The rule to update.
@@ -1727,6 +2432,9 @@ module Aws::FraudDetector
1727
2432
  # @option params [required, Array<String>] :outcomes
1728
2433
  # The outcomes.
1729
2434
  #
2435
+ # @option params [Array<Types::Tag>] :tags
2436
+ # The tags to assign to the rule version.
2437
+ #
1730
2438
  # @return [Types::UpdateRuleVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1731
2439
  #
1732
2440
  # * {Types::UpdateRuleVersionResult#rule #rule} => Types::Rule
@@ -1737,12 +2445,18 @@ module Aws::FraudDetector
1737
2445
  # rule: { # required
1738
2446
  # detector_id: "identifier", # required
1739
2447
  # rule_id: "identifier", # required
1740
- # rule_version: "nonEmptyString", # required
2448
+ # rule_version: "wholeNumberVersionString", # required
1741
2449
  # },
1742
2450
  # description: "description",
1743
2451
  # expression: "ruleExpression", # required
1744
2452
  # language: "DETECTORPL", # required, accepts DETECTORPL
1745
2453
  # outcomes: ["string"], # required
2454
+ # tags: [
2455
+ # {
2456
+ # key: "tagKey", # required
2457
+ # value: "tagValue", # required
2458
+ # },
2459
+ # ],
1746
2460
  # })
1747
2461
  #
1748
2462
  # @example Response structure
@@ -1772,7 +2486,11 @@ module Aws::FraudDetector
1772
2486
  # The new description.
1773
2487
  #
1774
2488
  # @option params [String] :variable_type
1775
- # The variable type.
2489
+ # The variable type. For more information see [Variable types][1].
2490
+ #
2491
+ #
2492
+ #
2493
+ # [1]: https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types
1776
2494
  #
1777
2495
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1778
2496
  #
@@ -1807,7 +2525,7 @@ module Aws::FraudDetector
1807
2525
  params: params,
1808
2526
  config: config)
1809
2527
  context[:gem_name] = 'aws-sdk-frauddetector'
1810
- context[:gem_version] = '1.5.1'
2528
+ context[:gem_version] = '1.10.0'
1811
2529
  Seahorse::Client::Request.new(handlers, context)
1812
2530
  end
1813
2531