aws-sdk-frauddetector 1.6.0 → 1.11.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: 734f83ad872880f7ac82923d3d25ed9ba11caa96460d6c93530018a2eddcc795
4
+ data.tar.gz: f0372ec630e8f8ece2ee30507308f606d4fa8e846943857368f8cda108465ab1
5
5
  SHA512:
6
- metadata.gz: 4a0db12e0b84ba5ca80e74bb3ce20377fdcb7ee5a539cd1c1a30e3d91f83020142a030ce30beeeecd09dc004f45b465c5f144d2591ee9b2a253a87f632e97e8c
7
- data.tar.gz: c03c2d6044ce8f71ef053621abd9bf683f307ac3359f42fe68e30b23f8373eec4c193f243b3bf1ec82624a2f3dbb7a3f4ad8ad47326297df99d7024214536780
6
+ metadata.gz: 2cae5294d902d23345bf579f8b38f3a4d93a682989f292f658a66836378c6d73a77435e0d8407587a6e9748437c80e021521f6ac40da0ee9d379fa4de06b8990
7
+ data.tar.gz: 4d78cd5f694bee975bb8a967725cfa90e712a9ec30aab4c32200a307fa4077938cbbfee5a45cdadb102e043df8505fe91919a0870fdcc85d8a1cd8e2dcde3ade
@@ -7,6 +7,7 @@
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
10
+
10
11
  require 'aws-sdk-core'
11
12
  require 'aws-sigv4'
12
13
 
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-frauddetector/customizations'
44
45
  #
45
46
  # See {Errors} for more information.
46
47
  #
47
- # @service
48
+ # @!group service
48
49
  module Aws::FraudDetector
49
50
 
50
- GEM_VERSION = '1.6.0'
51
+ GEM_VERSION = '1.11.0'
51
52
 
52
53
  end
@@ -85,13 +85,28 @@ module Aws::FraudDetector
85
85
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
86
  # credentials.
87
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
+ #
88
102
  # * `Aws::InstanceProfileCredentials` - Used for loading credentials
89
103
  # from an EC2 IMDS on an EC2 instance.
90
104
  #
91
- # * `Aws::SharedCredentials` - Used for loading credentials from a
92
- # shared file, such as `~/.aws/config`.
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
93
107
  #
94
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
95
110
  #
96
111
  # When `:credentials` are not configured directly, the following
97
112
  # locations will be searched for credentials:
@@ -101,10 +116,10 @@ module Aws::FraudDetector
101
116
  # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
102
117
  # * `~/.aws/credentials`
103
118
  # * `~/.aws/config`
104
- # * EC2 IMDS instance profile - When used by default, the timeouts are
105
- # very aggressive. Construct and pass an instance of
106
- # `Aws::InstanceProfileCredentails` to enable retries and extended
107
- # 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.
108
123
  #
109
124
  # @option options [required, String] :region
110
125
  # The AWS region to connect to. The configured `:region` is
@@ -327,6 +342,9 @@ module Aws::FraudDetector
327
342
  # @option params [required, Array<Types::VariableEntry>] :variable_entries
328
343
  # The list of variables for the batch create variable request.
329
344
  #
345
+ # @option params [Array<Types::Tag>] :tags
346
+ # A collection of key and value pairs.
347
+ #
330
348
  # @return [Types::BatchCreateVariableResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
331
349
  #
332
350
  # * {Types::BatchCreateVariableResult#errors #errors} => Array&lt;Types::BatchCreateVariableError&gt;
@@ -344,6 +362,12 @@ module Aws::FraudDetector
344
362
  # variable_type: "string",
345
363
  # },
346
364
  # ],
365
+ # tags: [
366
+ # {
367
+ # key: "tagKey", # required
368
+ # value: "tagValue", # required
369
+ # },
370
+ # ],
347
371
  # })
348
372
  #
349
373
  # @example Response structure
@@ -389,6 +413,7 @@ module Aws::FraudDetector
389
413
  # resp.variables[0].variable_type #=> String
390
414
  # resp.variables[0].last_updated_time #=> String
391
415
  # resp.variables[0].created_time #=> String
416
+ # resp.variables[0].arn #=> String
392
417
  # resp.errors #=> Array
393
418
  # resp.errors[0].name #=> String
394
419
  # resp.errors[0].code #=> Integer
@@ -439,6 +464,9 @@ module Aws::FraudDetector
439
464
  #
440
465
  # The default behavior is `FIRST_MATCHED`.
441
466
  #
467
+ # @option params [Array<Types::Tag>] :tags
468
+ # A collection of key and value pairs.
469
+ #
442
470
  # @return [Types::CreateDetectorVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
443
471
  #
444
472
  # * {Types::CreateDetectorVersionResult#detector_id #detector_id} => String
@@ -455,17 +483,24 @@ module Aws::FraudDetector
455
483
  # {
456
484
  # detector_id: "identifier", # required
457
485
  # rule_id: "identifier", # required
458
- # rule_version: "nonEmptyString", # required
486
+ # rule_version: "wholeNumberVersionString", # required
459
487
  # },
460
488
  # ],
461
489
  # model_versions: [
462
490
  # {
463
- # model_id: "identifier", # required
491
+ # model_id: "modelIdentifier", # required
464
492
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
465
493
  # model_version_number: "nonEmptyString", # required
494
+ # arn: "fraudDetectorArn",
466
495
  # },
467
496
  # ],
468
497
  # rule_execution_mode: "ALL_MATCHED", # accepts ALL_MATCHED, FIRST_MATCHED
498
+ # tags: [
499
+ # {
500
+ # key: "tagKey", # required
501
+ # value: "tagValue", # required
502
+ # },
503
+ # ],
469
504
  # })
470
505
  #
471
506
  # @example Response structure
@@ -483,7 +518,7 @@ module Aws::FraudDetector
483
518
  req.send_request(options)
484
519
  end
485
520
 
486
- # Creates a version of the model using the specified model type.
521
+ # Creates a model using the specified model type.
487
522
  #
488
523
  # @option params [required, String] :model_id
489
524
  # The model ID.
@@ -492,7 +527,61 @@ module Aws::FraudDetector
492
527
  # The model type.
493
528
  #
494
529
  # @option params [String] :description
495
- # 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.
496
585
  #
497
586
  # @return [Types::CreateModelVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
498
587
  #
@@ -504,9 +593,27 @@ module Aws::FraudDetector
504
593
  # @example Request syntax with placeholder values
505
594
  #
506
595
  # resp = client.create_model_version({
507
- # model_id: "identifier", # required
596
+ # model_id: "modelIdentifier", # required
508
597
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
509
- # 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
+ # ],
510
617
  # })
511
618
  #
512
619
  # @example Response structure
@@ -545,6 +652,9 @@ module Aws::FraudDetector
545
652
  # @option params [required, Array<String>] :outcomes
546
653
  # The outcome or outcomes returned when the rule expression matches.
547
654
  #
655
+ # @option params [Array<Types::Tag>] :tags
656
+ # A collection of key and value pairs.
657
+ #
548
658
  # @return [Types::CreateRuleResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
549
659
  #
550
660
  # * {Types::CreateRuleResult#rule #rule} => Types::Rule
@@ -558,6 +668,12 @@ module Aws::FraudDetector
558
668
  # expression: "ruleExpression", # required
559
669
  # language: "DETECTORPL", # required, accepts DETECTORPL
560
670
  # outcomes: ["string"], # required
671
+ # tags: [
672
+ # {
673
+ # key: "tagKey", # required
674
+ # value: "tagValue", # required
675
+ # },
676
+ # ],
561
677
  # })
562
678
  #
563
679
  # @example Response structure
@@ -593,7 +709,24 @@ module Aws::FraudDetector
593
709
  # The description.
594
710
  #
595
711
  # @option params [String] :variable_type
596
- # 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.
597
730
  #
598
731
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
599
732
  #
@@ -606,6 +739,12 @@ module Aws::FraudDetector
606
739
  # default_value: "string", # required
607
740
  # description: "string",
608
741
  # variable_type: "string",
742
+ # tags: [
743
+ # {
744
+ # key: "tagKey", # required
745
+ # value: "tagValue", # required
746
+ # },
747
+ # ],
609
748
  # })
610
749
  #
611
750
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateVariable AWS API Documentation
@@ -656,7 +795,7 @@ module Aws::FraudDetector
656
795
  #
657
796
  # resp = client.delete_detector_version({
658
797
  # detector_id: "identifier", # required
659
- # detector_version_id: "nonEmptyString", # required
798
+ # detector_version_id: "wholeNumberVersionString", # required
660
799
  # })
661
800
  #
662
801
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteDetectorVersion AWS API Documentation
@@ -673,12 +812,16 @@ module Aws::FraudDetector
673
812
  # @option params [required, String] :event_id
674
813
  # The ID of the event to delete.
675
814
  #
815
+ # @option params [required, String] :event_type_name
816
+ # The name of the event type.
817
+ #
676
818
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
677
819
  #
678
820
  # @example Request syntax with placeholder values
679
821
  #
680
822
  # resp = client.delete_event({
681
823
  # event_id: "string", # required
824
+ # event_type_name: "string", # required
682
825
  # })
683
826
  #
684
827
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteEvent AWS API Documentation
@@ -690,34 +833,30 @@ module Aws::FraudDetector
690
833
  req.send_request(options)
691
834
  end
692
835
 
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.
836
+ # Deletes the rule. You cannot delete a rule if it is used by an
837
+ # `ACTIVE` or `INACTIVE` detector version.
698
838
  #
699
- # @option params [required, String] :rule_id
700
- # The rule ID of the rule version to delete.
701
- #
702
- # @option params [required, String] :rule_version
703
- # The rule version to delete.
839
+ # @option params [required, Types::Rule] :rule
840
+ # A rule.
704
841
  #
705
842
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
706
843
  #
707
844
  # @example Request syntax with placeholder values
708
845
  #
709
- # resp = client.delete_rule_version({
710
- # detector_id: "identifier", # required
711
- # rule_id: "identifier", # required
712
- # 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
+ # },
713
852
  # })
714
853
  #
715
- # @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
716
855
  #
717
- # @overload delete_rule_version(params = {})
856
+ # @overload delete_rule(params = {})
718
857
  # @param [Hash] params ({})
719
- def delete_rule_version(params = {}, options = {})
720
- req = build_request(:delete_rule_version, params)
858
+ def delete_rule(params = {}, options = {})
859
+ req = build_request(:delete_rule, params)
721
860
  req.send_request(options)
722
861
  end
723
862
 
@@ -737,6 +876,7 @@ module Aws::FraudDetector
737
876
  # * {Types::DescribeDetectorResult#detector_id #detector_id} => String
738
877
  # * {Types::DescribeDetectorResult#detector_version_summaries #detector_version_summaries} => Array&lt;Types::DetectorVersionSummary&gt;
739
878
  # * {Types::DescribeDetectorResult#next_token #next_token} => String
879
+ # * {Types::DescribeDetectorResult#arn #arn} => String
740
880
  #
741
881
  # @example Request syntax with placeholder values
742
882
  #
@@ -755,6 +895,7 @@ module Aws::FraudDetector
755
895
  # resp.detector_version_summaries[0].description #=> String
756
896
  # resp.detector_version_summaries[0].last_updated_time #=> String
757
897
  # resp.next_token #=> String
898
+ # resp.arn #=> String
758
899
  #
759
900
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DescribeDetector AWS API Documentation
760
901
  #
@@ -773,7 +914,7 @@ module Aws::FraudDetector
773
914
  # The model ID.
774
915
  #
775
916
  # @option params [String] :model_version_number
776
- # The model version.
917
+ # The model version number.
777
918
  #
778
919
  # @option params [String] :model_type
779
920
  # The model type.
@@ -794,8 +935,8 @@ module Aws::FraudDetector
794
935
  # @example Request syntax with placeholder values
795
936
  #
796
937
  # resp = client.describe_model_versions({
797
- # model_id: "identifier",
798
- # model_version_number: "nonEmptyString",
938
+ # model_id: "modelIdentifier",
939
+ # model_version_number: "floatVersionString",
799
940
  # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
800
941
  # next_token: "string",
801
942
  # max_results: 1,
@@ -807,23 +948,34 @@ module Aws::FraudDetector
807
948
  # resp.model_version_details[0].model_id #=> String
808
949
  # resp.model_version_details[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
809
950
  # resp.model_version_details[0].model_version_number #=> String
810
- # resp.model_version_details[0].description #=> String
811
951
  # 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
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
825
976
  # resp.model_version_details[0].last_updated_time #=> String
826
977
  # resp.model_version_details[0].created_time #=> String
978
+ # resp.model_version_details[0].arn #=> String
827
979
  # resp.next_token #=> String
828
980
  #
829
981
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DescribeModelVersions AWS API Documentation
@@ -855,12 +1007,13 @@ module Aws::FraudDetector
855
1007
  # * {Types::GetDetectorVersionResult#last_updated_time #last_updated_time} => String
856
1008
  # * {Types::GetDetectorVersionResult#created_time #created_time} => String
857
1009
  # * {Types::GetDetectorVersionResult#rule_execution_mode #rule_execution_mode} => String
1010
+ # * {Types::GetDetectorVersionResult#arn #arn} => String
858
1011
  #
859
1012
  # @example Request syntax with placeholder values
860
1013
  #
861
1014
  # resp = client.get_detector_version({
862
1015
  # detector_id: "identifier", # required
863
- # detector_version_id: "nonEmptyString", # required
1016
+ # detector_version_id: "wholeNumberVersionString", # required
864
1017
  # })
865
1018
  #
866
1019
  # @example Response structure
@@ -874,6 +1027,7 @@ module Aws::FraudDetector
874
1027
  # resp.model_versions[0].model_id #=> String
875
1028
  # resp.model_versions[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
876
1029
  # resp.model_versions[0].model_version_number #=> String
1030
+ # resp.model_versions[0].arn #=> String
877
1031
  # resp.rules #=> Array
878
1032
  # resp.rules[0].detector_id #=> String
879
1033
  # resp.rules[0].rule_id #=> String
@@ -882,6 +1036,7 @@ module Aws::FraudDetector
882
1036
  # resp.last_updated_time #=> String
883
1037
  # resp.created_time #=> String
884
1038
  # resp.rule_execution_mode #=> String, one of "ALL_MATCHED", "FIRST_MATCHED"
1039
+ # resp.arn #=> String
885
1040
  #
886
1041
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetDetectorVersion AWS API Documentation
887
1042
  #
@@ -892,12 +1047,13 @@ module Aws::FraudDetector
892
1047
  req.send_request(options)
893
1048
  end
894
1049
 
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.
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.
901
1057
  #
902
1058
  # @option params [String] :detector_id
903
1059
  # The detector ID.
@@ -928,8 +1084,10 @@ module Aws::FraudDetector
928
1084
  # resp.detectors #=> Array
929
1085
  # resp.detectors[0].detector_id #=> String
930
1086
  # resp.detectors[0].description #=> String
1087
+ # resp.detectors[0].event_type_name #=> String
931
1088
  # resp.detectors[0].last_updated_time #=> String
932
1089
  # resp.detectors[0].created_time #=> String
1090
+ # resp.detectors[0].arn #=> String
933
1091
  # resp.next_token #=> String
934
1092
  #
935
1093
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetDetectors AWS API Documentation
@@ -941,14 +1099,206 @@ module Aws::FraudDetector
941
1099
  req.send_request(options)
942
1100
  end
943
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
+
944
1295
  # Gets the details for one or more Amazon SageMaker models that have
945
1296
  # 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.
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.
952
1302
  #
953
1303
  # @option params [String] :model_endpoint
954
1304
  # The Amazon SageMaker model endpoint.
@@ -979,10 +1329,10 @@ module Aws::FraudDetector
979
1329
  # resp.external_models #=> Array
980
1330
  # resp.external_models[0].model_endpoint #=> String
981
1331
  # resp.external_models[0].model_source #=> String, one of "SAGEMAKER"
982
- # resp.external_models[0].role.arn #=> String
983
- # 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
984
1334
  # resp.external_models[0].input_configuration.format #=> String, one of "TEXT_CSV", "APPLICATION_JSON"
985
- # resp.external_models[0].input_configuration.is_opaque #=> Boolean
1335
+ # resp.external_models[0].input_configuration.use_event_variables #=> Boolean
986
1336
  # resp.external_models[0].input_configuration.json_input_template #=> String
987
1337
  # resp.external_models[0].input_configuration.csv_input_template #=> String
988
1338
  # resp.external_models[0].output_configuration.format #=> String, one of "TEXT_CSV", "APPLICATION_JSONLINES"
@@ -993,6 +1343,7 @@ module Aws::FraudDetector
993
1343
  # resp.external_models[0].model_endpoint_status #=> String, one of "ASSOCIATED", "DISSOCIATED"
994
1344
  # resp.external_models[0].last_updated_time #=> String
995
1345
  # resp.external_models[0].created_time #=> String
1346
+ # resp.external_models[0].arn #=> String
996
1347
  # resp.next_token #=> String
997
1348
  #
998
1349
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetExternalModels AWS API Documentation
@@ -1004,7 +1355,79 @@ module Aws::FraudDetector
1004
1355
  req.send_request(options)
1005
1356
  end
1006
1357
 
1007
- # 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.
1008
1431
  #
1009
1432
  # @option params [required, String] :model_id
1010
1433
  # The model ID.
@@ -1013,22 +1436,25 @@ module Aws::FraudDetector
1013
1436
  # The model type.
1014
1437
  #
1015
1438
  # @option params [required, String] :model_version_number
1016
- # The model version.
1439
+ # The model version number.
1017
1440
  #
1018
1441
  # @return [Types::GetModelVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1019
1442
  #
1020
1443
  # * {Types::GetModelVersionResult#model_id #model_id} => String
1021
1444
  # * {Types::GetModelVersionResult#model_type #model_type} => String
1022
1445
  # * {Types::GetModelVersionResult#model_version_number #model_version_number} => String
1023
- # * {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
1024
1449
  # * {Types::GetModelVersionResult#status #status} => String
1450
+ # * {Types::GetModelVersionResult#arn #arn} => String
1025
1451
  #
1026
1452
  # @example Request syntax with placeholder values
1027
1453
  #
1028
1454
  # resp = client.get_model_version({
1029
- # model_id: "identifier", # required
1455
+ # model_id: "modelIdentifier", # required
1030
1456
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1031
- # model_version_number: "nonEmptyString", # required
1457
+ # model_version_number: "floatVersionString", # required
1032
1458
  # })
1033
1459
  #
1034
1460
  # @example Response structure
@@ -1036,8 +1462,16 @@ module Aws::FraudDetector
1036
1462
  # resp.model_id #=> String
1037
1463
  # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1038
1464
  # resp.model_version_number #=> String
1039
- # 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
1040
1473
  # resp.status #=> String
1474
+ # resp.arn #=> String
1041
1475
  #
1042
1476
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModelVersion AWS API Documentation
1043
1477
  #
@@ -1048,21 +1482,30 @@ module Aws::FraudDetector
1048
1482
  req.send_request(options)
1049
1483
  end
1050
1484
 
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.
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.
1057
1497
  #
1058
1498
  # @option params [String] :model_id
1059
1499
  # The model ID.
1060
1500
  #
1501
+ # @option params [String] :model_type
1502
+ # The model type.
1503
+ #
1061
1504
  # @option params [String] :next_token
1062
- # The next token for the request.
1505
+ # The next token for the subsequent request.
1063
1506
  #
1064
1507
  # @option params [Integer] :max_results
1065
- # The maximum results to return for the request.
1508
+ # The maximum number of objects to return for the request.
1066
1509
  #
1067
1510
  # @return [Types::GetModelsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1068
1511
  #
@@ -1074,8 +1517,8 @@ module Aws::FraudDetector
1074
1517
  # @example Request syntax with placeholder values
1075
1518
  #
1076
1519
  # resp = client.get_models({
1520
+ # model_id: "modelIdentifier",
1077
1521
  # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
1078
- # model_id: "identifier",
1079
1522
  # next_token: "string",
1080
1523
  # max_results: 1,
1081
1524
  # })
@@ -1087,17 +1530,10 @@ module Aws::FraudDetector
1087
1530
  # resp.models[0].model_id #=> String
1088
1531
  # resp.models[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1089
1532
  # 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
1533
+ # resp.models[0].event_type_name #=> String
1100
1534
  # resp.models[0].created_time #=> String
1535
+ # resp.models[0].last_updated_time #=> String
1536
+ # resp.models[0].arn #=> String
1101
1537
  #
1102
1538
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModels AWS API Documentation
1103
1539
  #
@@ -1109,11 +1545,11 @@ module Aws::FraudDetector
1109
1545
  end
1110
1546
 
1111
1547
  # 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.
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.
1117
1553
  #
1118
1554
  # @option params [String] :name
1119
1555
  # The name of the outcome or outcomes to get.
@@ -1146,6 +1582,7 @@ module Aws::FraudDetector
1146
1582
  # resp.outcomes[0].description #=> String
1147
1583
  # resp.outcomes[0].last_updated_time #=> String
1148
1584
  # resp.outcomes[0].created_time #=> String
1585
+ # resp.outcomes[0].arn #=> String
1149
1586
  # resp.next_token #=> String
1150
1587
  #
1151
1588
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetOutcomes AWS API Documentation
@@ -1157,77 +1594,19 @@ module Aws::FraudDetector
1157
1594
  req.send_request(options)
1158
1595
  end
1159
1596
 
1160
- # Evaluates an event against a detector version. If a version ID is not
1161
- # provided, the detector’s (`ACTIVE`) version is used.
1162
- #
1163
- # @option params [required, String] :detector_id
1164
- # The detector ID.
1165
- #
1166
- # @option params [String] :detector_version_id
1167
- # The detector version ID.
1168
- #
1169
- # @option params [required, String] :event_id
1170
- # The unique ID used to identify the event.
1171
- #
1172
- # @option params [Hash<String,String>] :event_attributes
1173
- # Names of variables you defined in Amazon Fraud Detector to represent
1174
- # event data elements and their corresponding values for the event you
1175
- # are sending for evaluation.
1176
- #
1177
- # @option params [Hash<String,Types::ModelEndpointDataBlob>] :external_model_endpoint_data_blobs
1178
- # The Amazon SageMaker model endpoint input data blobs.
1179
- #
1180
- # @return [Types::GetPredictionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1181
- #
1182
- # * {Types::GetPredictionResult#outcomes #outcomes} => Array&lt;String&gt;
1183
- # * {Types::GetPredictionResult#model_scores #model_scores} => Array&lt;Types::ModelScores&gt;
1184
- # * {Types::GetPredictionResult#rule_results #rule_results} => Array&lt;Types::RuleResult&gt;
1185
- #
1186
- # @example Request syntax with placeholder values
1187
- #
1188
- # resp = client.get_prediction({
1189
- # detector_id: "string", # required
1190
- # detector_version_id: "string",
1191
- # event_id: "string", # required
1192
- # event_attributes: {
1193
- # "attributeKey" => "attributeValue",
1194
- # },
1195
- # external_model_endpoint_data_blobs: {
1196
- # "string" => {
1197
- # byte_buffer: "data",
1198
- # content_type: "contentType",
1199
- # },
1200
- # },
1201
- # })
1202
- #
1203
- # @example Response structure
1204
- #
1205
- # resp.outcomes #=> Array
1206
- # resp.outcomes[0] #=> String
1207
- # resp.model_scores #=> Array
1208
- # resp.model_scores[0].model_version.model_id #=> String
1209
- # resp.model_scores[0].model_version.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1210
- # resp.model_scores[0].model_version.model_version_number #=> String
1211
- # resp.model_scores[0].scores #=> Hash
1212
- # resp.model_scores[0].scores["string"] #=> Float
1213
- # resp.rule_results #=> Array
1214
- # resp.rule_results[0].rule_id #=> String
1215
- # resp.rule_results[0].outcomes #=> Array
1216
- # resp.rule_results[0].outcomes[0] #=> String
1217
- #
1218
- # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetPrediction AWS API Documentation
1219
- #
1220
- # @overload get_prediction(params = {})
1221
- # @param [Hash] params ({})
1222
- def get_prediction(params = {}, options = {})
1223
- req = build_request(:get_prediction, params)
1224
- req.send_request(options)
1225
- end
1226
-
1227
- # Gets all rules available for the specified detector.
1228
- #
1229
- # @option params [String] :rule_id
1230
- # 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.
1231
1610
  #
1232
1611
  # @option params [required, String] :detector_id
1233
1612
  # The detector ID.
@@ -1253,7 +1632,7 @@ module Aws::FraudDetector
1253
1632
  # resp = client.get_rules({
1254
1633
  # rule_id: "identifier",
1255
1634
  # detector_id: "identifier", # required
1256
- # rule_version: "nonEmptyString",
1635
+ # rule_version: "wholeNumberVersionString",
1257
1636
  # next_token: "string",
1258
1637
  # max_results: 1,
1259
1638
  # })
@@ -1271,6 +1650,7 @@ module Aws::FraudDetector
1271
1650
  # resp.rule_details[0].outcomes[0] #=> String
1272
1651
  # resp.rule_details[0].last_updated_time #=> String
1273
1652
  # resp.rule_details[0].created_time #=> String
1653
+ # resp.rule_details[0].arn #=> String
1274
1654
  # resp.next_token #=> String
1275
1655
  #
1276
1656
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetRules AWS API Documentation
@@ -1324,6 +1704,7 @@ module Aws::FraudDetector
1324
1704
  # resp.variables[0].variable_type #=> String
1325
1705
  # resp.variables[0].last_updated_time #=> String
1326
1706
  # resp.variables[0].created_time #=> String
1707
+ # resp.variables[0].arn #=> String
1327
1708
  # resp.next_token #=> String
1328
1709
  #
1329
1710
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetVariables AWS API Documentation
@@ -1335,6 +1716,51 @@ module Aws::FraudDetector
1335
1716
  req.send_request(options)
1336
1717
  end
1337
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
+
1338
1764
  # Creates or updates a detector.
1339
1765
  #
1340
1766
  # @option params [required, String] :detector_id
@@ -1343,6 +1769,12 @@ module Aws::FraudDetector
1343
1769
  # @option params [String] :description
1344
1770
  # The description of the detector.
1345
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
+ #
1346
1778
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1347
1779
  #
1348
1780
  # @example Request syntax with placeholder values
@@ -1350,6 +1782,13 @@ module Aws::FraudDetector
1350
1782
  # resp = client.put_detector({
1351
1783
  # detector_id: "identifier", # required
1352
1784
  # description: "description",
1785
+ # event_type_name: "identifier", # required
1786
+ # tags: [
1787
+ # {
1788
+ # key: "tagKey", # required
1789
+ # value: "tagValue", # required
1790
+ # },
1791
+ # ],
1353
1792
  # })
1354
1793
  #
1355
1794
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutDetector AWS API Documentation
@@ -1361,6 +1800,100 @@ module Aws::FraudDetector
1361
1800
  req.send_request(options)
1362
1801
  end
1363
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
+
1364
1897
  # Creates or updates an Amazon SageMaker model endpoint. You can also
1365
1898
  # use this action to update the configuration of the model endpoint,
1366
1899
  # including the IAM role and/or the mapped variables.
@@ -1371,7 +1904,7 @@ module Aws::FraudDetector
1371
1904
  # @option params [required, String] :model_source
1372
1905
  # The source of the model.
1373
1906
  #
1374
- # @option params [required, Types::Role] :role
1907
+ # @option params [required, String] :invoke_model_endpoint_role_arn
1375
1908
  # The IAM role used to invoke the model endpoint.
1376
1909
  #
1377
1910
  # @option params [required, Types::ModelInputConfiguration] :input_configuration
@@ -1383,20 +1916,21 @@ module Aws::FraudDetector
1383
1916
  # @option params [required, String] :model_endpoint_status
1384
1917
  # The model endpoint’s status in Amazon Fraud Detector.
1385
1918
  #
1919
+ # @option params [Array<Types::Tag>] :tags
1920
+ # A collection of key and value pairs.
1921
+ #
1386
1922
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1387
1923
  #
1388
1924
  # @example Request syntax with placeholder values
1389
1925
  #
1390
1926
  # resp = client.put_external_model({
1391
- # model_endpoint: "string", # required
1927
+ # model_endpoint: "sageMakerEndpointIdentifier", # required
1392
1928
  # model_source: "SAGEMAKER", # required, accepts SAGEMAKER
1393
- # role: { # required
1394
- # arn: "string", # required
1395
- # name: "string", # required
1396
- # },
1929
+ # invoke_model_endpoint_role_arn: "string", # required
1397
1930
  # input_configuration: { # required
1931
+ # event_type_name: "identifier",
1398
1932
  # format: "TEXT_CSV", # accepts TEXT_CSV, APPLICATION_JSON
1399
- # is_opaque: false, # required
1933
+ # use_event_variables: false, # required
1400
1934
  # json_input_template: "string",
1401
1935
  # csv_input_template: "string",
1402
1936
  # },
@@ -1410,6 +1944,12 @@ module Aws::FraudDetector
1410
1944
  # },
1411
1945
  # },
1412
1946
  # model_endpoint_status: "ASSOCIATED", # required, accepts ASSOCIATED, DISSOCIATED
1947
+ # tags: [
1948
+ # {
1949
+ # key: "tagKey", # required
1950
+ # value: "tagValue", # required
1951
+ # },
1952
+ # ],
1413
1953
  # })
1414
1954
  #
1415
1955
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutExternalModel AWS API Documentation
@@ -1421,58 +1961,62 @@ module Aws::FraudDetector
1421
1961
  req.send_request(options)
1422
1962
  end
1423
1963
 
1424
- # 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.
1425
1966
  #
1426
- # @option params [required, String] :model_id
1427
- # The model ID.
1967
+ # @option params [required, String] :kms_encryption_key_arn
1968
+ # The KMS encryption key ARN.
1428
1969
  #
1429
- # @option params [required, String] :model_type
1430
- # The model type.
1970
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1431
1971
  #
1432
- # @option params [String] :description
1433
- # The model description.
1972
+ # @example Request syntax with placeholder values
1434
1973
  #
1435
- # @option params [required, Types::TrainingDataSource] :training_data_source
1436
- # 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.
1437
1993
  #
1438
- # @option params [required, Array<Types::ModelVariable>] :model_variables
1439
- # The model input variables.
1994
+ # @option params [String] :description
1995
+ # The label description.
1440
1996
  #
1441
- # @option params [required, Types::LabelSchema] :label_schema
1442
- # The label schema.
1997
+ # @option params [Array<Types::Tag>] :tags
1443
1998
  #
1444
1999
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1445
2000
  #
1446
2001
  # @example Request syntax with placeholder values
1447
2002
  #
1448
- # resp = client.put_model({
1449
- # model_id: "identifier", # required
1450
- # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
2003
+ # resp = client.put_label({
2004
+ # name: "identifier", # required
1451
2005
  # description: "description",
1452
- # training_data_source: { # required
1453
- # data_location: "s3BucketLocation", # required
1454
- # data_access_role_arn: "iamRoleArn", # required
1455
- # },
1456
- # model_variables: [ # required
2006
+ # tags: [
1457
2007
  # {
1458
- # name: "string", # required
1459
- # index: 1,
2008
+ # key: "tagKey", # required
2009
+ # value: "tagValue", # required
1460
2010
  # },
1461
2011
  # ],
1462
- # label_schema: { # required
1463
- # label_key: "string", # required
1464
- # label_mapper: { # required
1465
- # "string" => ["string"],
1466
- # },
1467
- # },
1468
2012
  # })
1469
2013
  #
1470
- # @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
1471
2015
  #
1472
- # @overload put_model(params = {})
2016
+ # @overload put_label(params = {})
1473
2017
  # @param [Hash] params ({})
1474
- def put_model(params = {}, options = {})
1475
- req = build_request(:put_model, params)
2018
+ def put_label(params = {}, options = {})
2019
+ req = build_request(:put_label, params)
1476
2020
  req.send_request(options)
1477
2021
  end
1478
2022
 
@@ -1484,6 +2028,9 @@ module Aws::FraudDetector
1484
2028
  # @option params [String] :description
1485
2029
  # The outcome description.
1486
2030
  #
2031
+ # @option params [Array<Types::Tag>] :tags
2032
+ # A collection of key and value pairs.
2033
+ #
1487
2034
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1488
2035
  #
1489
2036
  # @example Request syntax with placeholder values
@@ -1491,6 +2038,12 @@ module Aws::FraudDetector
1491
2038
  # resp = client.put_outcome({
1492
2039
  # name: "identifier", # required
1493
2040
  # description: "description",
2041
+ # tags: [
2042
+ # {
2043
+ # key: "tagKey", # required
2044
+ # value: "tagValue", # required
2045
+ # },
2046
+ # ],
1494
2047
  # })
1495
2048
  #
1496
2049
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutOutcome AWS API Documentation
@@ -1502,9 +2055,67 @@ module Aws::FraudDetector
1502
2055
  req.send_request(options)
1503
2056
  end
1504
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
+
1505
2115
  # 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.
2116
+ # can update include models, external model endpoints, rules, rule
2117
+ # execution mode, and description. You can only update a `DRAFT`
2118
+ # detector version.
1508
2119
  #
1509
2120
  # @option params [required, String] :detector_id
1510
2121
  # The parent detector ID for the detector version you want to update.
@@ -1546,21 +2157,22 @@ module Aws::FraudDetector
1546
2157
  #
1547
2158
  # resp = client.update_detector_version({
1548
2159
  # detector_id: "identifier", # required
1549
- # detector_version_id: "nonEmptyString", # required
2160
+ # detector_version_id: "wholeNumberVersionString", # required
1550
2161
  # external_model_endpoints: ["string"], # required
1551
2162
  # rules: [ # required
1552
2163
  # {
1553
2164
  # detector_id: "identifier", # required
1554
2165
  # rule_id: "identifier", # required
1555
- # rule_version: "nonEmptyString", # required
2166
+ # rule_version: "wholeNumberVersionString", # required
1556
2167
  # },
1557
2168
  # ],
1558
2169
  # description: "description",
1559
2170
  # model_versions: [
1560
2171
  # {
1561
- # model_id: "identifier", # required
2172
+ # model_id: "modelIdentifier", # required
1562
2173
  # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1563
2174
  # model_version_number: "nonEmptyString", # required
2175
+ # arn: "fraudDetectorArn",
1564
2176
  # },
1565
2177
  # ],
1566
2178
  # rule_execution_mode: "ALL_MATCHED", # accepts ALL_MATCHED, FIRST_MATCHED
@@ -1593,7 +2205,7 @@ module Aws::FraudDetector
1593
2205
  #
1594
2206
  # resp = client.update_detector_version_metadata({
1595
2207
  # detector_id: "identifier", # required
1596
- # detector_version_id: "nonEmptyString", # required
2208
+ # detector_version_id: "wholeNumberVersionString", # required
1597
2209
  # description: "description", # required
1598
2210
  # })
1599
2211
  #
@@ -1625,7 +2237,7 @@ module Aws::FraudDetector
1625
2237
  #
1626
2238
  # resp = client.update_detector_version_status({
1627
2239
  # detector_id: "identifier", # required
1628
- # detector_version_id: "nonEmptyString", # required
2240
+ # detector_version_id: "wholeNumberVersionString", # required
1629
2241
  # status: "DRAFT", # required, accepts DRAFT, ACTIVE, INACTIVE
1630
2242
  # })
1631
2243
  #
@@ -1638,13 +2250,43 @@ module Aws::FraudDetector
1638
2250
  req.send_request(options)
1639
2251
  end
1640
2252
 
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:
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.
1644
2258
  #
1645
- # 1. Change the `TRAINING_COMPLETE` status to `ACTIVE`
2259
+ # @option params [required, String] :model_type
2260
+ # The model type.
1646
2261
  #
1647
- # 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.
1648
2290
  #
1649
2291
  # @option params [required, String] :model_id
1650
2292
  # The model ID.
@@ -1652,27 +2294,47 @@ module Aws::FraudDetector
1652
2294
  # @option params [required, String] :model_type
1653
2295
  # The model type.
1654
2296
  #
1655
- # @option params [required, String] :model_version_number
1656
- # The model version.
2297
+ # @option params [required, String] :major_version_number
2298
+ # The major version number.
1657
2299
  #
1658
- # @option params [required, String] :description
1659
- # The model description.
2300
+ # @option params [Types::ExternalEventsDetail] :external_events_detail
2301
+ # The event details.
1660
2302
  #
1661
- # @option params [required, String] :status
1662
- # The new model status.
2303
+ # @option params [Array<Types::Tag>] :tags
2304
+ # A collection of key and value pairs.
1663
2305
  #
1664
- # @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
1665
2312
  #
1666
2313
  # @example Request syntax with placeholder values
1667
2314
  #
1668
2315
  # resp = client.update_model_version({
1669
- # model_id: "identifier", # required
2316
+ # model_id: "modelIdentifier", # required
1670
2317
  # 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
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
+ # ],
1674
2329
  # })
1675
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
+ #
1676
2338
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelVersion AWS API Documentation
1677
2339
  #
1678
2340
  # @overload update_model_version(params = {})
@@ -1682,7 +2344,47 @@ module Aws::FraudDetector
1682
2344
  req.send_request(options)
1683
2345
  end
1684
2346
 
1685
- # 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.
1686
2388
  #
1687
2389
  # @option params [required, Types::Rule] :rule
1688
2390
  # The rule to update.
@@ -1698,7 +2400,7 @@ module Aws::FraudDetector
1698
2400
  # rule: { # required
1699
2401
  # detector_id: "identifier", # required
1700
2402
  # rule_id: "identifier", # required
1701
- # rule_version: "nonEmptyString", # required
2403
+ # rule_version: "wholeNumberVersionString", # required
1702
2404
  # },
1703
2405
  # description: "description", # required
1704
2406
  # })
@@ -1712,7 +2414,8 @@ module Aws::FraudDetector
1712
2414
  req.send_request(options)
1713
2415
  end
1714
2416
 
1715
- # 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 ...).
1716
2419
  #
1717
2420
  # @option params [required, Types::Rule] :rule
1718
2421
  # The rule to update.
@@ -1729,6 +2432,9 @@ module Aws::FraudDetector
1729
2432
  # @option params [required, Array<String>] :outcomes
1730
2433
  # The outcomes.
1731
2434
  #
2435
+ # @option params [Array<Types::Tag>] :tags
2436
+ # The tags to assign to the rule version.
2437
+ #
1732
2438
  # @return [Types::UpdateRuleVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1733
2439
  #
1734
2440
  # * {Types::UpdateRuleVersionResult#rule #rule} => Types::Rule
@@ -1739,12 +2445,18 @@ module Aws::FraudDetector
1739
2445
  # rule: { # required
1740
2446
  # detector_id: "identifier", # required
1741
2447
  # rule_id: "identifier", # required
1742
- # rule_version: "nonEmptyString", # required
2448
+ # rule_version: "wholeNumberVersionString", # required
1743
2449
  # },
1744
2450
  # description: "description",
1745
2451
  # expression: "ruleExpression", # required
1746
2452
  # language: "DETECTORPL", # required, accepts DETECTORPL
1747
2453
  # outcomes: ["string"], # required
2454
+ # tags: [
2455
+ # {
2456
+ # key: "tagKey", # required
2457
+ # value: "tagValue", # required
2458
+ # },
2459
+ # ],
1748
2460
  # })
1749
2461
  #
1750
2462
  # @example Response structure
@@ -1774,7 +2486,11 @@ module Aws::FraudDetector
1774
2486
  # The new description.
1775
2487
  #
1776
2488
  # @option params [String] :variable_type
1777
- # 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
1778
2494
  #
1779
2495
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1780
2496
  #
@@ -1809,7 +2525,7 @@ module Aws::FraudDetector
1809
2525
  params: params,
1810
2526
  config: config)
1811
2527
  context[:gem_name] = 'aws-sdk-frauddetector'
1812
- context[:gem_version] = '1.6.0'
2528
+ context[:gem_version] = '1.11.0'
1813
2529
  Seahorse::Client::Request.new(handlers, context)
1814
2530
  end
1815
2531