aws-sdk-frauddetector 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 948080722c552a7339070b285f8cd52023ee80eb
4
+ data.tar.gz: ba5aa663d2b4eb4e8ec96990ebc55ab15b1e1f11
5
+ SHA512:
6
+ metadata.gz: 5833c045b810bd56f061bd4bc07c53777c0b1533b3f8645bdd1921f5deff86c424b085546955224e98c8d98f31d839d93b0c4c1333d09c8b84f3a9095e52329d
7
+ data.tar.gz: f406d5c136bce1926fd3a7844de54884490e72335dddac4e200acc4ebfdc94b14bca41be5ae1d1e86e8861f7599bdb2abf42417c299ed9c8997c320a4175bf03
@@ -0,0 +1,47 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'aws-sdk-core'
9
+ require 'aws-sigv4'
10
+
11
+ require_relative 'aws-sdk-frauddetector/types'
12
+ require_relative 'aws-sdk-frauddetector/client_api'
13
+ require_relative 'aws-sdk-frauddetector/client'
14
+ require_relative 'aws-sdk-frauddetector/errors'
15
+ require_relative 'aws-sdk-frauddetector/resource'
16
+ require_relative 'aws-sdk-frauddetector/customizations'
17
+
18
+ # This module provides support for Amazon Fraud Detector. This module is available in the
19
+ # `aws-sdk-frauddetector` gem.
20
+ #
21
+ # # Client
22
+ #
23
+ # The {Client} class provides one method for each API operation. Operation
24
+ # methods each accept a hash of request parameters and return a response
25
+ # structure.
26
+ #
27
+ # See {Client} for more information.
28
+ #
29
+ # # Errors
30
+ #
31
+ # Errors returned from Amazon Fraud Detector all
32
+ # extend {Errors::ServiceError}.
33
+ #
34
+ # begin
35
+ # # do stuff
36
+ # rescue Aws::FraudDetector::Errors::ServiceError
37
+ # # rescues all service API errors
38
+ # end
39
+ #
40
+ # See {Errors} for more information.
41
+ #
42
+ # @service
43
+ module Aws::FraudDetector
44
+
45
+ GEM_VERSION = '1.0.0'
46
+
47
+ end
@@ -0,0 +1,1665 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'seahorse/client/plugins/content_length.rb'
9
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
10
+ require 'aws-sdk-core/plugins/logging.rb'
11
+ require 'aws-sdk-core/plugins/param_converter.rb'
12
+ require 'aws-sdk-core/plugins/param_validator.rb'
13
+ require 'aws-sdk-core/plugins/user_agent.rb'
14
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
15
+ require 'aws-sdk-core/plugins/retry_errors.rb'
16
+ require 'aws-sdk-core/plugins/global_configuration.rb'
17
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
18
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
19
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
20
+ require 'aws-sdk-core/plugins/response_paging.rb'
21
+ require 'aws-sdk-core/plugins/stub_responses.rb'
22
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
23
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
27
+ require 'aws-sdk-core/plugins/signature_v4.rb'
28
+ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
29
+
30
+ Aws::Plugins::GlobalConfiguration.add_identifier(:frauddetector)
31
+
32
+ module Aws::FraudDetector
33
+ class Client < Seahorse::Client::Base
34
+
35
+ include Aws::ClientStubs
36
+
37
+ @identifier = :frauddetector
38
+
39
+ set_api(ClientApi::API)
40
+
41
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
42
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
43
+ add_plugin(Aws::Plugins::Logging)
44
+ add_plugin(Aws::Plugins::ParamConverter)
45
+ add_plugin(Aws::Plugins::ParamValidator)
46
+ add_plugin(Aws::Plugins::UserAgent)
47
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
48
+ add_plugin(Aws::Plugins::RetryErrors)
49
+ add_plugin(Aws::Plugins::GlobalConfiguration)
50
+ add_plugin(Aws::Plugins::RegionalEndpoint)
51
+ add_plugin(Aws::Plugins::EndpointDiscovery)
52
+ add_plugin(Aws::Plugins::EndpointPattern)
53
+ add_plugin(Aws::Plugins::ResponsePaging)
54
+ add_plugin(Aws::Plugins::StubResponses)
55
+ add_plugin(Aws::Plugins::IdempotencyToken)
56
+ add_plugin(Aws::Plugins::JsonvalueConverter)
57
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
58
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
59
+ add_plugin(Aws::Plugins::TransferEncoding)
60
+ add_plugin(Aws::Plugins::SignatureV4)
61
+ add_plugin(Aws::Plugins::Protocols::JsonRpc)
62
+
63
+ # @overload initialize(options)
64
+ # @param [Hash] options
65
+ # @option options [required, Aws::CredentialProvider] :credentials
66
+ # Your AWS credentials. This can be an instance of any one of the
67
+ # following classes:
68
+ #
69
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
70
+ # credentials.
71
+ #
72
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
73
+ # from an EC2 IMDS on an EC2 instance.
74
+ #
75
+ # * `Aws::SharedCredentials` - Used for loading credentials from a
76
+ # shared file, such as `~/.aws/config`.
77
+ #
78
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
79
+ #
80
+ # When `:credentials` are not configured directly, the following
81
+ # locations will be searched for credentials:
82
+ #
83
+ # * `Aws.config[:credentials]`
84
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
85
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
86
+ # * `~/.aws/credentials`
87
+ # * `~/.aws/config`
88
+ # * EC2 IMDS instance profile - When used by default, the timeouts are
89
+ # very aggressive. Construct and pass an instance of
90
+ # `Aws::InstanceProfileCredentails` to enable retries and extended
91
+ # timeouts.
92
+ #
93
+ # @option options [required, String] :region
94
+ # The AWS region to connect to. The configured `:region` is
95
+ # used to determine the service `:endpoint`. When not passed,
96
+ # a default `:region` is search for in the following locations:
97
+ #
98
+ # * `Aws.config[:region]`
99
+ # * `ENV['AWS_REGION']`
100
+ # * `ENV['AMAZON_REGION']`
101
+ # * `ENV['AWS_DEFAULT_REGION']`
102
+ # * `~/.aws/credentials`
103
+ # * `~/.aws/config`
104
+ #
105
+ # @option options [String] :access_key_id
106
+ #
107
+ # @option options [Boolean] :active_endpoint_cache (false)
108
+ # When set to `true`, a thread polling for endpoints will be running in
109
+ # the background every 60 secs (default). Defaults to `false`.
110
+ #
111
+ # @option options [Boolean] :client_side_monitoring (false)
112
+ # When `true`, client-side metrics will be collected for all API requests from
113
+ # this client.
114
+ #
115
+ # @option options [String] :client_side_monitoring_client_id ("")
116
+ # Allows you to provide an identifier for this client which will be attached to
117
+ # all generated client side metrics. Defaults to an empty string.
118
+ #
119
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
120
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
121
+ # side monitoring agent is running on, where client metrics will be published via UDP.
122
+ #
123
+ # @option options [Integer] :client_side_monitoring_port (31000)
124
+ # Required for publishing client metrics. The port that the client side monitoring
125
+ # agent is running on, where client metrics will be published via UDP.
126
+ #
127
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
128
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
129
+ # will use the Client Side Monitoring Agent Publisher.
130
+ #
131
+ # @option options [Boolean] :convert_params (true)
132
+ # When `true`, an attempt is made to coerce request parameters into
133
+ # the required types.
134
+ #
135
+ # @option options [Boolean] :disable_host_prefix_injection (false)
136
+ # Set to true to disable SDK automatically adding host prefix
137
+ # to default service endpoint when available.
138
+ #
139
+ # @option options [String] :endpoint
140
+ # The client endpoint is normally constructed from the `:region`
141
+ # option. You should only configure an `:endpoint` when connecting
142
+ # to test endpoints. This should be avalid HTTP(S) URI.
143
+ #
144
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
145
+ # Used for the maximum size limit of the LRU cache storing endpoints data
146
+ # for endpoint discovery enabled operations. Defaults to 1000.
147
+ #
148
+ # @option options [Integer] :endpoint_cache_max_threads (10)
149
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
150
+ #
151
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
152
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
153
+ # Use this option to config the time interval in seconds for making
154
+ # requests fetching endpoints information. Defaults to 60 sec.
155
+ #
156
+ # @option options [Boolean] :endpoint_discovery (false)
157
+ # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
158
+ #
159
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
+ # The log formatter.
161
+ #
162
+ # @option options [Symbol] :log_level (:info)
163
+ # The log level to send messages to the `:logger` at.
164
+ #
165
+ # @option options [Logger] :logger
166
+ # The Logger instance to send log messages to. If this option
167
+ # is not set, logging will be disabled.
168
+ #
169
+ # @option options [String] :profile ("default")
170
+ # Used when loading credentials from the shared credentials file
171
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
172
+ #
173
+ # @option options [Float] :retry_base_delay (0.3)
174
+ # The base delay in seconds used by the default backoff function.
175
+ #
176
+ # @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.
178
+ #
179
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
+ #
181
+ # @option options [Integer] :retry_limit (3)
182
+ # The maximum number of times to retry failed requests. Only
183
+ # ~ 500 level server errors and certain ~ 400 level client errors
184
+ # are retried. Generally, these are throttling errors, data
185
+ # checksum errors, networking errors, timeout errors and auth
186
+ # errors from expired credentials.
187
+ #
188
+ # @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.
190
+ #
191
+ # @option options [String] :secret_access_key
192
+ #
193
+ # @option options [String] :session_token
194
+ #
195
+ # @option options [Boolean] :simple_json (false)
196
+ # Disables request parameter conversion, validation, and formatting.
197
+ # Also disable response data type conversions. This option is useful
198
+ # when you want to ensure the highest level of performance by
199
+ # avoiding overhead of walking request parameters and response data
200
+ # structures.
201
+ #
202
+ # When `:simple_json` is enabled, the request parameters hash must
203
+ # be formatted exactly as the DynamoDB API expects.
204
+ #
205
+ # @option options [Boolean] :stub_responses (false)
206
+ # Causes the client to return stubbed responses. By default
207
+ # fake responses are generated and returned. You can specify
208
+ # the response data to return or errors to raise by calling
209
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
210
+ #
211
+ # ** Please note ** When response stubbing is enabled, no HTTP
212
+ # requests are made, and retries are disabled.
213
+ #
214
+ # @option options [Boolean] :validate_params (true)
215
+ # When `true`, request parameters are validated before
216
+ # sending the request.
217
+ #
218
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
219
+ # requests through. Formatted like 'http://proxy.com:123'.
220
+ #
221
+ # @option options [Float] :http_open_timeout (15) The number of
222
+ # seconds to wait when opening a HTTP session before rasing a
223
+ # `Timeout::Error`.
224
+ #
225
+ # @option options [Integer] :http_read_timeout (60) The default
226
+ # 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}.
229
+ #
230
+ # @option options [Float] :http_idle_timeout (5) The number of
231
+ # seconds a connection is allowed to sit idble before it is
232
+ # considered stale. Stale connections are closed and removed
233
+ # from the pool before making a request.
234
+ #
235
+ # @option options [Float] :http_continue_timeout (1) The number of
236
+ # seconds to wait for a 100-continue response before sending the
237
+ # request body. This option has no effect unless the request has
238
+ # "Expect" header set to "100-continue". Defaults to `nil` which
239
+ # disables this behaviour. This value can safely be set per
240
+ # request on the session yeidled by {#session_for}.
241
+ #
242
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
243
+ # HTTP debug output will be sent to the `:logger`.
244
+ #
245
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
246
+ # SSL peer certificates are verified when establishing a
247
+ # connection.
248
+ #
249
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
250
+ # certificate authority bundle file that should be used when
251
+ # verifying peer certificates. If you do not pass
252
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
253
+ # will be used if available.
254
+ #
255
+ # @option options [String] :ssl_ca_directory Full path of the
256
+ # directory that contains the unbundled SSL certificate
257
+ # authority files for verifying peer certificates. If you do
258
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
259
+ # system default will be used if available.
260
+ #
261
+ def initialize(*args)
262
+ super
263
+ end
264
+
265
+ # @!group API Operations
266
+
267
+ # Creates a batch of variables.
268
+ #
269
+ # @option params [required, Array<Types::VariableEntry>] :variable_entries
270
+ # The list of variables for the batch create variable request.
271
+ #
272
+ # @return [Types::BatchCreateVariableResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
273
+ #
274
+ # * {Types::BatchCreateVariableResult#errors #errors} => Array&lt;Types::BatchCreateVariableError&gt;
275
+ #
276
+ # @example Request syntax with placeholder values
277
+ #
278
+ # resp = client.batch_create_variable({
279
+ # variable_entries: [ # required
280
+ # {
281
+ # name: "string",
282
+ # data_type: "string",
283
+ # data_source: "string",
284
+ # default_value: "string",
285
+ # description: "string",
286
+ # variable_type: "string",
287
+ # },
288
+ # ],
289
+ # })
290
+ #
291
+ # @example Response structure
292
+ #
293
+ # resp.errors #=> Array
294
+ # resp.errors[0].name #=> String
295
+ # resp.errors[0].code #=> Integer
296
+ # resp.errors[0].message #=> String
297
+ #
298
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/BatchCreateVariable AWS API Documentation
299
+ #
300
+ # @overload batch_create_variable(params = {})
301
+ # @param [Hash] params ({})
302
+ def batch_create_variable(params = {}, options = {})
303
+ req = build_request(:batch_create_variable, params)
304
+ req.send_request(options)
305
+ end
306
+
307
+ # Gets a batch of variables.
308
+ #
309
+ # @option params [required, Array<String>] :names
310
+ # The list of variable names to get.
311
+ #
312
+ # @return [Types::BatchGetVariableResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
313
+ #
314
+ # * {Types::BatchGetVariableResult#variables #variables} => Array&lt;Types::Variable&gt;
315
+ # * {Types::BatchGetVariableResult#errors #errors} => Array&lt;Types::BatchGetVariableError&gt;
316
+ #
317
+ # @example Request syntax with placeholder values
318
+ #
319
+ # resp = client.batch_get_variable({
320
+ # names: ["string"], # required
321
+ # })
322
+ #
323
+ # @example Response structure
324
+ #
325
+ # resp.variables #=> Array
326
+ # resp.variables[0].name #=> String
327
+ # resp.variables[0].data_type #=> String, one of "STRING", "INTEGER", "FLOAT", "BOOLEAN"
328
+ # resp.variables[0].data_source #=> String, one of "EVENT", "MODEL_SCORE", "EXTERNAL_MODEL_SCORE"
329
+ # resp.variables[0].default_value #=> String
330
+ # resp.variables[0].description #=> String
331
+ # resp.variables[0].variable_type #=> String
332
+ # resp.variables[0].last_updated_time #=> String
333
+ # resp.variables[0].created_time #=> String
334
+ # resp.errors #=> Array
335
+ # resp.errors[0].name #=> String
336
+ # resp.errors[0].code #=> Integer
337
+ # resp.errors[0].message #=> String
338
+ #
339
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/BatchGetVariable AWS API Documentation
340
+ #
341
+ # @overload batch_get_variable(params = {})
342
+ # @param [Hash] params ({})
343
+ def batch_get_variable(params = {}, options = {})
344
+ req = build_request(:batch_get_variable, params)
345
+ req.send_request(options)
346
+ end
347
+
348
+ # Creates a detector version. The detector version starts in a `DRAFT`
349
+ # status.
350
+ #
351
+ # @option params [required, String] :detector_id
352
+ # The ID of the detector under which you want to create a new version.
353
+ #
354
+ # @option params [String] :description
355
+ # The description of the detector version.
356
+ #
357
+ # @option params [Array<String>] :external_model_endpoints
358
+ # The Amazon Sagemaker model endpoints to include in the detector
359
+ # version.
360
+ #
361
+ # @option params [required, Array<Types::Rule>] :rules
362
+ # The rules to include in the detector version.
363
+ #
364
+ # @option params [Array<Types::ModelVersion>] :model_versions
365
+ # The model versions to include in the detector version.
366
+ #
367
+ # @return [Types::CreateDetectorVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
368
+ #
369
+ # * {Types::CreateDetectorVersionResult#detector_id #detector_id} => String
370
+ # * {Types::CreateDetectorVersionResult#detector_version_id #detector_version_id} => String
371
+ # * {Types::CreateDetectorVersionResult#status #status} => String
372
+ #
373
+ # @example Request syntax with placeholder values
374
+ #
375
+ # resp = client.create_detector_version({
376
+ # detector_id: "identifier", # required
377
+ # description: "description",
378
+ # external_model_endpoints: ["string"],
379
+ # rules: [ # required
380
+ # {
381
+ # detector_id: "identifier", # required
382
+ # rule_id: "identifier", # required
383
+ # rule_version: "nonEmptyString", # required
384
+ # },
385
+ # ],
386
+ # model_versions: [
387
+ # {
388
+ # model_id: "identifier", # required
389
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
390
+ # model_version_number: "nonEmptyString", # required
391
+ # },
392
+ # ],
393
+ # })
394
+ #
395
+ # @example Response structure
396
+ #
397
+ # resp.detector_id #=> String
398
+ # resp.detector_version_id #=> String
399
+ # resp.status #=> String, one of "DRAFT", "ACTIVE", "INACTIVE"
400
+ #
401
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateDetectorVersion AWS API Documentation
402
+ #
403
+ # @overload create_detector_version(params = {})
404
+ # @param [Hash] params ({})
405
+ def create_detector_version(params = {}, options = {})
406
+ req = build_request(:create_detector_version, params)
407
+ req.send_request(options)
408
+ end
409
+
410
+ # Creates a version of the model using the specified model type.
411
+ #
412
+ # @option params [required, String] :model_id
413
+ # The model ID.
414
+ #
415
+ # @option params [required, String] :model_type
416
+ # The model type.
417
+ #
418
+ # @option params [String] :description
419
+ # The model version description.
420
+ #
421
+ # @return [Types::CreateModelVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
422
+ #
423
+ # * {Types::CreateModelVersionResult#model_id #model_id} => String
424
+ # * {Types::CreateModelVersionResult#model_type #model_type} => String
425
+ # * {Types::CreateModelVersionResult#model_version_number #model_version_number} => String
426
+ # * {Types::CreateModelVersionResult#status #status} => String
427
+ #
428
+ # @example Request syntax with placeholder values
429
+ #
430
+ # resp = client.create_model_version({
431
+ # model_id: "identifier", # required
432
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
433
+ # description: "description",
434
+ # })
435
+ #
436
+ # @example Response structure
437
+ #
438
+ # resp.model_id #=> String
439
+ # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
440
+ # resp.model_version_number #=> String
441
+ # resp.status #=> String
442
+ #
443
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateModelVersion AWS API Documentation
444
+ #
445
+ # @overload create_model_version(params = {})
446
+ # @param [Hash] params ({})
447
+ def create_model_version(params = {}, options = {})
448
+ req = build_request(:create_model_version, params)
449
+ req.send_request(options)
450
+ end
451
+
452
+ # Creates a rule for use with the specified detector.
453
+ #
454
+ # @option params [required, String] :rule_id
455
+ # The rule ID.
456
+ #
457
+ # @option params [required, String] :detector_id
458
+ # The detector ID for the rule's parent detector.
459
+ #
460
+ # @option params [String] :description
461
+ # The rule description.
462
+ #
463
+ # @option params [required, String] :expression
464
+ # The rule expression.
465
+ #
466
+ # @option params [required, String] :language
467
+ # The language of the rule.
468
+ #
469
+ # @option params [required, Array<String>] :outcomes
470
+ # The outcome or outcomes returned when the rule expression matches.
471
+ #
472
+ # @return [Types::CreateRuleResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
473
+ #
474
+ # * {Types::CreateRuleResult#rule #rule} => Types::Rule
475
+ #
476
+ # @example Request syntax with placeholder values
477
+ #
478
+ # resp = client.create_rule({
479
+ # rule_id: "identifier", # required
480
+ # detector_id: "identifier", # required
481
+ # description: "description",
482
+ # expression: "ruleExpression", # required
483
+ # language: "DETECTORPL", # required, accepts DETECTORPL
484
+ # outcomes: ["string"], # required
485
+ # })
486
+ #
487
+ # @example Response structure
488
+ #
489
+ # resp.rule.detector_id #=> String
490
+ # resp.rule.rule_id #=> String
491
+ # resp.rule.rule_version #=> String
492
+ #
493
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateRule AWS API Documentation
494
+ #
495
+ # @overload create_rule(params = {})
496
+ # @param [Hash] params ({})
497
+ def create_rule(params = {}, options = {})
498
+ req = build_request(:create_rule, params)
499
+ req.send_request(options)
500
+ end
501
+
502
+ # Creates a variable.
503
+ #
504
+ # @option params [required, String] :name
505
+ # The name of the variable.
506
+ #
507
+ # @option params [required, String] :data_type
508
+ # The data type.
509
+ #
510
+ # @option params [required, String] :data_source
511
+ # The source of the data.
512
+ #
513
+ # @option params [required, String] :default_value
514
+ # The default value for the variable when no value is received.
515
+ #
516
+ # @option params [String] :description
517
+ # The description.
518
+ #
519
+ # @option params [String] :variable_type
520
+ # The variable type.
521
+ #
522
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
523
+ #
524
+ # @example Request syntax with placeholder values
525
+ #
526
+ # resp = client.create_variable({
527
+ # name: "string", # required
528
+ # data_type: "STRING", # required, accepts STRING, INTEGER, FLOAT, BOOLEAN
529
+ # data_source: "EVENT", # required, accepts EVENT, MODEL_SCORE, EXTERNAL_MODEL_SCORE
530
+ # default_value: "string", # required
531
+ # description: "string",
532
+ # variable_type: "string",
533
+ # })
534
+ #
535
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateVariable AWS API Documentation
536
+ #
537
+ # @overload create_variable(params = {})
538
+ # @param [Hash] params ({})
539
+ def create_variable(params = {}, options = {})
540
+ req = build_request(:create_variable, params)
541
+ req.send_request(options)
542
+ end
543
+
544
+ # Deletes the detector version.
545
+ #
546
+ # @option params [required, String] :detector_id
547
+ # The ID of the parent detector for the detector version to delete.
548
+ #
549
+ # @option params [required, String] :detector_version_id
550
+ # The ID of the detector version to delete.
551
+ #
552
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
553
+ #
554
+ # @example Request syntax with placeholder values
555
+ #
556
+ # resp = client.delete_detector_version({
557
+ # detector_id: "identifier", # required
558
+ # detector_version_id: "nonEmptyString", # required
559
+ # })
560
+ #
561
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteDetectorVersion AWS API Documentation
562
+ #
563
+ # @overload delete_detector_version(params = {})
564
+ # @param [Hash] params ({})
565
+ def delete_detector_version(params = {}, options = {})
566
+ req = build_request(:delete_detector_version, params)
567
+ req.send_request(options)
568
+ end
569
+
570
+ # Deletes the specified event.
571
+ #
572
+ # @option params [required, String] :event_id
573
+ # The ID of the event to delete.
574
+ #
575
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
576
+ #
577
+ # @example Request syntax with placeholder values
578
+ #
579
+ # resp = client.delete_event({
580
+ # event_id: "string", # required
581
+ # })
582
+ #
583
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteEvent AWS API Documentation
584
+ #
585
+ # @overload delete_event(params = {})
586
+ # @param [Hash] params ({})
587
+ def delete_event(params = {}, options = {})
588
+ req = build_request(:delete_event, params)
589
+ req.send_request(options)
590
+ end
591
+
592
+ # Gets all versions for a specified detector.
593
+ #
594
+ # @option params [required, String] :detector_id
595
+ # The detector ID.
596
+ #
597
+ # @option params [String] :next_token
598
+ # The next token from the previous response.
599
+ #
600
+ # @option params [Integer] :max_results
601
+ # The maximum number of results to return for the request.
602
+ #
603
+ # @return [Types::DescribeDetectorResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
604
+ #
605
+ # * {Types::DescribeDetectorResult#detector_id #detector_id} => String
606
+ # * {Types::DescribeDetectorResult#detector_version_summaries #detector_version_summaries} => Array&lt;Types::DetectorVersionSummary&gt;
607
+ # * {Types::DescribeDetectorResult#next_token #next_token} => String
608
+ #
609
+ # @example Request syntax with placeholder values
610
+ #
611
+ # resp = client.describe_detector({
612
+ # detector_id: "identifier", # required
613
+ # next_token: "string",
614
+ # max_results: 1,
615
+ # })
616
+ #
617
+ # @example Response structure
618
+ #
619
+ # resp.detector_id #=> String
620
+ # resp.detector_version_summaries #=> Array
621
+ # resp.detector_version_summaries[0].detector_version_id #=> String
622
+ # resp.detector_version_summaries[0].status #=> String, one of "DRAFT", "ACTIVE", "INACTIVE"
623
+ # resp.detector_version_summaries[0].description #=> String
624
+ # resp.detector_version_summaries[0].last_updated_time #=> String
625
+ # resp.next_token #=> String
626
+ #
627
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DescribeDetector AWS API Documentation
628
+ #
629
+ # @overload describe_detector(params = {})
630
+ # @param [Hash] params ({})
631
+ def describe_detector(params = {}, options = {})
632
+ req = build_request(:describe_detector, params)
633
+ req.send_request(options)
634
+ end
635
+
636
+ # Gets all of the model versions for the specified model type or for the
637
+ # specified model type and model ID. You can also get details for a
638
+ # single, specified model version.
639
+ #
640
+ # @option params [String] :model_id
641
+ # The model ID.
642
+ #
643
+ # @option params [String] :model_version_number
644
+ # The model version.
645
+ #
646
+ # @option params [String] :model_type
647
+ # The model type.
648
+ #
649
+ # @option params [String] :next_token
650
+ # The next token from the previous results.
651
+ #
652
+ # @option params [Integer] :max_results
653
+ # The maximum number of results to return.
654
+ #
655
+ # @return [Types::DescribeModelVersionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
656
+ #
657
+ # * {Types::DescribeModelVersionsResult#model_version_details #model_version_details} => Array&lt;Types::ModelVersionDetail&gt;
658
+ # * {Types::DescribeModelVersionsResult#next_token #next_token} => String
659
+ #
660
+ # @example Request syntax with placeholder values
661
+ #
662
+ # resp = client.describe_model_versions({
663
+ # model_id: "identifier",
664
+ # model_version_number: "nonEmptyString",
665
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
666
+ # next_token: "string",
667
+ # max_results: 1,
668
+ # })
669
+ #
670
+ # @example Response structure
671
+ #
672
+ # resp.model_version_details #=> Array
673
+ # resp.model_version_details[0].model_id #=> String
674
+ # resp.model_version_details[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
675
+ # resp.model_version_details[0].model_version_number #=> String
676
+ # resp.model_version_details[0].description #=> String
677
+ # resp.model_version_details[0].status #=> String
678
+ # resp.model_version_details[0].training_data_source.data_location #=> String
679
+ # resp.model_version_details[0].training_data_source.data_access_role_arn #=> String
680
+ # resp.model_version_details[0].model_variables #=> Array
681
+ # resp.model_version_details[0].model_variables[0].name #=> String
682
+ # resp.model_version_details[0].model_variables[0].index #=> Integer
683
+ # resp.model_version_details[0].label_schema.label_key #=> String
684
+ # resp.model_version_details[0].label_schema.label_mapper #=> Hash
685
+ # resp.model_version_details[0].label_schema.label_mapper["string"] #=> Array
686
+ # resp.model_version_details[0].label_schema.label_mapper["string"][0] #=> String
687
+ # resp.model_version_details[0].validation_metrics #=> Hash
688
+ # resp.model_version_details[0].validation_metrics["string"] #=> String
689
+ # resp.model_version_details[0].training_metrics #=> Hash
690
+ # resp.model_version_details[0].training_metrics["string"] #=> String
691
+ # resp.model_version_details[0].last_updated_time #=> String
692
+ # resp.model_version_details[0].created_time #=> String
693
+ # resp.next_token #=> String
694
+ #
695
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DescribeModelVersions AWS API Documentation
696
+ #
697
+ # @overload describe_model_versions(params = {})
698
+ # @param [Hash] params ({})
699
+ def describe_model_versions(params = {}, options = {})
700
+ req = build_request(:describe_model_versions, params)
701
+ req.send_request(options)
702
+ end
703
+
704
+ # Gets a particular detector version.
705
+ #
706
+ # @option params [required, String] :detector_id
707
+ # The detector ID.
708
+ #
709
+ # @option params [required, String] :detector_version_id
710
+ # The detector version ID.
711
+ #
712
+ # @return [Types::GetDetectorVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
713
+ #
714
+ # * {Types::GetDetectorVersionResult#detector_id #detector_id} => String
715
+ # * {Types::GetDetectorVersionResult#detector_version_id #detector_version_id} => String
716
+ # * {Types::GetDetectorVersionResult#description #description} => String
717
+ # * {Types::GetDetectorVersionResult#external_model_endpoints #external_model_endpoints} => Array&lt;String&gt;
718
+ # * {Types::GetDetectorVersionResult#model_versions #model_versions} => Array&lt;Types::ModelVersion&gt;
719
+ # * {Types::GetDetectorVersionResult#rules #rules} => Array&lt;Types::Rule&gt;
720
+ # * {Types::GetDetectorVersionResult#status #status} => String
721
+ # * {Types::GetDetectorVersionResult#last_updated_time #last_updated_time} => String
722
+ # * {Types::GetDetectorVersionResult#created_time #created_time} => String
723
+ #
724
+ # @example Request syntax with placeholder values
725
+ #
726
+ # resp = client.get_detector_version({
727
+ # detector_id: "identifier", # required
728
+ # detector_version_id: "nonEmptyString", # required
729
+ # })
730
+ #
731
+ # @example Response structure
732
+ #
733
+ # resp.detector_id #=> String
734
+ # resp.detector_version_id #=> String
735
+ # resp.description #=> String
736
+ # resp.external_model_endpoints #=> Array
737
+ # resp.external_model_endpoints[0] #=> String
738
+ # resp.model_versions #=> Array
739
+ # resp.model_versions[0].model_id #=> String
740
+ # resp.model_versions[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
741
+ # resp.model_versions[0].model_version_number #=> String
742
+ # resp.rules #=> Array
743
+ # resp.rules[0].detector_id #=> String
744
+ # resp.rules[0].rule_id #=> String
745
+ # resp.rules[0].rule_version #=> String
746
+ # resp.status #=> String, one of "DRAFT", "ACTIVE", "INACTIVE"
747
+ # resp.last_updated_time #=> String
748
+ # resp.created_time #=> String
749
+ #
750
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetDetectorVersion AWS API Documentation
751
+ #
752
+ # @overload get_detector_version(params = {})
753
+ # @param [Hash] params ({})
754
+ def get_detector_version(params = {}, options = {})
755
+ req = build_request(:get_detector_version, params)
756
+ req.send_request(options)
757
+ end
758
+
759
+ # Gets all of detectors. This is a paginated API. If you provide a null
760
+ # `maxSizePerPage`, this actions retrieves a maximum of 10 records per
761
+ # page. If you provide a `maxSizePerPage`, the value must be between 5
762
+ # and 10. To get the next page results, provide the pagination token
763
+ # from the `GetEventTypesResponse` as part of your request. A null
764
+ # pagination token fetches the records from the beginning.
765
+ #
766
+ # @option params [String] :detector_id
767
+ # The detector ID.
768
+ #
769
+ # @option params [String] :next_token
770
+ # The next token for the subsequent request.
771
+ #
772
+ # @option params [Integer] :max_results
773
+ # The maximum number of objects to return for the request.
774
+ #
775
+ # @return [Types::GetDetectorsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
776
+ #
777
+ # * {Types::GetDetectorsResult#detectors #detectors} => Array&lt;Types::Detector&gt;
778
+ # * {Types::GetDetectorsResult#next_token #next_token} => String
779
+ #
780
+ # @example Request syntax with placeholder values
781
+ #
782
+ # resp = client.get_detectors({
783
+ # detector_id: "identifier",
784
+ # next_token: "string",
785
+ # max_results: 1,
786
+ # })
787
+ #
788
+ # @example Response structure
789
+ #
790
+ # resp.detectors #=> Array
791
+ # resp.detectors[0].detector_id #=> String
792
+ # resp.detectors[0].description #=> String
793
+ # resp.detectors[0].last_updated_time #=> String
794
+ # resp.detectors[0].created_time #=> String
795
+ # resp.next_token #=> String
796
+ #
797
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetDetectors AWS API Documentation
798
+ #
799
+ # @overload get_detectors(params = {})
800
+ # @param [Hash] params ({})
801
+ def get_detectors(params = {}, options = {})
802
+ req = build_request(:get_detectors, params)
803
+ req.send_request(options)
804
+ end
805
+
806
+ # Gets the details for one or more Amazon SageMaker models that have
807
+ # been imported into the service. This is a paginated API. If you
808
+ # provide a null `maxSizePerPage`, this actions retrieves a maximum of
809
+ # 10 records per page. If you provide a `maxSizePerPage`, the value must
810
+ # be between 5 and 10. To get the next page results, provide the
811
+ # pagination token from the `GetExternalModelsResult` as part of your
812
+ # request. A null pagination token fetches the records from the
813
+ # beginning.
814
+ #
815
+ # @option params [String] :model_endpoint
816
+ # The Amazon SageMaker model endpoint.
817
+ #
818
+ # @option params [String] :next_token
819
+ # The next page token for the request.
820
+ #
821
+ # @option params [Integer] :max_results
822
+ # The maximum number of objects to return for the request.
823
+ #
824
+ # @return [Types::GetExternalModelsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
825
+ #
826
+ # * {Types::GetExternalModelsResult#external_models #external_models} => Array&lt;Types::ExternalModel&gt;
827
+ # * {Types::GetExternalModelsResult#next_token #next_token} => String
828
+ #
829
+ # @example Request syntax with placeholder values
830
+ #
831
+ # resp = client.get_external_models({
832
+ # model_endpoint: "string",
833
+ # next_token: "string",
834
+ # max_results: 1,
835
+ # })
836
+ #
837
+ # @example Response structure
838
+ #
839
+ # resp.external_models #=> Array
840
+ # resp.external_models[0].model_endpoint #=> String
841
+ # resp.external_models[0].model_source #=> String, one of "SAGEMAKER"
842
+ # resp.external_models[0].role.arn #=> String
843
+ # resp.external_models[0].role.name #=> String
844
+ # resp.external_models[0].input_configuration.format #=> String, one of "TEXT_CSV", "APPLICATION_JSON"
845
+ # resp.external_models[0].input_configuration.is_opaque #=> Boolean
846
+ # resp.external_models[0].input_configuration.json_input_template #=> String
847
+ # resp.external_models[0].input_configuration.csv_input_template #=> String
848
+ # resp.external_models[0].output_configuration.format #=> String, one of "TEXT_CSV", "APPLICATION_JSONLINES"
849
+ # resp.external_models[0].output_configuration.json_key_to_variable_map #=> Hash
850
+ # resp.external_models[0].output_configuration.json_key_to_variable_map["string"] #=> String
851
+ # resp.external_models[0].output_configuration.csv_index_to_variable_map #=> Hash
852
+ # resp.external_models[0].output_configuration.csv_index_to_variable_map["string"] #=> String
853
+ # resp.external_models[0].model_endpoint_status #=> String, one of "ASSOCIATED", "DISSOCIATED"
854
+ # resp.external_models[0].last_updated_time #=> String
855
+ # resp.external_models[0].created_time #=> String
856
+ # resp.next_token #=> String
857
+ #
858
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetExternalModels AWS API Documentation
859
+ #
860
+ # @overload get_external_models(params = {})
861
+ # @param [Hash] params ({})
862
+ def get_external_models(params = {}, options = {})
863
+ req = build_request(:get_external_models, params)
864
+ req.send_request(options)
865
+ end
866
+
867
+ # Gets a model version.
868
+ #
869
+ # @option params [required, String] :model_id
870
+ # The model ID.
871
+ #
872
+ # @option params [required, String] :model_type
873
+ # The model type.
874
+ #
875
+ # @option params [required, String] :model_version_number
876
+ # The model version.
877
+ #
878
+ # @return [Types::GetModelVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
879
+ #
880
+ # * {Types::GetModelVersionResult#model_id #model_id} => String
881
+ # * {Types::GetModelVersionResult#model_type #model_type} => String
882
+ # * {Types::GetModelVersionResult#model_version_number #model_version_number} => String
883
+ # * {Types::GetModelVersionResult#description #description} => String
884
+ # * {Types::GetModelVersionResult#status #status} => String
885
+ #
886
+ # @example Request syntax with placeholder values
887
+ #
888
+ # resp = client.get_model_version({
889
+ # model_id: "identifier", # required
890
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
891
+ # model_version_number: "nonEmptyString", # required
892
+ # })
893
+ #
894
+ # @example Response structure
895
+ #
896
+ # resp.model_id #=> String
897
+ # resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
898
+ # resp.model_version_number #=> String
899
+ # resp.description #=> String
900
+ # resp.status #=> String
901
+ #
902
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModelVersion AWS API Documentation
903
+ #
904
+ # @overload get_model_version(params = {})
905
+ # @param [Hash] params ({})
906
+ def get_model_version(params = {}, options = {})
907
+ req = build_request(:get_model_version, params)
908
+ req.send_request(options)
909
+ end
910
+
911
+ # Gets all of the models for the AWS account, or the specified model
912
+ # type, or gets a single model for the specified model type, model ID
913
+ # combination.
914
+ #
915
+ # @option params [String] :model_type
916
+ # The model type.
917
+ #
918
+ # @option params [String] :model_id
919
+ # The model ID.
920
+ #
921
+ # @option params [String] :next_token
922
+ # The next token for the request.
923
+ #
924
+ # @option params [Integer] :max_results
925
+ # The maximum results to return for the request.
926
+ #
927
+ # @return [Types::GetModelsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
928
+ #
929
+ # * {Types::GetModelsResult#next_token #next_token} => String
930
+ # * {Types::GetModelsResult#models #models} => Array&lt;Types::Model&gt;
931
+ #
932
+ # @example Request syntax with placeholder values
933
+ #
934
+ # resp = client.get_models({
935
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
936
+ # model_id: "identifier",
937
+ # next_token: "string",
938
+ # max_results: 1,
939
+ # })
940
+ #
941
+ # @example Response structure
942
+ #
943
+ # resp.next_token #=> String
944
+ # resp.models #=> Array
945
+ # resp.models[0].model_id #=> String
946
+ # resp.models[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
947
+ # resp.models[0].description #=> String
948
+ # resp.models[0].training_data_source.data_location #=> String
949
+ # resp.models[0].training_data_source.data_access_role_arn #=> String
950
+ # resp.models[0].model_variables #=> Array
951
+ # resp.models[0].model_variables[0].name #=> String
952
+ # resp.models[0].model_variables[0].index #=> Integer
953
+ # resp.models[0].label_schema.label_key #=> String
954
+ # resp.models[0].label_schema.label_mapper #=> Hash
955
+ # resp.models[0].label_schema.label_mapper["string"] #=> Array
956
+ # resp.models[0].label_schema.label_mapper["string"][0] #=> String
957
+ # resp.models[0].last_updated_time #=> String
958
+ # resp.models[0].created_time #=> String
959
+ #
960
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModels AWS API Documentation
961
+ #
962
+ # @overload get_models(params = {})
963
+ # @param [Hash] params ({})
964
+ def get_models(params = {}, options = {})
965
+ req = build_request(:get_models, params)
966
+ req.send_request(options)
967
+ end
968
+
969
+ # Gets one or more outcomes. This is a paginated API. If you provide a
970
+ # null `maxSizePerPage`, this actions retrieves a maximum of 10 records
971
+ # per page. If you provide a `maxSizePerPage`, the value must be between
972
+ # 50 and 100. To get the next page results, provide the pagination token
973
+ # from the `GetOutcomesResult` as part of your request. A null
974
+ # pagination token fetches the records from the beginning.
975
+ #
976
+ # @option params [String] :name
977
+ # The name of the outcome or outcomes to get.
978
+ #
979
+ # @option params [String] :next_token
980
+ # The next page token for the request.
981
+ #
982
+ # @option params [Integer] :max_results
983
+ # The maximum number of objects to return for the request.
984
+ #
985
+ # @return [Types::GetOutcomesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
986
+ #
987
+ # * {Types::GetOutcomesResult#outcomes #outcomes} => Array&lt;Types::Outcome&gt;
988
+ # * {Types::GetOutcomesResult#next_token #next_token} => String
989
+ #
990
+ # @example Request syntax with placeholder values
991
+ #
992
+ # resp = client.get_outcomes({
993
+ # name: "identifier",
994
+ # next_token: "string",
995
+ # max_results: 1,
996
+ # })
997
+ #
998
+ # @example Response structure
999
+ #
1000
+ # resp.outcomes #=> Array
1001
+ # resp.outcomes[0].name #=> String
1002
+ # resp.outcomes[0].description #=> String
1003
+ # resp.outcomes[0].last_updated_time #=> String
1004
+ # resp.outcomes[0].created_time #=> String
1005
+ # resp.next_token #=> String
1006
+ #
1007
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetOutcomes AWS API Documentation
1008
+ #
1009
+ # @overload get_outcomes(params = {})
1010
+ # @param [Hash] params ({})
1011
+ def get_outcomes(params = {}, options = {})
1012
+ req = build_request(:get_outcomes, params)
1013
+ req.send_request(options)
1014
+ end
1015
+
1016
+ # Evaluates an event against a detector version. If a version ID is not
1017
+ # provided, the detector’s (`ACTIVE`) version is used.
1018
+ #
1019
+ # @option params [required, String] :detector_id
1020
+ # The detector ID.
1021
+ #
1022
+ # @option params [String] :detector_version_id
1023
+ # The detector version ID.
1024
+ #
1025
+ # @option params [required, String] :event_id
1026
+ # The unique ID used to identify the event.
1027
+ #
1028
+ # @option params [Hash<String,String>] :event_attributes
1029
+ # Names of variables you defined in Amazon Fraud Detector to represent
1030
+ # event data elements and their corresponding values for the event you
1031
+ # are sending for evaluation.
1032
+ #
1033
+ # @option params [Hash<String,Types::ModelEndpointDataBlob>] :external_model_endpoint_data_blobs
1034
+ # The Amazon SageMaker model endpoint input data blobs.
1035
+ #
1036
+ # @return [Types::GetPredictionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1037
+ #
1038
+ # * {Types::GetPredictionResult#outcomes #outcomes} => Array&lt;String&gt;
1039
+ # * {Types::GetPredictionResult#model_scores #model_scores} => Array&lt;Types::ModelScores&gt;
1040
+ #
1041
+ # @example Request syntax with placeholder values
1042
+ #
1043
+ # resp = client.get_prediction({
1044
+ # detector_id: "string", # required
1045
+ # detector_version_id: "string",
1046
+ # event_id: "string", # required
1047
+ # event_attributes: {
1048
+ # "attributeKey" => "attributeValue",
1049
+ # },
1050
+ # external_model_endpoint_data_blobs: {
1051
+ # "string" => {
1052
+ # byte_buffer: "data",
1053
+ # content_type: "contentType",
1054
+ # },
1055
+ # },
1056
+ # })
1057
+ #
1058
+ # @example Response structure
1059
+ #
1060
+ # resp.outcomes #=> Array
1061
+ # resp.outcomes[0] #=> String
1062
+ # resp.model_scores #=> Array
1063
+ # resp.model_scores[0].model_version.model_id #=> String
1064
+ # resp.model_scores[0].model_version.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
1065
+ # resp.model_scores[0].model_version.model_version_number #=> String
1066
+ # resp.model_scores[0].scores #=> Hash
1067
+ # resp.model_scores[0].scores["string"] #=> Float
1068
+ #
1069
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetPrediction AWS API Documentation
1070
+ #
1071
+ # @overload get_prediction(params = {})
1072
+ # @param [Hash] params ({})
1073
+ def get_prediction(params = {}, options = {})
1074
+ req = build_request(:get_prediction, params)
1075
+ req.send_request(options)
1076
+ end
1077
+
1078
+ # Gets all rules available for the specified detector.
1079
+ #
1080
+ # @option params [String] :rule_id
1081
+ # The rule ID.
1082
+ #
1083
+ # @option params [required, String] :detector_id
1084
+ # The detector ID.
1085
+ #
1086
+ # @option params [String] :rule_version
1087
+ # The rule version.
1088
+ #
1089
+ # @option params [String] :next_token
1090
+ # The next page token.
1091
+ #
1092
+ # @option params [Integer] :max_results
1093
+ # The maximum number of rules to return for the request.
1094
+ #
1095
+ # @return [Types::GetRulesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1096
+ #
1097
+ # * {Types::GetRulesResult#rule_details #rule_details} => Array&lt;Types::RuleDetail&gt;
1098
+ # * {Types::GetRulesResult#next_token #next_token} => String
1099
+ #
1100
+ # @example Request syntax with placeholder values
1101
+ #
1102
+ # resp = client.get_rules({
1103
+ # rule_id: "identifier",
1104
+ # detector_id: "identifier", # required
1105
+ # rule_version: "nonEmptyString",
1106
+ # next_token: "string",
1107
+ # max_results: 1,
1108
+ # })
1109
+ #
1110
+ # @example Response structure
1111
+ #
1112
+ # resp.rule_details #=> Array
1113
+ # resp.rule_details[0].rule_id #=> String
1114
+ # resp.rule_details[0].description #=> String
1115
+ # resp.rule_details[0].detector_id #=> String
1116
+ # resp.rule_details[0].rule_version #=> String
1117
+ # resp.rule_details[0].expression #=> String
1118
+ # resp.rule_details[0].language #=> String, one of "DETECTORPL"
1119
+ # resp.rule_details[0].outcomes #=> Array
1120
+ # resp.rule_details[0].outcomes[0] #=> String
1121
+ # resp.rule_details[0].last_updated_time #=> String
1122
+ # resp.rule_details[0].created_time #=> String
1123
+ # resp.next_token #=> String
1124
+ #
1125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetRules AWS API Documentation
1126
+ #
1127
+ # @overload get_rules(params = {})
1128
+ # @param [Hash] params ({})
1129
+ def get_rules(params = {}, options = {})
1130
+ req = build_request(:get_rules, params)
1131
+ req.send_request(options)
1132
+ end
1133
+
1134
+ # Gets all of the variables or the specific variable. This is a
1135
+ # paginated API. Providing null `maxSizePerPage` results in retrieving
1136
+ # maximum of 100 records per page. If you provide `maxSizePerPage` the
1137
+ # value must be between 50 and 100. To get the next page result, a
1138
+ # provide a pagination token from `GetVariablesResult` as part of your
1139
+ # request. Null pagination token fetches the records from the beginning.
1140
+ #
1141
+ # @option params [String] :name
1142
+ # The name of the variable.
1143
+ #
1144
+ # @option params [String] :next_token
1145
+ # The next page token of the get variable request.
1146
+ #
1147
+ # @option params [Integer] :max_results
1148
+ # The max size per page determined for the get variable request.
1149
+ #
1150
+ # @return [Types::GetVariablesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1151
+ #
1152
+ # * {Types::GetVariablesResult#variables #variables} => Array&lt;Types::Variable&gt;
1153
+ # * {Types::GetVariablesResult#next_token #next_token} => String
1154
+ #
1155
+ # @example Request syntax with placeholder values
1156
+ #
1157
+ # resp = client.get_variables({
1158
+ # name: "string",
1159
+ # next_token: "string",
1160
+ # max_results: 1,
1161
+ # })
1162
+ #
1163
+ # @example Response structure
1164
+ #
1165
+ # resp.variables #=> Array
1166
+ # resp.variables[0].name #=> String
1167
+ # resp.variables[0].data_type #=> String, one of "STRING", "INTEGER", "FLOAT", "BOOLEAN"
1168
+ # resp.variables[0].data_source #=> String, one of "EVENT", "MODEL_SCORE", "EXTERNAL_MODEL_SCORE"
1169
+ # resp.variables[0].default_value #=> String
1170
+ # resp.variables[0].description #=> String
1171
+ # resp.variables[0].variable_type #=> String
1172
+ # resp.variables[0].last_updated_time #=> String
1173
+ # resp.variables[0].created_time #=> String
1174
+ # resp.next_token #=> String
1175
+ #
1176
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetVariables AWS API Documentation
1177
+ #
1178
+ # @overload get_variables(params = {})
1179
+ # @param [Hash] params ({})
1180
+ def get_variables(params = {}, options = {})
1181
+ req = build_request(:get_variables, params)
1182
+ req.send_request(options)
1183
+ end
1184
+
1185
+ # Creates or updates a detector.
1186
+ #
1187
+ # @option params [required, String] :detector_id
1188
+ # The detector ID.
1189
+ #
1190
+ # @option params [String] :description
1191
+ # The description of the detector.
1192
+ #
1193
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1194
+ #
1195
+ # @example Request syntax with placeholder values
1196
+ #
1197
+ # resp = client.put_detector({
1198
+ # detector_id: "identifier", # required
1199
+ # description: "description",
1200
+ # })
1201
+ #
1202
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutDetector AWS API Documentation
1203
+ #
1204
+ # @overload put_detector(params = {})
1205
+ # @param [Hash] params ({})
1206
+ def put_detector(params = {}, options = {})
1207
+ req = build_request(:put_detector, params)
1208
+ req.send_request(options)
1209
+ end
1210
+
1211
+ # Creates or updates an Amazon SageMaker model endpoint. You can also
1212
+ # use this action to update the configuration of the model endpoint,
1213
+ # including the IAM role and/or the mapped variables.
1214
+ #
1215
+ # @option params [required, String] :model_endpoint
1216
+ # The model endpoints name.
1217
+ #
1218
+ # @option params [required, String] :model_source
1219
+ # The source of the model.
1220
+ #
1221
+ # @option params [required, Types::Role] :role
1222
+ # The IAM role used to invoke the model endpoint.
1223
+ #
1224
+ # @option params [required, Types::ModelInputConfiguration] :input_configuration
1225
+ # The model endpoint input configuration.
1226
+ #
1227
+ # @option params [required, Types::ModelOutputConfiguration] :output_configuration
1228
+ # The model endpoint output configuration.
1229
+ #
1230
+ # @option params [required, String] :model_endpoint_status
1231
+ # The model endpoint’s status in Amazon Fraud Detector.
1232
+ #
1233
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1234
+ #
1235
+ # @example Request syntax with placeholder values
1236
+ #
1237
+ # resp = client.put_external_model({
1238
+ # model_endpoint: "string", # required
1239
+ # model_source: "SAGEMAKER", # required, accepts SAGEMAKER
1240
+ # role: { # required
1241
+ # arn: "string", # required
1242
+ # name: "string", # required
1243
+ # },
1244
+ # input_configuration: { # required
1245
+ # format: "TEXT_CSV", # accepts TEXT_CSV, APPLICATION_JSON
1246
+ # is_opaque: false, # required
1247
+ # json_input_template: "string",
1248
+ # csv_input_template: "string",
1249
+ # },
1250
+ # output_configuration: { # required
1251
+ # format: "TEXT_CSV", # required, accepts TEXT_CSV, APPLICATION_JSONLINES
1252
+ # json_key_to_variable_map: {
1253
+ # "string" => "string",
1254
+ # },
1255
+ # csv_index_to_variable_map: {
1256
+ # "string" => "string",
1257
+ # },
1258
+ # },
1259
+ # model_endpoint_status: "ASSOCIATED", # required, accepts ASSOCIATED, DISSOCIATED
1260
+ # })
1261
+ #
1262
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutExternalModel AWS API Documentation
1263
+ #
1264
+ # @overload put_external_model(params = {})
1265
+ # @param [Hash] params ({})
1266
+ def put_external_model(params = {}, options = {})
1267
+ req = build_request(:put_external_model, params)
1268
+ req.send_request(options)
1269
+ end
1270
+
1271
+ # Creates or updates a model.
1272
+ #
1273
+ # @option params [required, String] :model_id
1274
+ # The model ID.
1275
+ #
1276
+ # @option params [required, String] :model_type
1277
+ # The model type.
1278
+ #
1279
+ # @option params [String] :description
1280
+ # The model description.
1281
+ #
1282
+ # @option params [required, Types::TrainingDataSource] :training_data_source
1283
+ # The training data source location in Amazon S3.
1284
+ #
1285
+ # @option params [required, Array<Types::ModelVariable>] :model_variables
1286
+ # The model input variables.
1287
+ #
1288
+ # @option params [required, Types::LabelSchema] :label_schema
1289
+ # The label schema.
1290
+ #
1291
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1292
+ #
1293
+ # @example Request syntax with placeholder values
1294
+ #
1295
+ # resp = client.put_model({
1296
+ # model_id: "identifier", # required
1297
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1298
+ # description: "description",
1299
+ # training_data_source: { # required
1300
+ # data_location: "s3BucketLocation", # required
1301
+ # data_access_role_arn: "iamRoleArn", # required
1302
+ # },
1303
+ # model_variables: [ # required
1304
+ # {
1305
+ # name: "string", # required
1306
+ # index: 1,
1307
+ # },
1308
+ # ],
1309
+ # label_schema: { # required
1310
+ # label_key: "string", # required
1311
+ # label_mapper: { # required
1312
+ # "string" => ["string"],
1313
+ # },
1314
+ # },
1315
+ # })
1316
+ #
1317
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutModel AWS API Documentation
1318
+ #
1319
+ # @overload put_model(params = {})
1320
+ # @param [Hash] params ({})
1321
+ def put_model(params = {}, options = {})
1322
+ req = build_request(:put_model, params)
1323
+ req.send_request(options)
1324
+ end
1325
+
1326
+ # Creates or updates an outcome.
1327
+ #
1328
+ # @option params [required, String] :name
1329
+ # The name of the outcome.
1330
+ #
1331
+ # @option params [String] :description
1332
+ # The outcome description.
1333
+ #
1334
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1335
+ #
1336
+ # @example Request syntax with placeholder values
1337
+ #
1338
+ # resp = client.put_outcome({
1339
+ # name: "identifier", # required
1340
+ # description: "description",
1341
+ # })
1342
+ #
1343
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutOutcome AWS API Documentation
1344
+ #
1345
+ # @overload put_outcome(params = {})
1346
+ # @param [Hash] params ({})
1347
+ def put_outcome(params = {}, options = {})
1348
+ req = build_request(:put_outcome, params)
1349
+ req.send_request(options)
1350
+ end
1351
+
1352
+ # Updates a detector version. The detector version attributes that you
1353
+ # can update include models, external model endpoints, rules, and
1354
+ # description. You can only update a `DRAFT` detector version.
1355
+ #
1356
+ # @option params [required, String] :detector_id
1357
+ # The parent detector ID for the detector version you want to update.
1358
+ #
1359
+ # @option params [required, String] :detector_version_id
1360
+ # The detector version ID.
1361
+ #
1362
+ # @option params [required, Array<String>] :external_model_endpoints
1363
+ # The Amazon SageMaker model endpoints to include in the detector
1364
+ # version.
1365
+ #
1366
+ # @option params [required, Array<Types::Rule>] :rules
1367
+ # The rules to include in the detector version.
1368
+ #
1369
+ # @option params [String] :description
1370
+ # The detector version description.
1371
+ #
1372
+ # @option params [Array<Types::ModelVersion>] :model_versions
1373
+ # The model versions to include in the detector version.
1374
+ #
1375
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1376
+ #
1377
+ # @example Request syntax with placeholder values
1378
+ #
1379
+ # resp = client.update_detector_version({
1380
+ # detector_id: "identifier", # required
1381
+ # detector_version_id: "nonEmptyString", # required
1382
+ # external_model_endpoints: ["string"], # required
1383
+ # rules: [ # required
1384
+ # {
1385
+ # detector_id: "identifier", # required
1386
+ # rule_id: "identifier", # required
1387
+ # rule_version: "nonEmptyString", # required
1388
+ # },
1389
+ # ],
1390
+ # description: "description",
1391
+ # model_versions: [
1392
+ # {
1393
+ # model_id: "identifier", # required
1394
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1395
+ # model_version_number: "nonEmptyString", # required
1396
+ # },
1397
+ # ],
1398
+ # })
1399
+ #
1400
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateDetectorVersion AWS API Documentation
1401
+ #
1402
+ # @overload update_detector_version(params = {})
1403
+ # @param [Hash] params ({})
1404
+ def update_detector_version(params = {}, options = {})
1405
+ req = build_request(:update_detector_version, params)
1406
+ req.send_request(options)
1407
+ end
1408
+
1409
+ # Updates the detector version's description. You can update the
1410
+ # metadata for any detector version (`DRAFT, ACTIVE,` or `INACTIVE`).
1411
+ #
1412
+ # @option params [required, String] :detector_id
1413
+ # The detector ID.
1414
+ #
1415
+ # @option params [required, String] :detector_version_id
1416
+ # The detector version ID.
1417
+ #
1418
+ # @option params [required, String] :description
1419
+ # The description.
1420
+ #
1421
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1422
+ #
1423
+ # @example Request syntax with placeholder values
1424
+ #
1425
+ # resp = client.update_detector_version_metadata({
1426
+ # detector_id: "identifier", # required
1427
+ # detector_version_id: "nonEmptyString", # required
1428
+ # description: "description", # required
1429
+ # })
1430
+ #
1431
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateDetectorVersionMetadata AWS API Documentation
1432
+ #
1433
+ # @overload update_detector_version_metadata(params = {})
1434
+ # @param [Hash] params ({})
1435
+ def update_detector_version_metadata(params = {}, options = {})
1436
+ req = build_request(:update_detector_version_metadata, params)
1437
+ req.send_request(options)
1438
+ end
1439
+
1440
+ # Updates the detector version’s status. You can perform the following
1441
+ # promotions or demotions using `UpdateDetectorVersionStatus`\: `DRAFT`
1442
+ # to `ACTIVE`, `ACTIVE` to `INACTIVE`, and `INACTIVE` to `ACTIVE`.
1443
+ #
1444
+ # @option params [required, String] :detector_id
1445
+ # The detector ID.
1446
+ #
1447
+ # @option params [required, String] :detector_version_id
1448
+ # The detector version ID.
1449
+ #
1450
+ # @option params [required, String] :status
1451
+ # The new status.
1452
+ #
1453
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1454
+ #
1455
+ # @example Request syntax with placeholder values
1456
+ #
1457
+ # resp = client.update_detector_version_status({
1458
+ # detector_id: "identifier", # required
1459
+ # detector_version_id: "nonEmptyString", # required
1460
+ # status: "DRAFT", # required, accepts DRAFT, ACTIVE, INACTIVE
1461
+ # })
1462
+ #
1463
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateDetectorVersionStatus AWS API Documentation
1464
+ #
1465
+ # @overload update_detector_version_status(params = {})
1466
+ # @param [Hash] params ({})
1467
+ def update_detector_version_status(params = {}, options = {})
1468
+ req = build_request(:update_detector_version_status, params)
1469
+ req.send_request(options)
1470
+ end
1471
+
1472
+ # Updates a model version. You can update the description and status
1473
+ # attributes using this action. You can perform the following status
1474
+ # updates:
1475
+ #
1476
+ # 1. Change the `TRAINING_COMPLETE` status to `ACTIVE`
1477
+ #
1478
+ # 2. Change `ACTIVE` back to `TRAINING_COMPLETE`
1479
+ #
1480
+ # @option params [required, String] :model_id
1481
+ # The model ID.
1482
+ #
1483
+ # @option params [required, String] :model_type
1484
+ # The model type.
1485
+ #
1486
+ # @option params [required, String] :model_version_number
1487
+ # The model version.
1488
+ #
1489
+ # @option params [required, String] :description
1490
+ # The model description.
1491
+ #
1492
+ # @option params [required, String] :status
1493
+ # The new model status.
1494
+ #
1495
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1496
+ #
1497
+ # @example Request syntax with placeholder values
1498
+ #
1499
+ # resp = client.update_model_version({
1500
+ # model_id: "identifier", # required
1501
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1502
+ # model_version_number: "nonEmptyString", # required
1503
+ # description: "description", # required
1504
+ # status: "TRAINING_IN_PROGRESS", # required, accepts TRAINING_IN_PROGRESS, TRAINING_COMPLETE, ACTIVATE_REQUESTED, ACTIVATE_IN_PROGRESS, ACTIVE, INACTIVATE_IN_PROGRESS, INACTIVE, ERROR
1505
+ # })
1506
+ #
1507
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelVersion AWS API Documentation
1508
+ #
1509
+ # @overload update_model_version(params = {})
1510
+ # @param [Hash] params ({})
1511
+ def update_model_version(params = {}, options = {})
1512
+ req = build_request(:update_model_version, params)
1513
+ req.send_request(options)
1514
+ end
1515
+
1516
+ # Updates a rule's metadata.
1517
+ #
1518
+ # @option params [required, Types::Rule] :rule
1519
+ # The rule to update.
1520
+ #
1521
+ # @option params [required, String] :description
1522
+ # The rule description.
1523
+ #
1524
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1525
+ #
1526
+ # @example Request syntax with placeholder values
1527
+ #
1528
+ # resp = client.update_rule_metadata({
1529
+ # rule: { # required
1530
+ # detector_id: "identifier", # required
1531
+ # rule_id: "identifier", # required
1532
+ # rule_version: "nonEmptyString", # required
1533
+ # },
1534
+ # description: "description", # required
1535
+ # })
1536
+ #
1537
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateRuleMetadata AWS API Documentation
1538
+ #
1539
+ # @overload update_rule_metadata(params = {})
1540
+ # @param [Hash] params ({})
1541
+ def update_rule_metadata(params = {}, options = {})
1542
+ req = build_request(:update_rule_metadata, params)
1543
+ req.send_request(options)
1544
+ end
1545
+
1546
+ # Updates a rule version resulting in a new rule version.
1547
+ #
1548
+ # @option params [required, Types::Rule] :rule
1549
+ # The rule to update.
1550
+ #
1551
+ # @option params [String] :description
1552
+ # The description.
1553
+ #
1554
+ # @option params [required, String] :expression
1555
+ # The rule expression.
1556
+ #
1557
+ # @option params [required, String] :language
1558
+ # The language.
1559
+ #
1560
+ # @option params [required, Array<String>] :outcomes
1561
+ # The outcomes.
1562
+ #
1563
+ # @return [Types::UpdateRuleVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1564
+ #
1565
+ # * {Types::UpdateRuleVersionResult#rule #rule} => Types::Rule
1566
+ #
1567
+ # @example Request syntax with placeholder values
1568
+ #
1569
+ # resp = client.update_rule_version({
1570
+ # rule: { # required
1571
+ # detector_id: "identifier", # required
1572
+ # rule_id: "identifier", # required
1573
+ # rule_version: "nonEmptyString", # required
1574
+ # },
1575
+ # description: "description",
1576
+ # expression: "ruleExpression", # required
1577
+ # language: "DETECTORPL", # required, accepts DETECTORPL
1578
+ # outcomes: ["string"], # required
1579
+ # })
1580
+ #
1581
+ # @example Response structure
1582
+ #
1583
+ # resp.rule.detector_id #=> String
1584
+ # resp.rule.rule_id #=> String
1585
+ # resp.rule.rule_version #=> String
1586
+ #
1587
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateRuleVersion AWS API Documentation
1588
+ #
1589
+ # @overload update_rule_version(params = {})
1590
+ # @param [Hash] params ({})
1591
+ def update_rule_version(params = {}, options = {})
1592
+ req = build_request(:update_rule_version, params)
1593
+ req.send_request(options)
1594
+ end
1595
+
1596
+ # Updates a variable.
1597
+ #
1598
+ # @option params [required, String] :name
1599
+ # The name of the variable.
1600
+ #
1601
+ # @option params [String] :default_value
1602
+ # The new default value of the variable.
1603
+ #
1604
+ # @option params [String] :description
1605
+ # The new description.
1606
+ #
1607
+ # @option params [String] :variable_type
1608
+ # The variable type.
1609
+ #
1610
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1611
+ #
1612
+ # @example Request syntax with placeholder values
1613
+ #
1614
+ # resp = client.update_variable({
1615
+ # name: "string", # required
1616
+ # default_value: "string",
1617
+ # description: "string",
1618
+ # variable_type: "string",
1619
+ # })
1620
+ #
1621
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateVariable AWS API Documentation
1622
+ #
1623
+ # @overload update_variable(params = {})
1624
+ # @param [Hash] params ({})
1625
+ def update_variable(params = {}, options = {})
1626
+ req = build_request(:update_variable, params)
1627
+ req.send_request(options)
1628
+ end
1629
+
1630
+ # @!endgroup
1631
+
1632
+ # @param params ({})
1633
+ # @api private
1634
+ def build_request(operation_name, params = {})
1635
+ handlers = @handlers.for(operation_name)
1636
+ context = Seahorse::Client::RequestContext.new(
1637
+ operation_name: operation_name,
1638
+ operation: config.api.operation(operation_name),
1639
+ client: self,
1640
+ params: params,
1641
+ config: config)
1642
+ context[:gem_name] = 'aws-sdk-frauddetector'
1643
+ context[:gem_version] = '1.0.0'
1644
+ Seahorse::Client::Request.new(handlers, context)
1645
+ end
1646
+
1647
+ # @api private
1648
+ # @deprecated
1649
+ def waiter_names
1650
+ []
1651
+ end
1652
+
1653
+ class << self
1654
+
1655
+ # @api private
1656
+ attr_reader :identifier
1657
+
1658
+ # @api private
1659
+ def errors_module
1660
+ Errors
1661
+ end
1662
+
1663
+ end
1664
+ end
1665
+ end