aws-sdk-frauddetector 1.0.0 → 1.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 948080722c552a7339070b285f8cd52023ee80eb
4
- data.tar.gz: ba5aa663d2b4eb4e8ec96990ebc55ab15b1e1f11
2
+ SHA256:
3
+ metadata.gz: a7bc9c837a2dced26995dd842a379e5a09605fad2408ba063973a87890c20b6b
4
+ data.tar.gz: 6f82f982139961b3fb9df5214167e547ef330f95823554687c494a7cc2e29830
5
5
  SHA512:
6
- metadata.gz: 5833c045b810bd56f061bd4bc07c53777c0b1533b3f8645bdd1921f5deff86c424b085546955224e98c8d98f31d839d93b0c4c1333d09c8b84f3a9095e52329d
7
- data.tar.gz: f406d5c136bce1926fd3a7844de54884490e72335dddac4e200acc4ebfdc94b14bca41be5ae1d1e86e8861f7599bdb2abf42417c299ed9c8997c320a4175bf03
6
+ metadata.gz: 84ccf4578bdb206fc1ae2ea2dfb628d7aecf83fe97e738ce21ab226e64fa3d5b273d4bb8687e1c59b43aa40083e748ff43c01b13b975252ab2b272f4727e5ddc
7
+ data.tar.gz: 235dfcb901764d14ed09720384a226effefa87f2b59897345905bf17dc37b91ff87f56a722e0482fff576854e0a7d9375606ccf62a76d86d9518f5b2bc35cc70
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-frauddetector/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # fraud_detector = Aws::FraudDetector::Client.new
28
+ # resp = fraud_detector.batch_create_variable(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from Amazon Fraud Detector all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from Amazon Fraud Detector are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::FraudDetector::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all Amazon Fraud Detector API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-frauddetector/customizations'
42
45
  # @service
43
46
  module Aws::FraudDetector
44
47
 
45
- GEM_VERSION = '1.0.0'
48
+ GEM_VERSION = '1.5.1'
46
49
 
47
50
  end
@@ -24,12 +24,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
24
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
25
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
26
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
27
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
28
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
29
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
29
30
 
30
31
  Aws::Plugins::GlobalConfiguration.add_identifier(:frauddetector)
31
32
 
32
33
  module Aws::FraudDetector
34
+ # An API client for FraudDetector. To construct a client, you need to configure a `:region` and `:credentials`.
35
+ #
36
+ # client = Aws::FraudDetector::Client.new(
37
+ # region: region_name,
38
+ # credentials: credentials,
39
+ # # ...
40
+ # )
41
+ #
42
+ # For details on configuring region and credentials see
43
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
44
+ #
45
+ # See {#initialize} for a full list of supported configuration options.
33
46
  class Client < Seahorse::Client::Base
34
47
 
35
48
  include Aws::ClientStubs
@@ -57,6 +70,7 @@ module Aws::FraudDetector
57
70
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
58
71
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
59
72
  add_plugin(Aws::Plugins::TransferEncoding)
73
+ add_plugin(Aws::Plugins::HttpChecksum)
60
74
  add_plugin(Aws::Plugins::SignatureV4)
61
75
  add_plugin(Aws::Plugins::Protocols::JsonRpc)
62
76
 
@@ -93,7 +107,7 @@ module Aws::FraudDetector
93
107
  # @option options [required, String] :region
94
108
  # The AWS region to connect to. The configured `:region` is
95
109
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
110
+ # a default `:region` is searched for in the following locations:
97
111
  #
98
112
  # * `Aws.config[:region]`
99
113
  # * `ENV['AWS_REGION']`
@@ -108,6 +122,12 @@ module Aws::FraudDetector
108
122
  # When set to `true`, a thread polling for endpoints will be running in
109
123
  # the background every 60 secs (default). Defaults to `false`.
110
124
  #
125
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
126
+ # Used only in `adaptive` retry mode. When true, the request will sleep
127
+ # until there is sufficent client side capacity to retry the request.
128
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
129
+ # not retry instead of sleeping.
130
+ #
111
131
  # @option options [Boolean] :client_side_monitoring (false)
112
132
  # When `true`, client-side metrics will be collected for all API requests from
113
133
  # this client.
@@ -132,6 +152,10 @@ module Aws::FraudDetector
132
152
  # When `true`, an attempt is made to coerce request parameters into
133
153
  # the required types.
134
154
  #
155
+ # @option options [Boolean] :correct_clock_skew (true)
156
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
157
+ # a clock skew correction and retry requests with skewed client clocks.
158
+ #
135
159
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
160
  # Set to true to disable SDK automatically adding host prefix
137
161
  # to default service endpoint when available.
@@ -139,7 +163,7 @@ module Aws::FraudDetector
139
163
  # @option options [String] :endpoint
140
164
  # The client endpoint is normally constructed from the `:region`
141
165
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
166
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
143
167
  #
144
168
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
169
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +178,7 @@ module Aws::FraudDetector
154
178
  # requests fetching endpoints information. Defaults to 60 sec.
155
179
  #
156
180
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
181
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
182
  #
159
183
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
184
  # The log formatter.
@@ -166,15 +190,29 @@ module Aws::FraudDetector
166
190
  # The Logger instance to send log messages to. If this option
167
191
  # is not set, logging will be disabled.
168
192
  #
193
+ # @option options [Integer] :max_attempts (3)
194
+ # An integer representing the maximum number attempts that will be made for
195
+ # a single request, including the initial attempt. For example,
196
+ # setting this value to 5 will result in a request being retried up to
197
+ # 4 times. Used in `standard` and `adaptive` retry modes.
198
+ #
169
199
  # @option options [String] :profile ("default")
170
200
  # Used when loading credentials from the shared credentials file
171
201
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
202
  #
203
+ # @option options [Proc] :retry_backoff
204
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
205
+ # This option is only used in the `legacy` retry mode.
206
+ #
173
207
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
208
+ # The base delay in seconds used by the default backoff function. This option
209
+ # is only used in the `legacy` retry mode.
175
210
  #
176
211
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
212
+ # A delay randomiser function used by the default backoff function.
213
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
214
+ # otherwise a Proc that takes and returns a number. This option is only used
215
+ # in the `legacy` retry mode.
178
216
  #
179
217
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
218
  #
@@ -182,11 +220,30 @@ module Aws::FraudDetector
182
220
  # The maximum number of times to retry failed requests. Only
183
221
  # ~ 500 level server errors and certain ~ 400 level client errors
184
222
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
223
+ # checksum errors, networking errors, timeout errors, auth errors,
224
+ # endpoint discovery, and errors from expired credentials.
225
+ # This option is only used in the `legacy` retry mode.
187
226
  #
188
227
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
228
+ # The maximum number of seconds to delay between retries (0 for no limit)
229
+ # used by the default backoff function. This option is only used in the
230
+ # `legacy` retry mode.
231
+ #
232
+ # @option options [String] :retry_mode ("legacy")
233
+ # Specifies which retry algorithm to use. Values are:
234
+ #
235
+ # * `legacy` - The pre-existing retry behavior. This is default value if
236
+ # no retry mode is provided.
237
+ #
238
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
239
+ # This includes support for retry quotas, which limit the number of
240
+ # unsuccessful retries a client can make.
241
+ #
242
+ # * `adaptive` - An experimental retry mode that includes all the
243
+ # functionality of `standard` mode along with automatic client side
244
+ # throttling. This is a provisional mode that may change behavior
245
+ # in the future.
246
+ #
190
247
  #
191
248
  # @option options [String] :secret_access_key
192
249
  #
@@ -219,16 +276,15 @@ module Aws::FraudDetector
219
276
  # requests through. Formatted like 'http://proxy.com:123'.
220
277
  #
221
278
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
279
+ # seconds to wait when opening a HTTP session before raising a
223
280
  # `Timeout::Error`.
224
281
  #
225
282
  # @option options [Integer] :http_read_timeout (60) The default
226
283
  # number of seconds to wait for response data. This value can
227
- # safely be set
228
- # per-request on the session yeidled by {#session_for}.
284
+ # safely be set per-request on the session.
229
285
  #
230
286
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
287
+ # seconds a connection is allowed to sit idle before it is
232
288
  # considered stale. Stale connections are closed and removed
233
289
  # from the pool before making a request.
234
290
  #
@@ -237,7 +293,7 @@ module Aws::FraudDetector
237
293
  # request body. This option has no effect unless the request has
238
294
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
295
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
296
+ # request on the session.
241
297
  #
242
298
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
299
  # HTTP debug output will be sent to the `:logger`.
@@ -364,6 +420,23 @@ module Aws::FraudDetector
364
420
  # @option params [Array<Types::ModelVersion>] :model_versions
365
421
  # The model versions to include in the detector version.
366
422
  #
423
+ # @option params [String] :rule_execution_mode
424
+ # The rule execution mode for the rules included in the detector
425
+ # version.
426
+ #
427
+ # You can define and edit the rule mode at the detector version level,
428
+ # when it is in draft status.
429
+ #
430
+ # If you specify `FIRST_MATCHED`, Amazon Fraud Detector evaluates rules
431
+ # sequentially, first to last, stopping at the first matched rule.
432
+ # Amazon Fraud dectector then provides the outcomes for that single
433
+ # rule.
434
+ #
435
+ # If you specifiy `ALL_MATCHED`, Amazon Fraud Detector evaluates all
436
+ # rules and returns the outcomes for all matched rules.
437
+ #
438
+ # The default behavior is `FIRST_MATCHED`.
439
+ #
367
440
  # @return [Types::CreateDetectorVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
368
441
  #
369
442
  # * {Types::CreateDetectorVersionResult#detector_id #detector_id} => String
@@ -390,6 +463,7 @@ module Aws::FraudDetector
390
463
  # model_version_number: "nonEmptyString", # required
391
464
  # },
392
465
  # ],
466
+ # rule_execution_mode: "ALL_MATCHED", # accepts ALL_MATCHED, FIRST_MATCHED
393
467
  # })
394
468
  #
395
469
  # @example Response structure
@@ -541,7 +615,32 @@ module Aws::FraudDetector
541
615
  req.send_request(options)
542
616
  end
543
617
 
544
- # Deletes the detector version.
618
+ # Deletes the detector. Before deleting a detector, you must first
619
+ # delete all detector versions and rule versions associated with the
620
+ # detector.
621
+ #
622
+ # @option params [required, String] :detector_id
623
+ # The ID of the detector to delete.
624
+ #
625
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
626
+ #
627
+ # @example Request syntax with placeholder values
628
+ #
629
+ # resp = client.delete_detector({
630
+ # detector_id: "identifier", # required
631
+ # })
632
+ #
633
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteDetector AWS API Documentation
634
+ #
635
+ # @overload delete_detector(params = {})
636
+ # @param [Hash] params ({})
637
+ def delete_detector(params = {}, options = {})
638
+ req = build_request(:delete_detector, params)
639
+ req.send_request(options)
640
+ end
641
+
642
+ # Deletes the detector version. You cannot delete detector versions that
643
+ # are in `ACTIVE` status.
545
644
  #
546
645
  # @option params [required, String] :detector_id
547
646
  # The ID of the parent detector for the detector version to delete.
@@ -589,6 +688,37 @@ module Aws::FraudDetector
589
688
  req.send_request(options)
590
689
  end
591
690
 
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.
699
+ #
700
+ # @option params [required, String] :rule_version
701
+ # The rule version to delete.
702
+ #
703
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
704
+ #
705
+ # @example Request syntax with placeholder values
706
+ #
707
+ # resp = client.delete_rule_version({
708
+ # detector_id: "identifier", # required
709
+ # rule_id: "identifier", # required
710
+ # rule_version: "nonEmptyString", # required
711
+ # })
712
+ #
713
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteRuleVersion AWS API Documentation
714
+ #
715
+ # @overload delete_rule_version(params = {})
716
+ # @param [Hash] params ({})
717
+ def delete_rule_version(params = {}, options = {})
718
+ req = build_request(:delete_rule_version, params)
719
+ req.send_request(options)
720
+ end
721
+
592
722
  # Gets all versions for a specified detector.
593
723
  #
594
724
  # @option params [required, String] :detector_id
@@ -657,6 +787,8 @@ module Aws::FraudDetector
657
787
  # * {Types::DescribeModelVersionsResult#model_version_details #model_version_details} => Array&lt;Types::ModelVersionDetail&gt;
658
788
  # * {Types::DescribeModelVersionsResult#next_token #next_token} => String
659
789
  #
790
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
791
+ #
660
792
  # @example Request syntax with placeholder values
661
793
  #
662
794
  # resp = client.describe_model_versions({
@@ -720,6 +852,7 @@ module Aws::FraudDetector
720
852
  # * {Types::GetDetectorVersionResult#status #status} => String
721
853
  # * {Types::GetDetectorVersionResult#last_updated_time #last_updated_time} => String
722
854
  # * {Types::GetDetectorVersionResult#created_time #created_time} => String
855
+ # * {Types::GetDetectorVersionResult#rule_execution_mode #rule_execution_mode} => String
723
856
  #
724
857
  # @example Request syntax with placeholder values
725
858
  #
@@ -746,6 +879,7 @@ module Aws::FraudDetector
746
879
  # resp.status #=> String, one of "DRAFT", "ACTIVE", "INACTIVE"
747
880
  # resp.last_updated_time #=> String
748
881
  # resp.created_time #=> String
882
+ # resp.rule_execution_mode #=> String, one of "ALL_MATCHED", "FIRST_MATCHED"
749
883
  #
750
884
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetDetectorVersion AWS API Documentation
751
885
  #
@@ -777,6 +911,8 @@ module Aws::FraudDetector
777
911
  # * {Types::GetDetectorsResult#detectors #detectors} => Array&lt;Types::Detector&gt;
778
912
  # * {Types::GetDetectorsResult#next_token #next_token} => String
779
913
  #
914
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
915
+ #
780
916
  # @example Request syntax with placeholder values
781
917
  #
782
918
  # resp = client.get_detectors({
@@ -826,6 +962,8 @@ module Aws::FraudDetector
826
962
  # * {Types::GetExternalModelsResult#external_models #external_models} => Array&lt;Types::ExternalModel&gt;
827
963
  # * {Types::GetExternalModelsResult#next_token #next_token} => String
828
964
  #
965
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
966
+ #
829
967
  # @example Request syntax with placeholder values
830
968
  #
831
969
  # resp = client.get_external_models({
@@ -929,6 +1067,8 @@ module Aws::FraudDetector
929
1067
  # * {Types::GetModelsResult#next_token #next_token} => String
930
1068
  # * {Types::GetModelsResult#models #models} => Array&lt;Types::Model&gt;
931
1069
  #
1070
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1071
+ #
932
1072
  # @example Request syntax with placeholder values
933
1073
  #
934
1074
  # resp = client.get_models({
@@ -987,6 +1127,8 @@ module Aws::FraudDetector
987
1127
  # * {Types::GetOutcomesResult#outcomes #outcomes} => Array&lt;Types::Outcome&gt;
988
1128
  # * {Types::GetOutcomesResult#next_token #next_token} => String
989
1129
  #
1130
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1131
+ #
990
1132
  # @example Request syntax with placeholder values
991
1133
  #
992
1134
  # resp = client.get_outcomes({
@@ -1037,6 +1179,7 @@ module Aws::FraudDetector
1037
1179
  #
1038
1180
  # * {Types::GetPredictionResult#outcomes #outcomes} => Array&lt;String&gt;
1039
1181
  # * {Types::GetPredictionResult#model_scores #model_scores} => Array&lt;Types::ModelScores&gt;
1182
+ # * {Types::GetPredictionResult#rule_results #rule_results} => Array&lt;Types::RuleResult&gt;
1040
1183
  #
1041
1184
  # @example Request syntax with placeholder values
1042
1185
  #
@@ -1065,6 +1208,10 @@ module Aws::FraudDetector
1065
1208
  # resp.model_scores[0].model_version.model_version_number #=> String
1066
1209
  # resp.model_scores[0].scores #=> Hash
1067
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
1068
1215
  #
1069
1216
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetPrediction AWS API Documentation
1070
1217
  #
@@ -1097,6 +1244,8 @@ module Aws::FraudDetector
1097
1244
  # * {Types::GetRulesResult#rule_details #rule_details} => Array&lt;Types::RuleDetail&gt;
1098
1245
  # * {Types::GetRulesResult#next_token #next_token} => String
1099
1246
  #
1247
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1248
+ #
1100
1249
  # @example Request syntax with placeholder values
1101
1250
  #
1102
1251
  # resp = client.get_rules({
@@ -1152,6 +1301,8 @@ module Aws::FraudDetector
1152
1301
  # * {Types::GetVariablesResult#variables #variables} => Array&lt;Types::Variable&gt;
1153
1302
  # * {Types::GetVariablesResult#next_token #next_token} => String
1154
1303
  #
1304
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1305
+ #
1155
1306
  # @example Request syntax with placeholder values
1156
1307
  #
1157
1308
  # resp = client.get_variables({
@@ -1372,6 +1523,21 @@ module Aws::FraudDetector
1372
1523
  # @option params [Array<Types::ModelVersion>] :model_versions
1373
1524
  # The model versions to include in the detector version.
1374
1525
  #
1526
+ # @option params [String] :rule_execution_mode
1527
+ # The rule execution mode to add to the detector.
1528
+ #
1529
+ # If you specify `FIRST_MATCHED`, Amazon Fraud Detector evaluates rules
1530
+ # sequentially, first to last, stopping at the first matched rule.
1531
+ # Amazon Fraud dectector then provides the outcomes for that single
1532
+ # rule.
1533
+ #
1534
+ # If you specifiy `ALL_MATCHED`, Amazon Fraud Detector evaluates all
1535
+ # rules and returns the outcomes for all matched rules. You can define
1536
+ # and edit the rule mode at the detector version level, when it is in
1537
+ # draft status.
1538
+ #
1539
+ # The default behavior is `FIRST_MATCHED`.
1540
+ #
1375
1541
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1376
1542
  #
1377
1543
  # @example Request syntax with placeholder values
@@ -1395,6 +1561,7 @@ module Aws::FraudDetector
1395
1561
  # model_version_number: "nonEmptyString", # required
1396
1562
  # },
1397
1563
  # ],
1564
+ # rule_execution_mode: "ALL_MATCHED", # accepts ALL_MATCHED, FIRST_MATCHED
1398
1565
  # })
1399
1566
  #
1400
1567
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateDetectorVersion AWS API Documentation
@@ -1640,7 +1807,7 @@ module Aws::FraudDetector
1640
1807
  params: params,
1641
1808
  config: config)
1642
1809
  context[:gem_name] = 'aws-sdk-frauddetector'
1643
- context[:gem_version] = '1.0.0'
1810
+ context[:gem_version] = '1.5.1'
1644
1811
  Seahorse::Client::Request.new(handlers, context)
1645
1812
  end
1646
1813
 
@@ -19,6 +19,7 @@ module Aws::FraudDetector
19
19
  BatchGetVariableErrorList = Shapes::ListShape.new(name: 'BatchGetVariableErrorList')
20
20
  BatchGetVariableRequest = Shapes::StructureShape.new(name: 'BatchGetVariableRequest')
21
21
  BatchGetVariableResult = Shapes::StructureShape.new(name: 'BatchGetVariableResult')
22
+ ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
22
23
  CreateDetectorVersionRequest = Shapes::StructureShape.new(name: 'CreateDetectorVersionRequest')
23
24
  CreateDetectorVersionResult = Shapes::StructureShape.new(name: 'CreateDetectorVersionResult')
24
25
  CreateModelVersionRequest = Shapes::StructureShape.new(name: 'CreateModelVersionRequest')
@@ -30,10 +31,14 @@ module Aws::FraudDetector
30
31
  CsvIndexToVariableMap = Shapes::MapShape.new(name: 'CsvIndexToVariableMap')
31
32
  DataSource = Shapes::StringShape.new(name: 'DataSource')
32
33
  DataType = Shapes::StringShape.new(name: 'DataType')
34
+ DeleteDetectorRequest = Shapes::StructureShape.new(name: 'DeleteDetectorRequest')
35
+ DeleteDetectorResult = Shapes::StructureShape.new(name: 'DeleteDetectorResult')
33
36
  DeleteDetectorVersionRequest = Shapes::StructureShape.new(name: 'DeleteDetectorVersionRequest')
34
37
  DeleteDetectorVersionResult = Shapes::StructureShape.new(name: 'DeleteDetectorVersionResult')
35
38
  DeleteEventRequest = Shapes::StructureShape.new(name: 'DeleteEventRequest')
36
39
  DeleteEventResult = Shapes::StructureShape.new(name: 'DeleteEventResult')
40
+ DeleteRuleVersionRequest = Shapes::StructureShape.new(name: 'DeleteRuleVersionRequest')
41
+ DeleteRuleVersionResult = Shapes::StructureShape.new(name: 'DeleteRuleVersionResult')
37
42
  DescribeDetectorRequest = Shapes::StructureShape.new(name: 'DescribeDetectorRequest')
38
43
  DescribeDetectorResult = Shapes::StructureShape.new(name: 'DescribeDetectorResult')
39
44
  DescribeModelVersionsRequest = Shapes::StructureShape.new(name: 'DescribeModelVersionsRequest')
@@ -76,6 +81,7 @@ module Aws::FraudDetector
76
81
  Language = Shapes::StringShape.new(name: 'Language')
77
82
  ListOfModelScores = Shapes::ListShape.new(name: 'ListOfModelScores')
78
83
  ListOfModelVersions = Shapes::ListShape.new(name: 'ListOfModelVersions')
84
+ ListOfRuleResults = Shapes::ListShape.new(name: 'ListOfRuleResults')
79
85
  ListOfStrings = Shapes::ListShape.new(name: 'ListOfStrings')
80
86
  MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
81
87
  MetricsMap = Shapes::MapShape.new(name: 'MetricsMap')
@@ -116,7 +122,9 @@ module Aws::FraudDetector
116
122
  Rule = Shapes::StructureShape.new(name: 'Rule')
117
123
  RuleDetail = Shapes::StructureShape.new(name: 'RuleDetail')
118
124
  RuleDetailList = Shapes::ListShape.new(name: 'RuleDetailList')
125
+ RuleExecutionMode = Shapes::StringShape.new(name: 'RuleExecutionMode')
119
126
  RuleList = Shapes::ListShape.new(name: 'RuleList')
127
+ RuleResult = Shapes::StructureShape.new(name: 'RuleResult')
120
128
  RulesMaxResults = Shapes::IntegerShape.new(name: 'RulesMaxResults')
121
129
  ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
122
130
  TrainingDataSource = Shapes::StructureShape.new(name: 'TrainingDataSource')
@@ -182,11 +190,15 @@ module Aws::FraudDetector
182
190
  BatchGetVariableResult.add_member(:errors, Shapes::ShapeRef.new(shape: BatchGetVariableErrorList, location_name: "errors"))
183
191
  BatchGetVariableResult.struct_class = Types::BatchGetVariableResult
184
192
 
193
+ ConflictException.add_member(:message, Shapes::ShapeRef.new(shape: string, required: true, location_name: "message"))
194
+ ConflictException.struct_class = Types::ConflictException
195
+
185
196
  CreateDetectorVersionRequest.add_member(:detector_id, Shapes::ShapeRef.new(shape: identifier, required: true, location_name: "detectorId"))
186
197
  CreateDetectorVersionRequest.add_member(:description, Shapes::ShapeRef.new(shape: description, location_name: "description"))
187
198
  CreateDetectorVersionRequest.add_member(:external_model_endpoints, Shapes::ShapeRef.new(shape: ListOfStrings, location_name: "externalModelEndpoints"))
188
199
  CreateDetectorVersionRequest.add_member(:rules, Shapes::ShapeRef.new(shape: RuleList, required: true, location_name: "rules"))
189
200
  CreateDetectorVersionRequest.add_member(:model_versions, Shapes::ShapeRef.new(shape: ListOfModelVersions, location_name: "modelVersions"))
201
+ CreateDetectorVersionRequest.add_member(:rule_execution_mode, Shapes::ShapeRef.new(shape: RuleExecutionMode, location_name: "ruleExecutionMode"))
190
202
  CreateDetectorVersionRequest.struct_class = Types::CreateDetectorVersionRequest
191
203
 
192
204
  CreateDetectorVersionResult.add_member(:detector_id, Shapes::ShapeRef.new(shape: identifier, location_name: "detectorId"))
@@ -229,6 +241,11 @@ module Aws::FraudDetector
229
241
  CsvIndexToVariableMap.key = Shapes::ShapeRef.new(shape: string)
230
242
  CsvIndexToVariableMap.value = Shapes::ShapeRef.new(shape: string)
231
243
 
244
+ DeleteDetectorRequest.add_member(:detector_id, Shapes::ShapeRef.new(shape: identifier, required: true, location_name: "detectorId"))
245
+ DeleteDetectorRequest.struct_class = Types::DeleteDetectorRequest
246
+
247
+ DeleteDetectorResult.struct_class = Types::DeleteDetectorResult
248
+
232
249
  DeleteDetectorVersionRequest.add_member(:detector_id, Shapes::ShapeRef.new(shape: identifier, required: true, location_name: "detectorId"))
233
250
  DeleteDetectorVersionRequest.add_member(:detector_version_id, Shapes::ShapeRef.new(shape: nonEmptyString, required: true, location_name: "detectorVersionId"))
234
251
  DeleteDetectorVersionRequest.struct_class = Types::DeleteDetectorVersionRequest
@@ -240,6 +257,13 @@ module Aws::FraudDetector
240
257
 
241
258
  DeleteEventResult.struct_class = Types::DeleteEventResult
242
259
 
260
+ DeleteRuleVersionRequest.add_member(:detector_id, Shapes::ShapeRef.new(shape: identifier, required: true, location_name: "detectorId"))
261
+ DeleteRuleVersionRequest.add_member(:rule_id, Shapes::ShapeRef.new(shape: identifier, required: true, location_name: "ruleId"))
262
+ DeleteRuleVersionRequest.add_member(:rule_version, Shapes::ShapeRef.new(shape: nonEmptyString, required: true, location_name: "ruleVersion"))
263
+ DeleteRuleVersionRequest.struct_class = Types::DeleteRuleVersionRequest
264
+
265
+ DeleteRuleVersionResult.struct_class = Types::DeleteRuleVersionResult
266
+
243
267
  DescribeDetectorRequest.add_member(:detector_id, Shapes::ShapeRef.new(shape: identifier, required: true, location_name: "detectorId"))
244
268
  DescribeDetectorRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: string, location_name: "nextToken"))
245
269
  DescribeDetectorRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: DetectorVersionMaxResults, location_name: "maxResults"))
@@ -308,6 +332,7 @@ module Aws::FraudDetector
308
332
  GetDetectorVersionResult.add_member(:status, Shapes::ShapeRef.new(shape: DetectorVersionStatus, location_name: "status"))
309
333
  GetDetectorVersionResult.add_member(:last_updated_time, Shapes::ShapeRef.new(shape: time, location_name: "lastUpdatedTime"))
310
334
  GetDetectorVersionResult.add_member(:created_time, Shapes::ShapeRef.new(shape: time, location_name: "createdTime"))
335
+ GetDetectorVersionResult.add_member(:rule_execution_mode, Shapes::ShapeRef.new(shape: RuleExecutionMode, location_name: "ruleExecutionMode"))
311
336
  GetDetectorVersionResult.struct_class = Types::GetDetectorVersionResult
312
337
 
313
338
  GetDetectorsRequest.add_member(:detector_id, Shapes::ShapeRef.new(shape: identifier, location_name: "detectorId"))
@@ -368,6 +393,7 @@ module Aws::FraudDetector
368
393
 
369
394
  GetPredictionResult.add_member(:outcomes, Shapes::ShapeRef.new(shape: ListOfStrings, location_name: "outcomes"))
370
395
  GetPredictionResult.add_member(:model_scores, Shapes::ShapeRef.new(shape: ListOfModelScores, location_name: "modelScores"))
396
+ GetPredictionResult.add_member(:rule_results, Shapes::ShapeRef.new(shape: ListOfRuleResults, location_name: "ruleResults"))
371
397
  GetPredictionResult.struct_class = Types::GetPredictionResult
372
398
 
373
399
  GetRulesRequest.add_member(:rule_id, Shapes::ShapeRef.new(shape: identifier, location_name: "ruleId"))
@@ -407,6 +433,8 @@ module Aws::FraudDetector
407
433
 
408
434
  ListOfModelVersions.member = Shapes::ShapeRef.new(shape: ModelVersion)
409
435
 
436
+ ListOfRuleResults.member = Shapes::ShapeRef.new(shape: RuleResult)
437
+
410
438
  ListOfStrings.member = Shapes::ShapeRef.new(shape: string)
411
439
 
412
440
  MetricsMap.key = Shapes::ShapeRef.new(shape: string)
@@ -544,6 +572,10 @@ module Aws::FraudDetector
544
572
 
545
573
  RuleList.member = Shapes::ShapeRef.new(shape: Rule)
546
574
 
575
+ RuleResult.add_member(:rule_id, Shapes::ShapeRef.new(shape: string, location_name: "ruleId"))
576
+ RuleResult.add_member(:outcomes, Shapes::ShapeRef.new(shape: ListOfStrings, location_name: "outcomes"))
577
+ RuleResult.struct_class = Types::RuleResult
578
+
547
579
  ThrottlingException.add_member(:message, Shapes::ShapeRef.new(shape: string, required: true, location_name: "message"))
548
580
  ThrottlingException.struct_class = Types::ThrottlingException
549
581
 
@@ -564,6 +596,7 @@ module Aws::FraudDetector
564
596
  UpdateDetectorVersionRequest.add_member(:rules, Shapes::ShapeRef.new(shape: RuleList, required: true, location_name: "rules"))
565
597
  UpdateDetectorVersionRequest.add_member(:description, Shapes::ShapeRef.new(shape: description, location_name: "description"))
566
598
  UpdateDetectorVersionRequest.add_member(:model_versions, Shapes::ShapeRef.new(shape: ListOfModelVersions, location_name: "modelVersions"))
599
+ UpdateDetectorVersionRequest.add_member(:rule_execution_mode, Shapes::ShapeRef.new(shape: RuleExecutionMode, location_name: "ruleExecutionMode"))
567
600
  UpdateDetectorVersionRequest.struct_class = Types::UpdateDetectorVersionRequest
568
601
 
569
602
  UpdateDetectorVersionResult.struct_class = Types::UpdateDetectorVersionResult
@@ -692,6 +725,7 @@ module Aws::FraudDetector
692
725
  o.input = Shapes::ShapeRef.new(shape: CreateModelVersionRequest)
693
726
  o.output = Shapes::ShapeRef.new(shape: CreateModelVersionResult)
694
727
  o.errors << Shapes::ShapeRef.new(shape: ValidationException)
728
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
695
729
  o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
696
730
  o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
697
731
  end)
@@ -718,6 +752,18 @@ module Aws::FraudDetector
718
752
  o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
719
753
  end)
720
754
 
755
+ api.add_operation(:delete_detector, Seahorse::Model::Operation.new.tap do |o|
756
+ o.name = "DeleteDetector"
757
+ o.http_method = "POST"
758
+ o.http_request_uri = "/"
759
+ o.input = Shapes::ShapeRef.new(shape: DeleteDetectorRequest)
760
+ o.output = Shapes::ShapeRef.new(shape: DeleteDetectorResult)
761
+ o.errors << Shapes::ShapeRef.new(shape: ConflictException)
762
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
763
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
764
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
765
+ end)
766
+
721
767
  api.add_operation(:delete_detector_version, Seahorse::Model::Operation.new.tap do |o|
722
768
  o.name = "DeleteDetectorVersion"
723
769
  o.http_method = "POST"
@@ -728,6 +774,7 @@ module Aws::FraudDetector
728
774
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
729
775
  o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
730
776
  o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
777
+ o.errors << Shapes::ShapeRef.new(shape: ConflictException)
731
778
  end)
732
779
 
733
780
  api.add_operation(:delete_event, Seahorse::Model::Operation.new.tap do |o|
@@ -740,6 +787,18 @@ module Aws::FraudDetector
740
787
  o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
741
788
  end)
742
789
 
790
+ api.add_operation(:delete_rule_version, Seahorse::Model::Operation.new.tap do |o|
791
+ o.name = "DeleteRuleVersion"
792
+ o.http_method = "POST"
793
+ o.http_request_uri = "/"
794
+ o.input = Shapes::ShapeRef.new(shape: DeleteRuleVersionRequest)
795
+ o.output = Shapes::ShapeRef.new(shape: DeleteRuleVersionResult)
796
+ o.errors << Shapes::ShapeRef.new(shape: ConflictException)
797
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
798
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
799
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
800
+ end)
801
+
743
802
  api.add_operation(:describe_detector, Seahorse::Model::Operation.new.tap do |o|
744
803
  o.name = "DescribeDetector"
745
804
  o.http_method = "POST"
@@ -6,10 +6,52 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::FraudDetector
9
+
10
+ # When FraudDetector returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::FraudDetector::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all FraudDetector errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::FraudDetector::Errors::ServiceError
18
+ # # rescues all FraudDetector API errors
19
+ # end
20
+ #
21
+ #
22
+ # ## Request Context
23
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
24
+ # information about the request that generated the error.
25
+ # See {Seahorse::Client::RequestContext} for more information.
26
+ #
27
+ # ## Error Classes
28
+ # * {ConflictException}
29
+ # * {InternalServerException}
30
+ # * {ResourceNotFoundException}
31
+ # * {ThrottlingException}
32
+ # * {ValidationException}
33
+ #
34
+ # Additionally, error classes are dynamically generated for service errors based on the error code
35
+ # if they are not defined above.
9
36
  module Errors
10
37
 
11
38
  extend Aws::Errors::DynamicErrors
12
39
 
40
+ class ConflictException < ServiceError
41
+
42
+ # @param [Seahorse::Client::RequestContext] context
43
+ # @param [String] message
44
+ # @param [Aws::FraudDetector::Types::ConflictException] data
45
+ def initialize(context, message, data = Aws::EmptyStructure.new)
46
+ super(context, message, data)
47
+ end
48
+
49
+ # @return [String]
50
+ def message
51
+ @message || @data[:message]
52
+ end
53
+ end
54
+
13
55
  class InternalServerException < ServiceError
14
56
 
15
57
  # @param [Seahorse::Client::RequestContext] context
@@ -23,7 +65,6 @@ module Aws::FraudDetector
23
65
  def message
24
66
  @message || @data[:message]
25
67
  end
26
-
27
68
  end
28
69
 
29
70
  class ResourceNotFoundException < ServiceError
@@ -39,7 +80,6 @@ module Aws::FraudDetector
39
80
  def message
40
81
  @message || @data[:message]
41
82
  end
42
-
43
83
  end
44
84
 
45
85
  class ThrottlingException < ServiceError
@@ -55,7 +95,6 @@ module Aws::FraudDetector
55
95
  def message
56
96
  @message || @data[:message]
57
97
  end
58
-
59
98
  end
60
99
 
61
100
  class ValidationException < ServiceError
@@ -71,7 +110,6 @@ module Aws::FraudDetector
71
110
  def message
72
111
  @message || @data[:message]
73
112
  end
74
-
75
113
  end
76
114
 
77
115
  end
@@ -6,6 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::FraudDetector
9
+
9
10
  class Resource
10
11
 
11
12
  # @param options ({})
@@ -126,6 +126,31 @@ module Aws::FraudDetector
126
126
  include Aws::Structure
127
127
  end
128
128
 
129
+ # An exception indicating there was a conflict during a delete
130
+ # operation. The following delete operations can cause a conflict
131
+ # exception:
132
+ #
133
+ # * DeleteDetector: A conflict exception will occur if the detector has
134
+ # associated `Rules` or `DetectorVersions`. You can only delete a
135
+ # detector if it has no `Rules` or `DetectorVersions`.
136
+ #
137
+ # * DeleteDetectorVersion: A conflict exception will occur if the
138
+ # `DetectorVersion` status is `ACTIVE`.
139
+ #
140
+ # * DeleteRuleVersion: A conflict exception will occur if the
141
+ # `RuleVersion` is in use by an associated `ACTIVE` or `INACTIVE
142
+ # DetectorVersion`.
143
+ #
144
+ # @!attribute [rw] message
145
+ # @return [String]
146
+ #
147
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ConflictException AWS API Documentation
148
+ #
149
+ class ConflictException < Struct.new(
150
+ :message)
151
+ include Aws::Structure
152
+ end
153
+
129
154
  # @note When making an API call, you may pass CreateDetectorVersionRequest
130
155
  # data as a hash:
131
156
  #
@@ -147,6 +172,7 @@ module Aws::FraudDetector
147
172
  # model_version_number: "nonEmptyString", # required
148
173
  # },
149
174
  # ],
175
+ # rule_execution_mode: "ALL_MATCHED", # accepts ALL_MATCHED, FIRST_MATCHED
150
176
  # }
151
177
  #
152
178
  # @!attribute [rw] detector_id
@@ -170,6 +196,24 @@ module Aws::FraudDetector
170
196
  # The model versions to include in the detector version.
171
197
  # @return [Array<Types::ModelVersion>]
172
198
  #
199
+ # @!attribute [rw] rule_execution_mode
200
+ # The rule execution mode for the rules included in the detector
201
+ # version.
202
+ #
203
+ # You can define and edit the rule mode at the detector version level,
204
+ # when it is in draft status.
205
+ #
206
+ # If you specify `FIRST_MATCHED`, Amazon Fraud Detector evaluates
207
+ # rules sequentially, first to last, stopping at the first matched
208
+ # rule. Amazon Fraud dectector then provides the outcomes for that
209
+ # single rule.
210
+ #
211
+ # If you specifiy `ALL_MATCHED`, Amazon Fraud Detector evaluates all
212
+ # rules and returns the outcomes for all matched rules.
213
+ #
214
+ # The default behavior is `FIRST_MATCHED`.
215
+ # @return [String]
216
+ #
173
217
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateDetectorVersionRequest AWS API Documentation
174
218
  #
175
219
  class CreateDetectorVersionRequest < Struct.new(
@@ -177,7 +221,8 @@ module Aws::FraudDetector
177
221
  :description,
178
222
  :external_model_endpoints,
179
223
  :rules,
180
- :model_versions)
224
+ :model_versions,
225
+ :rule_execution_mode)
181
226
  include Aws::Structure
182
227
  end
183
228
 
@@ -369,6 +414,28 @@ module Aws::FraudDetector
369
414
  #
370
415
  class CreateVariableResult < Aws::EmptyStructure; end
371
416
 
417
+ # @note When making an API call, you may pass DeleteDetectorRequest
418
+ # data as a hash:
419
+ #
420
+ # {
421
+ # detector_id: "identifier", # required
422
+ # }
423
+ #
424
+ # @!attribute [rw] detector_id
425
+ # The ID of the detector to delete.
426
+ # @return [String]
427
+ #
428
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteDetectorRequest AWS API Documentation
429
+ #
430
+ class DeleteDetectorRequest < Struct.new(
431
+ :detector_id)
432
+ include Aws::Structure
433
+ end
434
+
435
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteDetectorResult AWS API Documentation
436
+ #
437
+ class DeleteDetectorResult < Aws::EmptyStructure; end
438
+
372
439
  # @note When making an API call, you may pass DeleteDetectorVersionRequest
373
440
  # data as a hash:
374
441
  #
@@ -419,6 +486,40 @@ module Aws::FraudDetector
419
486
  #
420
487
  class DeleteEventResult < Aws::EmptyStructure; end
421
488
 
489
+ # @note When making an API call, you may pass DeleteRuleVersionRequest
490
+ # data as a hash:
491
+ #
492
+ # {
493
+ # detector_id: "identifier", # required
494
+ # rule_id: "identifier", # required
495
+ # rule_version: "nonEmptyString", # required
496
+ # }
497
+ #
498
+ # @!attribute [rw] detector_id
499
+ # The ID of the detector that includes the rule version to delete.
500
+ # @return [String]
501
+ #
502
+ # @!attribute [rw] rule_id
503
+ # The rule ID of the rule version to delete.
504
+ # @return [String]
505
+ #
506
+ # @!attribute [rw] rule_version
507
+ # The rule version to delete.
508
+ # @return [String]
509
+ #
510
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteRuleVersionRequest AWS API Documentation
511
+ #
512
+ class DeleteRuleVersionRequest < Struct.new(
513
+ :detector_id,
514
+ :rule_id,
515
+ :rule_version)
516
+ include Aws::Structure
517
+ end
518
+
519
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteRuleVersionResult AWS API Documentation
520
+ #
521
+ class DeleteRuleVersionResult < Aws::EmptyStructure; end
522
+
422
523
  # @note When making an API call, you may pass DescribeDetectorRequest
423
524
  # data as a hash:
424
525
  #
@@ -693,6 +794,20 @@ module Aws::FraudDetector
693
794
  # The timestamp when the detector version was created.
694
795
  # @return [String]
695
796
  #
797
+ # @!attribute [rw] rule_execution_mode
798
+ # The execution mode of the rule in the dectector
799
+ #
800
+ # `FIRST_MATCHED` indicates that Amazon Fraud Detector evaluates rules
801
+ # sequentially, first to last, stopping at the first matched rule.
802
+ # Amazon Fraud dectector then provides the outcomes for that single
803
+ # rule.
804
+ #
805
+ # `ALL_MATCHED` indicates that Amazon Fraud Detector evaluates all
806
+ # rules and returns the outcomes for all matched rules. You can define
807
+ # and edit the rule mode at the detector version level, when it is in
808
+ # draft status.
809
+ # @return [String]
810
+ #
696
811
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetDetectorVersionResult AWS API Documentation
697
812
  #
698
813
  class GetDetectorVersionResult < Struct.new(
@@ -704,7 +819,8 @@ module Aws::FraudDetector
704
819
  :rules,
705
820
  :status,
706
821
  :last_updated_time,
707
- :created_time)
822
+ :created_time,
823
+ :rule_execution_mode)
708
824
  include Aws::Structure
709
825
  end
710
826
 
@@ -1018,11 +1134,16 @@ module Aws::FraudDetector
1018
1134
  # The model scores for models used in the detector version.
1019
1135
  # @return [Array<Types::ModelScores>]
1020
1136
  #
1137
+ # @!attribute [rw] rule_results
1138
+ # The rule results in the prediction.
1139
+ # @return [Array<Types::RuleResult>]
1140
+ #
1021
1141
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetPredictionResult AWS API Documentation
1022
1142
  #
1023
1143
  class GetPredictionResult < Struct.new(
1024
1144
  :outcomes,
1025
- :model_scores)
1145
+ :model_scores,
1146
+ :rule_results)
1026
1147
  include Aws::Structure
1027
1148
  end
1028
1149
 
@@ -1827,6 +1948,24 @@ module Aws::FraudDetector
1827
1948
  include Aws::Structure
1828
1949
  end
1829
1950
 
1951
+ # The rule results.
1952
+ #
1953
+ # @!attribute [rw] rule_id
1954
+ # The rule ID that was matched, based on the rule execution mode.
1955
+ # @return [String]
1956
+ #
1957
+ # @!attribute [rw] outcomes
1958
+ # The outcomes of the matched rule, based on the rule execution mode.
1959
+ # @return [Array<String>]
1960
+ #
1961
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/RuleResult AWS API Documentation
1962
+ #
1963
+ class RuleResult < Struct.new(
1964
+ :rule_id,
1965
+ :outcomes)
1966
+ include Aws::Structure
1967
+ end
1968
+
1830
1969
  # An exception indicating a throttling error.
1831
1970
  #
1832
1971
  # @!attribute [rw] message
@@ -1921,6 +2060,7 @@ module Aws::FraudDetector
1921
2060
  # model_version_number: "nonEmptyString", # required
1922
2061
  # },
1923
2062
  # ],
2063
+ # rule_execution_mode: "ALL_MATCHED", # accepts ALL_MATCHED, FIRST_MATCHED
1924
2064
  # }
1925
2065
  #
1926
2066
  # @!attribute [rw] detector_id
@@ -1948,6 +2088,22 @@ module Aws::FraudDetector
1948
2088
  # The model versions to include in the detector version.
1949
2089
  # @return [Array<Types::ModelVersion>]
1950
2090
  #
2091
+ # @!attribute [rw] rule_execution_mode
2092
+ # The rule execution mode to add to the detector.
2093
+ #
2094
+ # If you specify `FIRST_MATCHED`, Amazon Fraud Detector evaluates
2095
+ # rules sequentially, first to last, stopping at the first matched
2096
+ # rule. Amazon Fraud dectector then provides the outcomes for that
2097
+ # single rule.
2098
+ #
2099
+ # If you specifiy `ALL_MATCHED`, Amazon Fraud Detector evaluates all
2100
+ # rules and returns the outcomes for all matched rules. You can define
2101
+ # and edit the rule mode at the detector version level, when it is in
2102
+ # draft status.
2103
+ #
2104
+ # The default behavior is `FIRST_MATCHED`.
2105
+ # @return [String]
2106
+ #
1951
2107
  # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateDetectorVersionRequest AWS API Documentation
1952
2108
  #
1953
2109
  class UpdateDetectorVersionRequest < Struct.new(
@@ -1956,7 +2112,8 @@ module Aws::FraudDetector
1956
2112
  :external_model_endpoints,
1957
2113
  :rules,
1958
2114
  :description,
1959
- :model_versions)
2115
+ :model_versions,
2116
+ :rule_execution_mode)
1960
2117
  include Aws::Structure
1961
2118
  end
1962
2119
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-frauddetector
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.5.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-12-03 00:00:00.000000000 Z
11
+ date: 2020-06-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.71.0
22
+ version: 3.99.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.71.0
32
+ version: 3.99.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
81
81
  version: '0'
82
82
  requirements: []
83
83
  rubyforge_project:
84
- rubygems_version: 2.5.2.3
84
+ rubygems_version: 2.7.6.2
85
85
  signing_key:
86
86
  specification_version: 4
87
87
  summary: AWS SDK for Ruby - Amazon Fraud Detector