aws-sdk-frauddetector 1.0.0

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.
@@ -0,0 +1,78 @@
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
+ module Aws::FraudDetector
9
+ module Errors
10
+
11
+ extend Aws::Errors::DynamicErrors
12
+
13
+ class InternalServerException < ServiceError
14
+
15
+ # @param [Seahorse::Client::RequestContext] context
16
+ # @param [String] message
17
+ # @param [Aws::FraudDetector::Types::InternalServerException] data
18
+ def initialize(context, message, data = Aws::EmptyStructure.new)
19
+ super(context, message, data)
20
+ end
21
+
22
+ # @return [String]
23
+ def message
24
+ @message || @data[:message]
25
+ end
26
+
27
+ end
28
+
29
+ class ResourceNotFoundException < ServiceError
30
+
31
+ # @param [Seahorse::Client::RequestContext] context
32
+ # @param [String] message
33
+ # @param [Aws::FraudDetector::Types::ResourceNotFoundException] data
34
+ def initialize(context, message, data = Aws::EmptyStructure.new)
35
+ super(context, message, data)
36
+ end
37
+
38
+ # @return [String]
39
+ def message
40
+ @message || @data[:message]
41
+ end
42
+
43
+ end
44
+
45
+ class ThrottlingException < ServiceError
46
+
47
+ # @param [Seahorse::Client::RequestContext] context
48
+ # @param [String] message
49
+ # @param [Aws::FraudDetector::Types::ThrottlingException] data
50
+ def initialize(context, message, data = Aws::EmptyStructure.new)
51
+ super(context, message, data)
52
+ end
53
+
54
+ # @return [String]
55
+ def message
56
+ @message || @data[:message]
57
+ end
58
+
59
+ end
60
+
61
+ class ValidationException < ServiceError
62
+
63
+ # @param [Seahorse::Client::RequestContext] context
64
+ # @param [String] message
65
+ # @param [Aws::FraudDetector::Types::ValidationException] data
66
+ def initialize(context, message, data = Aws::EmptyStructure.new)
67
+ super(context, message, data)
68
+ end
69
+
70
+ # @return [String]
71
+ def message
72
+ @message || @data[:message]
73
+ end
74
+
75
+ end
76
+
77
+ end
78
+ end
@@ -0,0 +1,23 @@
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
+ module Aws::FraudDetector
9
+ class Resource
10
+
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
16
+
17
+ # @return [Client]
18
+ def client
19
+ @client
20
+ end
21
+
22
+ end
23
+ end
@@ -0,0 +1,2287 @@
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
+ module Aws::FraudDetector
9
+ module Types
10
+
11
+ # Provides the error of the batch create variable API.
12
+ #
13
+ # @!attribute [rw] name
14
+ # The name.
15
+ # @return [String]
16
+ #
17
+ # @!attribute [rw] code
18
+ # The error code.
19
+ # @return [Integer]
20
+ #
21
+ # @!attribute [rw] message
22
+ # The error message.
23
+ # @return [String]
24
+ #
25
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/BatchCreateVariableError AWS API Documentation
26
+ #
27
+ class BatchCreateVariableError < Struct.new(
28
+ :name,
29
+ :code,
30
+ :message)
31
+ include Aws::Structure
32
+ end
33
+
34
+ # @note When making an API call, you may pass BatchCreateVariableRequest
35
+ # data as a hash:
36
+ #
37
+ # {
38
+ # variable_entries: [ # required
39
+ # {
40
+ # name: "string",
41
+ # data_type: "string",
42
+ # data_source: "string",
43
+ # default_value: "string",
44
+ # description: "string",
45
+ # variable_type: "string",
46
+ # },
47
+ # ],
48
+ # }
49
+ #
50
+ # @!attribute [rw] variable_entries
51
+ # The list of variables for the batch create variable request.
52
+ # @return [Array<Types::VariableEntry>]
53
+ #
54
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/BatchCreateVariableRequest AWS API Documentation
55
+ #
56
+ class BatchCreateVariableRequest < Struct.new(
57
+ :variable_entries)
58
+ include Aws::Structure
59
+ end
60
+
61
+ # @!attribute [rw] errors
62
+ # Provides the errors for the `BatchCreateVariable` request.
63
+ # @return [Array<Types::BatchCreateVariableError>]
64
+ #
65
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/BatchCreateVariableResult AWS API Documentation
66
+ #
67
+ class BatchCreateVariableResult < Struct.new(
68
+ :errors)
69
+ include Aws::Structure
70
+ end
71
+
72
+ # Provides the error of the batch get variable API.
73
+ #
74
+ # @!attribute [rw] name
75
+ # The error name.
76
+ # @return [String]
77
+ #
78
+ # @!attribute [rw] code
79
+ # The error code.
80
+ # @return [Integer]
81
+ #
82
+ # @!attribute [rw] message
83
+ # The error message.
84
+ # @return [String]
85
+ #
86
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/BatchGetVariableError AWS API Documentation
87
+ #
88
+ class BatchGetVariableError < Struct.new(
89
+ :name,
90
+ :code,
91
+ :message)
92
+ include Aws::Structure
93
+ end
94
+
95
+ # @note When making an API call, you may pass BatchGetVariableRequest
96
+ # data as a hash:
97
+ #
98
+ # {
99
+ # names: ["string"], # required
100
+ # }
101
+ #
102
+ # @!attribute [rw] names
103
+ # The list of variable names to get.
104
+ # @return [Array<String>]
105
+ #
106
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/BatchGetVariableRequest AWS API Documentation
107
+ #
108
+ class BatchGetVariableRequest < Struct.new(
109
+ :names)
110
+ include Aws::Structure
111
+ end
112
+
113
+ # @!attribute [rw] variables
114
+ # The returned variables.
115
+ # @return [Array<Types::Variable>]
116
+ #
117
+ # @!attribute [rw] errors
118
+ # The errors from the request.
119
+ # @return [Array<Types::BatchGetVariableError>]
120
+ #
121
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/BatchGetVariableResult AWS API Documentation
122
+ #
123
+ class BatchGetVariableResult < Struct.new(
124
+ :variables,
125
+ :errors)
126
+ include Aws::Structure
127
+ end
128
+
129
+ # @note When making an API call, you may pass CreateDetectorVersionRequest
130
+ # data as a hash:
131
+ #
132
+ # {
133
+ # detector_id: "identifier", # required
134
+ # description: "description",
135
+ # external_model_endpoints: ["string"],
136
+ # rules: [ # required
137
+ # {
138
+ # detector_id: "identifier", # required
139
+ # rule_id: "identifier", # required
140
+ # rule_version: "nonEmptyString", # required
141
+ # },
142
+ # ],
143
+ # model_versions: [
144
+ # {
145
+ # model_id: "identifier", # required
146
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
147
+ # model_version_number: "nonEmptyString", # required
148
+ # },
149
+ # ],
150
+ # }
151
+ #
152
+ # @!attribute [rw] detector_id
153
+ # The ID of the detector under which you want to create a new version.
154
+ # @return [String]
155
+ #
156
+ # @!attribute [rw] description
157
+ # The description of the detector version.
158
+ # @return [String]
159
+ #
160
+ # @!attribute [rw] external_model_endpoints
161
+ # The Amazon Sagemaker model endpoints to include in the detector
162
+ # version.
163
+ # @return [Array<String>]
164
+ #
165
+ # @!attribute [rw] rules
166
+ # The rules to include in the detector version.
167
+ # @return [Array<Types::Rule>]
168
+ #
169
+ # @!attribute [rw] model_versions
170
+ # The model versions to include in the detector version.
171
+ # @return [Array<Types::ModelVersion>]
172
+ #
173
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateDetectorVersionRequest AWS API Documentation
174
+ #
175
+ class CreateDetectorVersionRequest < Struct.new(
176
+ :detector_id,
177
+ :description,
178
+ :external_model_endpoints,
179
+ :rules,
180
+ :model_versions)
181
+ include Aws::Structure
182
+ end
183
+
184
+ # @!attribute [rw] detector_id
185
+ # The ID for the created version's parent detector.
186
+ # @return [String]
187
+ #
188
+ # @!attribute [rw] detector_version_id
189
+ # The ID for the created detector.
190
+ # @return [String]
191
+ #
192
+ # @!attribute [rw] status
193
+ # The status of the detector version.
194
+ # @return [String]
195
+ #
196
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateDetectorVersionResult AWS API Documentation
197
+ #
198
+ class CreateDetectorVersionResult < Struct.new(
199
+ :detector_id,
200
+ :detector_version_id,
201
+ :status)
202
+ include Aws::Structure
203
+ end
204
+
205
+ # @note When making an API call, you may pass CreateModelVersionRequest
206
+ # data as a hash:
207
+ #
208
+ # {
209
+ # model_id: "identifier", # required
210
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
211
+ # description: "description",
212
+ # }
213
+ #
214
+ # @!attribute [rw] model_id
215
+ # The model ID.
216
+ # @return [String]
217
+ #
218
+ # @!attribute [rw] model_type
219
+ # The model type.
220
+ # @return [String]
221
+ #
222
+ # @!attribute [rw] description
223
+ # The model version description.
224
+ # @return [String]
225
+ #
226
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateModelVersionRequest AWS API Documentation
227
+ #
228
+ class CreateModelVersionRequest < Struct.new(
229
+ :model_id,
230
+ :model_type,
231
+ :description)
232
+ include Aws::Structure
233
+ end
234
+
235
+ # @!attribute [rw] model_id
236
+ # The model ID.
237
+ # @return [String]
238
+ #
239
+ # @!attribute [rw] model_type
240
+ # The model type.
241
+ # @return [String]
242
+ #
243
+ # @!attribute [rw] model_version_number
244
+ # The version of the model.
245
+ # @return [String]
246
+ #
247
+ # @!attribute [rw] status
248
+ # The model version status.
249
+ # @return [String]
250
+ #
251
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateModelVersionResult AWS API Documentation
252
+ #
253
+ class CreateModelVersionResult < Struct.new(
254
+ :model_id,
255
+ :model_type,
256
+ :model_version_number,
257
+ :status)
258
+ include Aws::Structure
259
+ end
260
+
261
+ # @note When making an API call, you may pass CreateRuleRequest
262
+ # data as a hash:
263
+ #
264
+ # {
265
+ # rule_id: "identifier", # required
266
+ # detector_id: "identifier", # required
267
+ # description: "description",
268
+ # expression: "ruleExpression", # required
269
+ # language: "DETECTORPL", # required, accepts DETECTORPL
270
+ # outcomes: ["string"], # required
271
+ # }
272
+ #
273
+ # @!attribute [rw] rule_id
274
+ # The rule ID.
275
+ # @return [String]
276
+ #
277
+ # @!attribute [rw] detector_id
278
+ # The detector ID for the rule's parent detector.
279
+ # @return [String]
280
+ #
281
+ # @!attribute [rw] description
282
+ # The rule description.
283
+ # @return [String]
284
+ #
285
+ # @!attribute [rw] expression
286
+ # The rule expression.
287
+ # @return [String]
288
+ #
289
+ # @!attribute [rw] language
290
+ # The language of the rule.
291
+ # @return [String]
292
+ #
293
+ # @!attribute [rw] outcomes
294
+ # The outcome or outcomes returned when the rule expression matches.
295
+ # @return [Array<String>]
296
+ #
297
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateRuleRequest AWS API Documentation
298
+ #
299
+ class CreateRuleRequest < Struct.new(
300
+ :rule_id,
301
+ :detector_id,
302
+ :description,
303
+ :expression,
304
+ :language,
305
+ :outcomes)
306
+ include Aws::Structure
307
+ end
308
+
309
+ # @!attribute [rw] rule
310
+ # The created rule.
311
+ # @return [Types::Rule]
312
+ #
313
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateRuleResult AWS API Documentation
314
+ #
315
+ class CreateRuleResult < Struct.new(
316
+ :rule)
317
+ include Aws::Structure
318
+ end
319
+
320
+ # @note When making an API call, you may pass CreateVariableRequest
321
+ # data as a hash:
322
+ #
323
+ # {
324
+ # name: "string", # required
325
+ # data_type: "STRING", # required, accepts STRING, INTEGER, FLOAT, BOOLEAN
326
+ # data_source: "EVENT", # required, accepts EVENT, MODEL_SCORE, EXTERNAL_MODEL_SCORE
327
+ # default_value: "string", # required
328
+ # description: "string",
329
+ # variable_type: "string",
330
+ # }
331
+ #
332
+ # @!attribute [rw] name
333
+ # The name of the variable.
334
+ # @return [String]
335
+ #
336
+ # @!attribute [rw] data_type
337
+ # The data type.
338
+ # @return [String]
339
+ #
340
+ # @!attribute [rw] data_source
341
+ # The source of the data.
342
+ # @return [String]
343
+ #
344
+ # @!attribute [rw] default_value
345
+ # The default value for the variable when no value is received.
346
+ # @return [String]
347
+ #
348
+ # @!attribute [rw] description
349
+ # The description.
350
+ # @return [String]
351
+ #
352
+ # @!attribute [rw] variable_type
353
+ # The variable type.
354
+ # @return [String]
355
+ #
356
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateVariableRequest AWS API Documentation
357
+ #
358
+ class CreateVariableRequest < Struct.new(
359
+ :name,
360
+ :data_type,
361
+ :data_source,
362
+ :default_value,
363
+ :description,
364
+ :variable_type)
365
+ include Aws::Structure
366
+ end
367
+
368
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/CreateVariableResult AWS API Documentation
369
+ #
370
+ class CreateVariableResult < Aws::EmptyStructure; end
371
+
372
+ # @note When making an API call, you may pass DeleteDetectorVersionRequest
373
+ # data as a hash:
374
+ #
375
+ # {
376
+ # detector_id: "identifier", # required
377
+ # detector_version_id: "nonEmptyString", # required
378
+ # }
379
+ #
380
+ # @!attribute [rw] detector_id
381
+ # The ID of the parent detector for the detector version to delete.
382
+ # @return [String]
383
+ #
384
+ # @!attribute [rw] detector_version_id
385
+ # The ID of the detector version to delete.
386
+ # @return [String]
387
+ #
388
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteDetectorVersionRequest AWS API Documentation
389
+ #
390
+ class DeleteDetectorVersionRequest < Struct.new(
391
+ :detector_id,
392
+ :detector_version_id)
393
+ include Aws::Structure
394
+ end
395
+
396
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteDetectorVersionResult AWS API Documentation
397
+ #
398
+ class DeleteDetectorVersionResult < Aws::EmptyStructure; end
399
+
400
+ # @note When making an API call, you may pass DeleteEventRequest
401
+ # data as a hash:
402
+ #
403
+ # {
404
+ # event_id: "string", # required
405
+ # }
406
+ #
407
+ # @!attribute [rw] event_id
408
+ # The ID of the event to delete.
409
+ # @return [String]
410
+ #
411
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteEventRequest AWS API Documentation
412
+ #
413
+ class DeleteEventRequest < Struct.new(
414
+ :event_id)
415
+ include Aws::Structure
416
+ end
417
+
418
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DeleteEventResult AWS API Documentation
419
+ #
420
+ class DeleteEventResult < Aws::EmptyStructure; end
421
+
422
+ # @note When making an API call, you may pass DescribeDetectorRequest
423
+ # data as a hash:
424
+ #
425
+ # {
426
+ # detector_id: "identifier", # required
427
+ # next_token: "string",
428
+ # max_results: 1,
429
+ # }
430
+ #
431
+ # @!attribute [rw] detector_id
432
+ # The detector ID.
433
+ # @return [String]
434
+ #
435
+ # @!attribute [rw] next_token
436
+ # The next token from the previous response.
437
+ # @return [String]
438
+ #
439
+ # @!attribute [rw] max_results
440
+ # The maximum number of results to return for the request.
441
+ # @return [Integer]
442
+ #
443
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DescribeDetectorRequest AWS API Documentation
444
+ #
445
+ class DescribeDetectorRequest < Struct.new(
446
+ :detector_id,
447
+ :next_token,
448
+ :max_results)
449
+ include Aws::Structure
450
+ end
451
+
452
+ # @!attribute [rw] detector_id
453
+ # The detector ID.
454
+ # @return [String]
455
+ #
456
+ # @!attribute [rw] detector_version_summaries
457
+ # The status and description for each detector version.
458
+ # @return [Array<Types::DetectorVersionSummary>]
459
+ #
460
+ # @!attribute [rw] next_token
461
+ # The next token to be used for subsequent requests.
462
+ # @return [String]
463
+ #
464
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DescribeDetectorResult AWS API Documentation
465
+ #
466
+ class DescribeDetectorResult < Struct.new(
467
+ :detector_id,
468
+ :detector_version_summaries,
469
+ :next_token)
470
+ include Aws::Structure
471
+ end
472
+
473
+ # @note When making an API call, you may pass DescribeModelVersionsRequest
474
+ # data as a hash:
475
+ #
476
+ # {
477
+ # model_id: "identifier",
478
+ # model_version_number: "nonEmptyString",
479
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
480
+ # next_token: "string",
481
+ # max_results: 1,
482
+ # }
483
+ #
484
+ # @!attribute [rw] model_id
485
+ # The model ID.
486
+ # @return [String]
487
+ #
488
+ # @!attribute [rw] model_version_number
489
+ # The model version.
490
+ # @return [String]
491
+ #
492
+ # @!attribute [rw] model_type
493
+ # The model type.
494
+ # @return [String]
495
+ #
496
+ # @!attribute [rw] next_token
497
+ # The next token from the previous results.
498
+ # @return [String]
499
+ #
500
+ # @!attribute [rw] max_results
501
+ # The maximum number of results to return.
502
+ # @return [Integer]
503
+ #
504
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DescribeModelVersionsRequest AWS API Documentation
505
+ #
506
+ class DescribeModelVersionsRequest < Struct.new(
507
+ :model_id,
508
+ :model_version_number,
509
+ :model_type,
510
+ :next_token,
511
+ :max_results)
512
+ include Aws::Structure
513
+ end
514
+
515
+ # @!attribute [rw] model_version_details
516
+ # The model version details.
517
+ # @return [Array<Types::ModelVersionDetail>]
518
+ #
519
+ # @!attribute [rw] next_token
520
+ # The next token.
521
+ # @return [String]
522
+ #
523
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DescribeModelVersionsResult AWS API Documentation
524
+ #
525
+ class DescribeModelVersionsResult < Struct.new(
526
+ :model_version_details,
527
+ :next_token)
528
+ include Aws::Structure
529
+ end
530
+
531
+ # The detector.
532
+ #
533
+ # @!attribute [rw] detector_id
534
+ # The detector ID.
535
+ # @return [String]
536
+ #
537
+ # @!attribute [rw] description
538
+ # The detector description.
539
+ # @return [String]
540
+ #
541
+ # @!attribute [rw] last_updated_time
542
+ # Timestamp of when the detector was last updated.
543
+ # @return [String]
544
+ #
545
+ # @!attribute [rw] created_time
546
+ # Timestamp of when the detector was created.
547
+ # @return [String]
548
+ #
549
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Detector AWS API Documentation
550
+ #
551
+ class Detector < Struct.new(
552
+ :detector_id,
553
+ :description,
554
+ :last_updated_time,
555
+ :created_time)
556
+ include Aws::Structure
557
+ end
558
+
559
+ # The summary of the detector version.
560
+ #
561
+ # @!attribute [rw] detector_version_id
562
+ # The detector version ID.
563
+ # @return [String]
564
+ #
565
+ # @!attribute [rw] status
566
+ # The detector version status.
567
+ # @return [String]
568
+ #
569
+ # @!attribute [rw] description
570
+ # The detector version description.
571
+ # @return [String]
572
+ #
573
+ # @!attribute [rw] last_updated_time
574
+ # Timestamp of when the detector version was last updated.
575
+ # @return [String]
576
+ #
577
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/DetectorVersionSummary AWS API Documentation
578
+ #
579
+ class DetectorVersionSummary < Struct.new(
580
+ :detector_version_id,
581
+ :status,
582
+ :description,
583
+ :last_updated_time)
584
+ include Aws::Structure
585
+ end
586
+
587
+ # The Amazon SageMaker model.
588
+ #
589
+ # @!attribute [rw] model_endpoint
590
+ # The Amazon SageMaker model endpoints.
591
+ # @return [String]
592
+ #
593
+ # @!attribute [rw] model_source
594
+ # The source of the model.
595
+ # @return [String]
596
+ #
597
+ # @!attribute [rw] role
598
+ # The role used to invoke the model.
599
+ # @return [Types::Role]
600
+ #
601
+ # @!attribute [rw] input_configuration
602
+ # The input configuration.
603
+ # @return [Types::ModelInputConfiguration]
604
+ #
605
+ # @!attribute [rw] output_configuration
606
+ # The output configuration.
607
+ # @return [Types::ModelOutputConfiguration]
608
+ #
609
+ # @!attribute [rw] model_endpoint_status
610
+ # The Amazon Fraud Detector status for the external model endpoint
611
+ # @return [String]
612
+ #
613
+ # @!attribute [rw] last_updated_time
614
+ # Timestamp of when the model was last updated.
615
+ # @return [String]
616
+ #
617
+ # @!attribute [rw] created_time
618
+ # Timestamp of when the model was last created.
619
+ # @return [String]
620
+ #
621
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ExternalModel AWS API Documentation
622
+ #
623
+ class ExternalModel < Struct.new(
624
+ :model_endpoint,
625
+ :model_source,
626
+ :role,
627
+ :input_configuration,
628
+ :output_configuration,
629
+ :model_endpoint_status,
630
+ :last_updated_time,
631
+ :created_time)
632
+ include Aws::Structure
633
+ end
634
+
635
+ # @note When making an API call, you may pass GetDetectorVersionRequest
636
+ # data as a hash:
637
+ #
638
+ # {
639
+ # detector_id: "identifier", # required
640
+ # detector_version_id: "nonEmptyString", # required
641
+ # }
642
+ #
643
+ # @!attribute [rw] detector_id
644
+ # The detector ID.
645
+ # @return [String]
646
+ #
647
+ # @!attribute [rw] detector_version_id
648
+ # The detector version ID.
649
+ # @return [String]
650
+ #
651
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetDetectorVersionRequest AWS API Documentation
652
+ #
653
+ class GetDetectorVersionRequest < Struct.new(
654
+ :detector_id,
655
+ :detector_version_id)
656
+ include Aws::Structure
657
+ end
658
+
659
+ # @!attribute [rw] detector_id
660
+ # The detector ID.
661
+ # @return [String]
662
+ #
663
+ # @!attribute [rw] detector_version_id
664
+ # The detector version ID.
665
+ # @return [String]
666
+ #
667
+ # @!attribute [rw] description
668
+ # The detector version description.
669
+ # @return [String]
670
+ #
671
+ # @!attribute [rw] external_model_endpoints
672
+ # The Amazon SageMaker model endpoints included in the detector
673
+ # version.
674
+ # @return [Array<String>]
675
+ #
676
+ # @!attribute [rw] model_versions
677
+ # The model versions included in the detector version.
678
+ # @return [Array<Types::ModelVersion>]
679
+ #
680
+ # @!attribute [rw] rules
681
+ # The rules included in the detector version.
682
+ # @return [Array<Types::Rule>]
683
+ #
684
+ # @!attribute [rw] status
685
+ # The status of the detector version.
686
+ # @return [String]
687
+ #
688
+ # @!attribute [rw] last_updated_time
689
+ # The timestamp when the detector version was last updated.
690
+ # @return [String]
691
+ #
692
+ # @!attribute [rw] created_time
693
+ # The timestamp when the detector version was created.
694
+ # @return [String]
695
+ #
696
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetDetectorVersionResult AWS API Documentation
697
+ #
698
+ class GetDetectorVersionResult < Struct.new(
699
+ :detector_id,
700
+ :detector_version_id,
701
+ :description,
702
+ :external_model_endpoints,
703
+ :model_versions,
704
+ :rules,
705
+ :status,
706
+ :last_updated_time,
707
+ :created_time)
708
+ include Aws::Structure
709
+ end
710
+
711
+ # @note When making an API call, you may pass GetDetectorsRequest
712
+ # data as a hash:
713
+ #
714
+ # {
715
+ # detector_id: "identifier",
716
+ # next_token: "string",
717
+ # max_results: 1,
718
+ # }
719
+ #
720
+ # @!attribute [rw] detector_id
721
+ # The detector ID.
722
+ # @return [String]
723
+ #
724
+ # @!attribute [rw] next_token
725
+ # The next token for the subsequent request.
726
+ # @return [String]
727
+ #
728
+ # @!attribute [rw] max_results
729
+ # The maximum number of objects to return for the request.
730
+ # @return [Integer]
731
+ #
732
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetDetectorsRequest AWS API Documentation
733
+ #
734
+ class GetDetectorsRequest < Struct.new(
735
+ :detector_id,
736
+ :next_token,
737
+ :max_results)
738
+ include Aws::Structure
739
+ end
740
+
741
+ # @!attribute [rw] detectors
742
+ # The detectors.
743
+ # @return [Array<Types::Detector>]
744
+ #
745
+ # @!attribute [rw] next_token
746
+ # The next page token.
747
+ # @return [String]
748
+ #
749
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetDetectorsResult AWS API Documentation
750
+ #
751
+ class GetDetectorsResult < Struct.new(
752
+ :detectors,
753
+ :next_token)
754
+ include Aws::Structure
755
+ end
756
+
757
+ # @note When making an API call, you may pass GetExternalModelsRequest
758
+ # data as a hash:
759
+ #
760
+ # {
761
+ # model_endpoint: "string",
762
+ # next_token: "string",
763
+ # max_results: 1,
764
+ # }
765
+ #
766
+ # @!attribute [rw] model_endpoint
767
+ # The Amazon SageMaker model endpoint.
768
+ # @return [String]
769
+ #
770
+ # @!attribute [rw] next_token
771
+ # The next page token for the request.
772
+ # @return [String]
773
+ #
774
+ # @!attribute [rw] max_results
775
+ # The maximum number of objects to return for the request.
776
+ # @return [Integer]
777
+ #
778
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetExternalModelsRequest AWS API Documentation
779
+ #
780
+ class GetExternalModelsRequest < Struct.new(
781
+ :model_endpoint,
782
+ :next_token,
783
+ :max_results)
784
+ include Aws::Structure
785
+ end
786
+
787
+ # @!attribute [rw] external_models
788
+ # Gets the Amazon SageMaker models.
789
+ # @return [Array<Types::ExternalModel>]
790
+ #
791
+ # @!attribute [rw] next_token
792
+ # The next page token to be used in subsequent requests.
793
+ # @return [String]
794
+ #
795
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetExternalModelsResult AWS API Documentation
796
+ #
797
+ class GetExternalModelsResult < Struct.new(
798
+ :external_models,
799
+ :next_token)
800
+ include Aws::Structure
801
+ end
802
+
803
+ # @note When making an API call, you may pass GetModelVersionRequest
804
+ # data as a hash:
805
+ #
806
+ # {
807
+ # model_id: "identifier", # required
808
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
809
+ # model_version_number: "nonEmptyString", # required
810
+ # }
811
+ #
812
+ # @!attribute [rw] model_id
813
+ # The model ID.
814
+ # @return [String]
815
+ #
816
+ # @!attribute [rw] model_type
817
+ # The model type.
818
+ # @return [String]
819
+ #
820
+ # @!attribute [rw] model_version_number
821
+ # The model version.
822
+ # @return [String]
823
+ #
824
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModelVersionRequest AWS API Documentation
825
+ #
826
+ class GetModelVersionRequest < Struct.new(
827
+ :model_id,
828
+ :model_type,
829
+ :model_version_number)
830
+ include Aws::Structure
831
+ end
832
+
833
+ # @!attribute [rw] model_id
834
+ # The model ID.
835
+ # @return [String]
836
+ #
837
+ # @!attribute [rw] model_type
838
+ # The model type.
839
+ # @return [String]
840
+ #
841
+ # @!attribute [rw] model_version_number
842
+ # The model version.
843
+ # @return [String]
844
+ #
845
+ # @!attribute [rw] description
846
+ # The model version description.
847
+ # @return [String]
848
+ #
849
+ # @!attribute [rw] status
850
+ # The model version status.
851
+ # @return [String]
852
+ #
853
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModelVersionResult AWS API Documentation
854
+ #
855
+ class GetModelVersionResult < Struct.new(
856
+ :model_id,
857
+ :model_type,
858
+ :model_version_number,
859
+ :description,
860
+ :status)
861
+ include Aws::Structure
862
+ end
863
+
864
+ # @note When making an API call, you may pass GetModelsRequest
865
+ # data as a hash:
866
+ #
867
+ # {
868
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
869
+ # model_id: "identifier",
870
+ # next_token: "string",
871
+ # max_results: 1,
872
+ # }
873
+ #
874
+ # @!attribute [rw] model_type
875
+ # The model type.
876
+ # @return [String]
877
+ #
878
+ # @!attribute [rw] model_id
879
+ # The model ID.
880
+ # @return [String]
881
+ #
882
+ # @!attribute [rw] next_token
883
+ # The next token for the request.
884
+ # @return [String]
885
+ #
886
+ # @!attribute [rw] max_results
887
+ # The maximum results to return for the request.
888
+ # @return [Integer]
889
+ #
890
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModelsRequest AWS API Documentation
891
+ #
892
+ class GetModelsRequest < Struct.new(
893
+ :model_type,
894
+ :model_id,
895
+ :next_token,
896
+ :max_results)
897
+ include Aws::Structure
898
+ end
899
+
900
+ # @!attribute [rw] next_token
901
+ # The next token for subsequent requests.
902
+ # @return [String]
903
+ #
904
+ # @!attribute [rw] models
905
+ # The returned models.
906
+ # @return [Array<Types::Model>]
907
+ #
908
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetModelsResult AWS API Documentation
909
+ #
910
+ class GetModelsResult < Struct.new(
911
+ :next_token,
912
+ :models)
913
+ include Aws::Structure
914
+ end
915
+
916
+ # @note When making an API call, you may pass GetOutcomesRequest
917
+ # data as a hash:
918
+ #
919
+ # {
920
+ # name: "identifier",
921
+ # next_token: "string",
922
+ # max_results: 1,
923
+ # }
924
+ #
925
+ # @!attribute [rw] name
926
+ # The name of the outcome or outcomes to get.
927
+ # @return [String]
928
+ #
929
+ # @!attribute [rw] next_token
930
+ # The next page token for the request.
931
+ # @return [String]
932
+ #
933
+ # @!attribute [rw] max_results
934
+ # The maximum number of objects to return for the request.
935
+ # @return [Integer]
936
+ #
937
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetOutcomesRequest AWS API Documentation
938
+ #
939
+ class GetOutcomesRequest < Struct.new(
940
+ :name,
941
+ :next_token,
942
+ :max_results)
943
+ include Aws::Structure
944
+ end
945
+
946
+ # @!attribute [rw] outcomes
947
+ # The outcomes.
948
+ # @return [Array<Types::Outcome>]
949
+ #
950
+ # @!attribute [rw] next_token
951
+ # The next page token for subsequent requests.
952
+ # @return [String]
953
+ #
954
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetOutcomesResult AWS API Documentation
955
+ #
956
+ class GetOutcomesResult < Struct.new(
957
+ :outcomes,
958
+ :next_token)
959
+ include Aws::Structure
960
+ end
961
+
962
+ # @note When making an API call, you may pass GetPredictionRequest
963
+ # data as a hash:
964
+ #
965
+ # {
966
+ # detector_id: "string", # required
967
+ # detector_version_id: "string",
968
+ # event_id: "string", # required
969
+ # event_attributes: {
970
+ # "attributeKey" => "attributeValue",
971
+ # },
972
+ # external_model_endpoint_data_blobs: {
973
+ # "string" => {
974
+ # byte_buffer: "data",
975
+ # content_type: "contentType",
976
+ # },
977
+ # },
978
+ # }
979
+ #
980
+ # @!attribute [rw] detector_id
981
+ # The detector ID.
982
+ # @return [String]
983
+ #
984
+ # @!attribute [rw] detector_version_id
985
+ # The detector version ID.
986
+ # @return [String]
987
+ #
988
+ # @!attribute [rw] event_id
989
+ # The unique ID used to identify the event.
990
+ # @return [String]
991
+ #
992
+ # @!attribute [rw] event_attributes
993
+ # Names of variables you defined in Amazon Fraud Detector to represent
994
+ # event data elements and their corresponding values for the event you
995
+ # are sending for evaluation.
996
+ # @return [Hash<String,String>]
997
+ #
998
+ # @!attribute [rw] external_model_endpoint_data_blobs
999
+ # The Amazon SageMaker model endpoint input data blobs.
1000
+ # @return [Hash<String,Types::ModelEndpointDataBlob>]
1001
+ #
1002
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetPredictionRequest AWS API Documentation
1003
+ #
1004
+ class GetPredictionRequest < Struct.new(
1005
+ :detector_id,
1006
+ :detector_version_id,
1007
+ :event_id,
1008
+ :event_attributes,
1009
+ :external_model_endpoint_data_blobs)
1010
+ include Aws::Structure
1011
+ end
1012
+
1013
+ # @!attribute [rw] outcomes
1014
+ # The prediction outcomes.
1015
+ # @return [Array<String>]
1016
+ #
1017
+ # @!attribute [rw] model_scores
1018
+ # The model scores for models used in the detector version.
1019
+ # @return [Array<Types::ModelScores>]
1020
+ #
1021
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetPredictionResult AWS API Documentation
1022
+ #
1023
+ class GetPredictionResult < Struct.new(
1024
+ :outcomes,
1025
+ :model_scores)
1026
+ include Aws::Structure
1027
+ end
1028
+
1029
+ # @note When making an API call, you may pass GetRulesRequest
1030
+ # data as a hash:
1031
+ #
1032
+ # {
1033
+ # rule_id: "identifier",
1034
+ # detector_id: "identifier", # required
1035
+ # rule_version: "nonEmptyString",
1036
+ # next_token: "string",
1037
+ # max_results: 1,
1038
+ # }
1039
+ #
1040
+ # @!attribute [rw] rule_id
1041
+ # The rule ID.
1042
+ # @return [String]
1043
+ #
1044
+ # @!attribute [rw] detector_id
1045
+ # The detector ID.
1046
+ # @return [String]
1047
+ #
1048
+ # @!attribute [rw] rule_version
1049
+ # The rule version.
1050
+ # @return [String]
1051
+ #
1052
+ # @!attribute [rw] next_token
1053
+ # The next page token.
1054
+ # @return [String]
1055
+ #
1056
+ # @!attribute [rw] max_results
1057
+ # The maximum number of rules to return for the request.
1058
+ # @return [Integer]
1059
+ #
1060
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetRulesRequest AWS API Documentation
1061
+ #
1062
+ class GetRulesRequest < Struct.new(
1063
+ :rule_id,
1064
+ :detector_id,
1065
+ :rule_version,
1066
+ :next_token,
1067
+ :max_results)
1068
+ include Aws::Structure
1069
+ end
1070
+
1071
+ # @!attribute [rw] rule_details
1072
+ # The details of the requested rule.
1073
+ # @return [Array<Types::RuleDetail>]
1074
+ #
1075
+ # @!attribute [rw] next_token
1076
+ # The next page token to be used in subsequent requests.
1077
+ # @return [String]
1078
+ #
1079
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetRulesResult AWS API Documentation
1080
+ #
1081
+ class GetRulesResult < Struct.new(
1082
+ :rule_details,
1083
+ :next_token)
1084
+ include Aws::Structure
1085
+ end
1086
+
1087
+ # @note When making an API call, you may pass GetVariablesRequest
1088
+ # data as a hash:
1089
+ #
1090
+ # {
1091
+ # name: "string",
1092
+ # next_token: "string",
1093
+ # max_results: 1,
1094
+ # }
1095
+ #
1096
+ # @!attribute [rw] name
1097
+ # The name of the variable.
1098
+ # @return [String]
1099
+ #
1100
+ # @!attribute [rw] next_token
1101
+ # The next page token of the get variable request.
1102
+ # @return [String]
1103
+ #
1104
+ # @!attribute [rw] max_results
1105
+ # The max size per page determined for the get variable request.
1106
+ # @return [Integer]
1107
+ #
1108
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetVariablesRequest AWS API Documentation
1109
+ #
1110
+ class GetVariablesRequest < Struct.new(
1111
+ :name,
1112
+ :next_token,
1113
+ :max_results)
1114
+ include Aws::Structure
1115
+ end
1116
+
1117
+ # @!attribute [rw] variables
1118
+ # The names of the variables returned.
1119
+ # @return [Array<Types::Variable>]
1120
+ #
1121
+ # @!attribute [rw] next_token
1122
+ # The next page token to be used in subsequent requests.
1123
+ # @return [String]
1124
+ #
1125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetVariablesResult AWS API Documentation
1126
+ #
1127
+ class GetVariablesResult < Struct.new(
1128
+ :variables,
1129
+ :next_token)
1130
+ include Aws::Structure
1131
+ end
1132
+
1133
+ # An exception indicating an internal server error.
1134
+ #
1135
+ # @!attribute [rw] message
1136
+ # @return [String]
1137
+ #
1138
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/InternalServerException AWS API Documentation
1139
+ #
1140
+ class InternalServerException < Struct.new(
1141
+ :message)
1142
+ include Aws::Structure
1143
+ end
1144
+
1145
+ # The label schema.
1146
+ #
1147
+ # @note When making an API call, you may pass LabelSchema
1148
+ # data as a hash:
1149
+ #
1150
+ # {
1151
+ # label_key: "string", # required
1152
+ # label_mapper: { # required
1153
+ # "string" => ["string"],
1154
+ # },
1155
+ # }
1156
+ #
1157
+ # @!attribute [rw] label_key
1158
+ # The label key.
1159
+ # @return [String]
1160
+ #
1161
+ # @!attribute [rw] label_mapper
1162
+ # The label mapper maps the Amazon Fraud Detector supported label to
1163
+ # the appropriate source labels. For example, if `"FRAUD"` and
1164
+ # `"LEGIT"` are Amazon Fraud Detector supported labels, this mapper
1165
+ # could be: `\{"FRAUD" => ["0"]`, "LEGIT" =&gt; \["1"\]\\} or
1166
+ # `\{"FRAUD" => ["false"], "LEGIT" => ["true"]\}` or `\{"FRAUD" =>
1167
+ # ["fraud", "abuse"], "LEGIT" => ["legit", "safe"]\}`. The value part
1168
+ # of the mapper is a list, because you may have multiple variants for
1169
+ # a single Amazon Fraud Detector label.
1170
+ # @return [Hash<String,Array<String>>]
1171
+ #
1172
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/LabelSchema AWS API Documentation
1173
+ #
1174
+ class LabelSchema < Struct.new(
1175
+ :label_key,
1176
+ :label_mapper)
1177
+ include Aws::Structure
1178
+ end
1179
+
1180
+ # The model.
1181
+ #
1182
+ # @!attribute [rw] model_id
1183
+ # The model ID.
1184
+ # @return [String]
1185
+ #
1186
+ # @!attribute [rw] model_type
1187
+ # The model type.
1188
+ # @return [String]
1189
+ #
1190
+ # @!attribute [rw] description
1191
+ # The model description.
1192
+ # @return [String]
1193
+ #
1194
+ # @!attribute [rw] training_data_source
1195
+ # The model training data source in Amazon S3.
1196
+ # @return [Types::TrainingDataSource]
1197
+ #
1198
+ # @!attribute [rw] model_variables
1199
+ # The model input variables.
1200
+ # @return [Array<Types::ModelVariable>]
1201
+ #
1202
+ # @!attribute [rw] label_schema
1203
+ # The model label schema.
1204
+ # @return [Types::LabelSchema]
1205
+ #
1206
+ # @!attribute [rw] last_updated_time
1207
+ # Timestamp of last time the model was updated.
1208
+ # @return [String]
1209
+ #
1210
+ # @!attribute [rw] created_time
1211
+ # Timestamp of when the model was created.
1212
+ # @return [String]
1213
+ #
1214
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Model AWS API Documentation
1215
+ #
1216
+ class Model < Struct.new(
1217
+ :model_id,
1218
+ :model_type,
1219
+ :description,
1220
+ :training_data_source,
1221
+ :model_variables,
1222
+ :label_schema,
1223
+ :last_updated_time,
1224
+ :created_time)
1225
+ include Aws::Structure
1226
+ end
1227
+
1228
+ # A pre-formed Amazon SageMaker model input you can include if your
1229
+ # detector version includes an imported Amazon SageMaker model endpoint
1230
+ # with pass-through input configuration.
1231
+ #
1232
+ # @note When making an API call, you may pass ModelEndpointDataBlob
1233
+ # data as a hash:
1234
+ #
1235
+ # {
1236
+ # byte_buffer: "data",
1237
+ # content_type: "contentType",
1238
+ # }
1239
+ #
1240
+ # @!attribute [rw] byte_buffer
1241
+ # The byte buffer of the Amazon SageMaker model endpoint input data
1242
+ # blob.
1243
+ # @return [String]
1244
+ #
1245
+ # @!attribute [rw] content_type
1246
+ # The content type of the Amazon SageMaker model endpoint input data
1247
+ # blob.
1248
+ # @return [String]
1249
+ #
1250
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ModelEndpointDataBlob AWS API Documentation
1251
+ #
1252
+ class ModelEndpointDataBlob < Struct.new(
1253
+ :byte_buffer,
1254
+ :content_type)
1255
+ include Aws::Structure
1256
+ end
1257
+
1258
+ # The model input configuration.
1259
+ #
1260
+ # @note When making an API call, you may pass ModelInputConfiguration
1261
+ # data as a hash:
1262
+ #
1263
+ # {
1264
+ # format: "TEXT_CSV", # accepts TEXT_CSV, APPLICATION_JSON
1265
+ # is_opaque: false, # required
1266
+ # json_input_template: "string",
1267
+ # csv_input_template: "string",
1268
+ # }
1269
+ #
1270
+ # @!attribute [rw] format
1271
+ # The format of the model input configuration. The format differs
1272
+ # depending on if it is passed through to SageMaker or constructed by
1273
+ # Amazon Fraud Detector.
1274
+ # @return [String]
1275
+ #
1276
+ # @!attribute [rw] is_opaque
1277
+ # For an opaque-model, the input to the model will be a ByteBuffer
1278
+ # blob provided in the getPrediction request, and will be passed to
1279
+ # SageMaker as-is. For non-opaque models, the input will be
1280
+ # constructed by Amazon Fraud Detector based on the
1281
+ # model-configuration.
1282
+ # @return [Boolean]
1283
+ #
1284
+ # @!attribute [rw] json_input_template
1285
+ # Template for constructing the JSON input-data sent to SageMaker. At
1286
+ # event-evaluation, the placeholders for variable names in the
1287
+ # template will be replaced with the variable values before being sent
1288
+ # to SageMaker.
1289
+ # @return [String]
1290
+ #
1291
+ # @!attribute [rw] csv_input_template
1292
+ # Template for constructing the CSV input-data sent to SageMaker. At
1293
+ # event-evaluation, the placeholders for variable-names in the
1294
+ # template will be replaced with the variable values before being sent
1295
+ # to SageMaker.
1296
+ # @return [String]
1297
+ #
1298
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ModelInputConfiguration AWS API Documentation
1299
+ #
1300
+ class ModelInputConfiguration < Struct.new(
1301
+ :format,
1302
+ :is_opaque,
1303
+ :json_input_template,
1304
+ :csv_input_template)
1305
+ include Aws::Structure
1306
+ end
1307
+
1308
+ # Provides the model output configuration.
1309
+ #
1310
+ # @note When making an API call, you may pass ModelOutputConfiguration
1311
+ # data as a hash:
1312
+ #
1313
+ # {
1314
+ # format: "TEXT_CSV", # required, accepts TEXT_CSV, APPLICATION_JSONLINES
1315
+ # json_key_to_variable_map: {
1316
+ # "string" => "string",
1317
+ # },
1318
+ # csv_index_to_variable_map: {
1319
+ # "string" => "string",
1320
+ # },
1321
+ # }
1322
+ #
1323
+ # @!attribute [rw] format
1324
+ # The format of the model output configuration.
1325
+ # @return [String]
1326
+ #
1327
+ # @!attribute [rw] json_key_to_variable_map
1328
+ # A map of JSON keys in response from SageMaker to the Amazon Fraud
1329
+ # Detector variables.
1330
+ # @return [Hash<String,String>]
1331
+ #
1332
+ # @!attribute [rw] csv_index_to_variable_map
1333
+ # A map of CSV index values in the SageMaker response to the Amazon
1334
+ # Fraud Detector variables.
1335
+ # @return [Hash<String,String>]
1336
+ #
1337
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ModelOutputConfiguration AWS API Documentation
1338
+ #
1339
+ class ModelOutputConfiguration < Struct.new(
1340
+ :format,
1341
+ :json_key_to_variable_map,
1342
+ :csv_index_to_variable_map)
1343
+ include Aws::Structure
1344
+ end
1345
+
1346
+ # The fraud prediction scores.
1347
+ #
1348
+ # @!attribute [rw] model_version
1349
+ # The model version.
1350
+ # @return [Types::ModelVersion]
1351
+ #
1352
+ # @!attribute [rw] scores
1353
+ # The model's fraud prediction scores.
1354
+ # @return [Hash<String,Float>]
1355
+ #
1356
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ModelScores AWS API Documentation
1357
+ #
1358
+ class ModelScores < Struct.new(
1359
+ :model_version,
1360
+ :scores)
1361
+ include Aws::Structure
1362
+ end
1363
+
1364
+ # The model variable.&gt;
1365
+ #
1366
+ # @note When making an API call, you may pass ModelVariable
1367
+ # data as a hash:
1368
+ #
1369
+ # {
1370
+ # name: "string", # required
1371
+ # index: 1,
1372
+ # }
1373
+ #
1374
+ # @!attribute [rw] name
1375
+ # The model variable's name.&gt;
1376
+ # @return [String]
1377
+ #
1378
+ # @!attribute [rw] index
1379
+ # The model variable's index.&gt;
1380
+ # @return [Integer]
1381
+ #
1382
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ModelVariable AWS API Documentation
1383
+ #
1384
+ class ModelVariable < Struct.new(
1385
+ :name,
1386
+ :index)
1387
+ include Aws::Structure
1388
+ end
1389
+
1390
+ # The model version.
1391
+ #
1392
+ # @note When making an API call, you may pass ModelVersion
1393
+ # data as a hash:
1394
+ #
1395
+ # {
1396
+ # model_id: "identifier", # required
1397
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1398
+ # model_version_number: "nonEmptyString", # required
1399
+ # }
1400
+ #
1401
+ # @!attribute [rw] model_id
1402
+ # The parent model ID.
1403
+ # @return [String]
1404
+ #
1405
+ # @!attribute [rw] model_type
1406
+ # The model type.
1407
+ # @return [String]
1408
+ #
1409
+ # @!attribute [rw] model_version_number
1410
+ # The model version.
1411
+ # @return [String]
1412
+ #
1413
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ModelVersion AWS API Documentation
1414
+ #
1415
+ class ModelVersion < Struct.new(
1416
+ :model_id,
1417
+ :model_type,
1418
+ :model_version_number)
1419
+ include Aws::Structure
1420
+ end
1421
+
1422
+ # Provides the model version details.
1423
+ #
1424
+ # @!attribute [rw] model_id
1425
+ # The model ID.
1426
+ # @return [String]
1427
+ #
1428
+ # @!attribute [rw] model_type
1429
+ # The model type.
1430
+ # @return [String]
1431
+ #
1432
+ # @!attribute [rw] model_version_number
1433
+ # The model version.
1434
+ # @return [String]
1435
+ #
1436
+ # @!attribute [rw] description
1437
+ # The model description.
1438
+ # @return [String]
1439
+ #
1440
+ # @!attribute [rw] status
1441
+ # The model status.
1442
+ # @return [String]
1443
+ #
1444
+ # @!attribute [rw] training_data_source
1445
+ # The model training data source.
1446
+ # @return [Types::TrainingDataSource]
1447
+ #
1448
+ # @!attribute [rw] model_variables
1449
+ # The model variables.
1450
+ # @return [Array<Types::ModelVariable>]
1451
+ #
1452
+ # @!attribute [rw] label_schema
1453
+ # The model label schema.
1454
+ # @return [Types::LabelSchema]
1455
+ #
1456
+ # @!attribute [rw] validation_metrics
1457
+ # The model validation metrics.
1458
+ # @return [Hash<String,String>]
1459
+ #
1460
+ # @!attribute [rw] training_metrics
1461
+ # The model training metrics.
1462
+ # @return [Hash<String,String>]
1463
+ #
1464
+ # @!attribute [rw] last_updated_time
1465
+ # The timestamp when the model was last updated.
1466
+ # @return [String]
1467
+ #
1468
+ # @!attribute [rw] created_time
1469
+ # The timestamp when the model was created.
1470
+ # @return [String]
1471
+ #
1472
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ModelVersionDetail AWS API Documentation
1473
+ #
1474
+ class ModelVersionDetail < Struct.new(
1475
+ :model_id,
1476
+ :model_type,
1477
+ :model_version_number,
1478
+ :description,
1479
+ :status,
1480
+ :training_data_source,
1481
+ :model_variables,
1482
+ :label_schema,
1483
+ :validation_metrics,
1484
+ :training_metrics,
1485
+ :last_updated_time,
1486
+ :created_time)
1487
+ include Aws::Structure
1488
+ end
1489
+
1490
+ # The outcome.
1491
+ #
1492
+ # @!attribute [rw] name
1493
+ # The outcome name.
1494
+ # @return [String]
1495
+ #
1496
+ # @!attribute [rw] description
1497
+ # The outcome description.
1498
+ # @return [String]
1499
+ #
1500
+ # @!attribute [rw] last_updated_time
1501
+ # The timestamp when the outcome was last updated.
1502
+ # @return [String]
1503
+ #
1504
+ # @!attribute [rw] created_time
1505
+ # The timestamp when the outcome was created.
1506
+ # @return [String]
1507
+ #
1508
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Outcome AWS API Documentation
1509
+ #
1510
+ class Outcome < Struct.new(
1511
+ :name,
1512
+ :description,
1513
+ :last_updated_time,
1514
+ :created_time)
1515
+ include Aws::Structure
1516
+ end
1517
+
1518
+ # @note When making an API call, you may pass PutDetectorRequest
1519
+ # data as a hash:
1520
+ #
1521
+ # {
1522
+ # detector_id: "identifier", # required
1523
+ # description: "description",
1524
+ # }
1525
+ #
1526
+ # @!attribute [rw] detector_id
1527
+ # The detector ID.
1528
+ # @return [String]
1529
+ #
1530
+ # @!attribute [rw] description
1531
+ # The description of the detector.
1532
+ # @return [String]
1533
+ #
1534
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutDetectorRequest AWS API Documentation
1535
+ #
1536
+ class PutDetectorRequest < Struct.new(
1537
+ :detector_id,
1538
+ :description)
1539
+ include Aws::Structure
1540
+ end
1541
+
1542
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutDetectorResult AWS API Documentation
1543
+ #
1544
+ class PutDetectorResult < Aws::EmptyStructure; end
1545
+
1546
+ # @note When making an API call, you may pass PutExternalModelRequest
1547
+ # data as a hash:
1548
+ #
1549
+ # {
1550
+ # model_endpoint: "string", # required
1551
+ # model_source: "SAGEMAKER", # required, accepts SAGEMAKER
1552
+ # role: { # required
1553
+ # arn: "string", # required
1554
+ # name: "string", # required
1555
+ # },
1556
+ # input_configuration: { # required
1557
+ # format: "TEXT_CSV", # accepts TEXT_CSV, APPLICATION_JSON
1558
+ # is_opaque: false, # required
1559
+ # json_input_template: "string",
1560
+ # csv_input_template: "string",
1561
+ # },
1562
+ # output_configuration: { # required
1563
+ # format: "TEXT_CSV", # required, accepts TEXT_CSV, APPLICATION_JSONLINES
1564
+ # json_key_to_variable_map: {
1565
+ # "string" => "string",
1566
+ # },
1567
+ # csv_index_to_variable_map: {
1568
+ # "string" => "string",
1569
+ # },
1570
+ # },
1571
+ # model_endpoint_status: "ASSOCIATED", # required, accepts ASSOCIATED, DISSOCIATED
1572
+ # }
1573
+ #
1574
+ # @!attribute [rw] model_endpoint
1575
+ # The model endpoints name.
1576
+ # @return [String]
1577
+ #
1578
+ # @!attribute [rw] model_source
1579
+ # The source of the model.
1580
+ # @return [String]
1581
+ #
1582
+ # @!attribute [rw] role
1583
+ # The IAM role used to invoke the model endpoint.
1584
+ # @return [Types::Role]
1585
+ #
1586
+ # @!attribute [rw] input_configuration
1587
+ # The model endpoint input configuration.
1588
+ # @return [Types::ModelInputConfiguration]
1589
+ #
1590
+ # @!attribute [rw] output_configuration
1591
+ # The model endpoint output configuration.
1592
+ # @return [Types::ModelOutputConfiguration]
1593
+ #
1594
+ # @!attribute [rw] model_endpoint_status
1595
+ # The model endpoint’s status in Amazon Fraud Detector.
1596
+ # @return [String]
1597
+ #
1598
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutExternalModelRequest AWS API Documentation
1599
+ #
1600
+ class PutExternalModelRequest < Struct.new(
1601
+ :model_endpoint,
1602
+ :model_source,
1603
+ :role,
1604
+ :input_configuration,
1605
+ :output_configuration,
1606
+ :model_endpoint_status)
1607
+ include Aws::Structure
1608
+ end
1609
+
1610
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutExternalModelResult AWS API Documentation
1611
+ #
1612
+ class PutExternalModelResult < Aws::EmptyStructure; end
1613
+
1614
+ # @note When making an API call, you may pass PutModelRequest
1615
+ # data as a hash:
1616
+ #
1617
+ # {
1618
+ # model_id: "identifier", # required
1619
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1620
+ # description: "description",
1621
+ # training_data_source: { # required
1622
+ # data_location: "s3BucketLocation", # required
1623
+ # data_access_role_arn: "iamRoleArn", # required
1624
+ # },
1625
+ # model_variables: [ # required
1626
+ # {
1627
+ # name: "string", # required
1628
+ # index: 1,
1629
+ # },
1630
+ # ],
1631
+ # label_schema: { # required
1632
+ # label_key: "string", # required
1633
+ # label_mapper: { # required
1634
+ # "string" => ["string"],
1635
+ # },
1636
+ # },
1637
+ # }
1638
+ #
1639
+ # @!attribute [rw] model_id
1640
+ # The model ID.
1641
+ # @return [String]
1642
+ #
1643
+ # @!attribute [rw] model_type
1644
+ # The model type.
1645
+ # @return [String]
1646
+ #
1647
+ # @!attribute [rw] description
1648
+ # The model description.
1649
+ # @return [String]
1650
+ #
1651
+ # @!attribute [rw] training_data_source
1652
+ # The training data source location in Amazon S3.
1653
+ # @return [Types::TrainingDataSource]
1654
+ #
1655
+ # @!attribute [rw] model_variables
1656
+ # The model input variables.
1657
+ # @return [Array<Types::ModelVariable>]
1658
+ #
1659
+ # @!attribute [rw] label_schema
1660
+ # The label schema.
1661
+ # @return [Types::LabelSchema]
1662
+ #
1663
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutModelRequest AWS API Documentation
1664
+ #
1665
+ class PutModelRequest < Struct.new(
1666
+ :model_id,
1667
+ :model_type,
1668
+ :description,
1669
+ :training_data_source,
1670
+ :model_variables,
1671
+ :label_schema)
1672
+ include Aws::Structure
1673
+ end
1674
+
1675
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutModelResult AWS API Documentation
1676
+ #
1677
+ class PutModelResult < Aws::EmptyStructure; end
1678
+
1679
+ # @note When making an API call, you may pass PutOutcomeRequest
1680
+ # data as a hash:
1681
+ #
1682
+ # {
1683
+ # name: "identifier", # required
1684
+ # description: "description",
1685
+ # }
1686
+ #
1687
+ # @!attribute [rw] name
1688
+ # The name of the outcome.
1689
+ # @return [String]
1690
+ #
1691
+ # @!attribute [rw] description
1692
+ # The outcome description.
1693
+ # @return [String]
1694
+ #
1695
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutOutcomeRequest AWS API Documentation
1696
+ #
1697
+ class PutOutcomeRequest < Struct.new(
1698
+ :name,
1699
+ :description)
1700
+ include Aws::Structure
1701
+ end
1702
+
1703
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PutOutcomeResult AWS API Documentation
1704
+ #
1705
+ class PutOutcomeResult < Aws::EmptyStructure; end
1706
+
1707
+ # An exception indicating the specified resource was not found.
1708
+ #
1709
+ # @!attribute [rw] message
1710
+ # @return [String]
1711
+ #
1712
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ResourceNotFoundException AWS API Documentation
1713
+ #
1714
+ class ResourceNotFoundException < Struct.new(
1715
+ :message)
1716
+ include Aws::Structure
1717
+ end
1718
+
1719
+ # The role used to invoke external model endpoints.
1720
+ #
1721
+ # @note When making an API call, you may pass Role
1722
+ # data as a hash:
1723
+ #
1724
+ # {
1725
+ # arn: "string", # required
1726
+ # name: "string", # required
1727
+ # }
1728
+ #
1729
+ # @!attribute [rw] arn
1730
+ # The role ARN.
1731
+ # @return [String]
1732
+ #
1733
+ # @!attribute [rw] name
1734
+ # The role name.
1735
+ # @return [String]
1736
+ #
1737
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Role AWS API Documentation
1738
+ #
1739
+ class Role < Struct.new(
1740
+ :arn,
1741
+ :name)
1742
+ include Aws::Structure
1743
+ end
1744
+
1745
+ # A rule.
1746
+ #
1747
+ # @note When making an API call, you may pass Rule
1748
+ # data as a hash:
1749
+ #
1750
+ # {
1751
+ # detector_id: "identifier", # required
1752
+ # rule_id: "identifier", # required
1753
+ # rule_version: "nonEmptyString", # required
1754
+ # }
1755
+ #
1756
+ # @!attribute [rw] detector_id
1757
+ # The detector for which the rule is associated.
1758
+ # @return [String]
1759
+ #
1760
+ # @!attribute [rw] rule_id
1761
+ # The rule ID.
1762
+ # @return [String]
1763
+ #
1764
+ # @!attribute [rw] rule_version
1765
+ # The rule version.
1766
+ # @return [String]
1767
+ #
1768
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Rule AWS API Documentation
1769
+ #
1770
+ class Rule < Struct.new(
1771
+ :detector_id,
1772
+ :rule_id,
1773
+ :rule_version)
1774
+ include Aws::Structure
1775
+ end
1776
+
1777
+ # The details of the rule.
1778
+ #
1779
+ # @!attribute [rw] rule_id
1780
+ # The rule ID.
1781
+ # @return [String]
1782
+ #
1783
+ # @!attribute [rw] description
1784
+ # The rule description.
1785
+ # @return [String]
1786
+ #
1787
+ # @!attribute [rw] detector_id
1788
+ # The detector for which the rule is associated.
1789
+ # @return [String]
1790
+ #
1791
+ # @!attribute [rw] rule_version
1792
+ # The rule version.
1793
+ # @return [String]
1794
+ #
1795
+ # @!attribute [rw] expression
1796
+ # The rule expression.
1797
+ # @return [String]
1798
+ #
1799
+ # @!attribute [rw] language
1800
+ # The rule language.
1801
+ # @return [String]
1802
+ #
1803
+ # @!attribute [rw] outcomes
1804
+ # The rule outcomes.
1805
+ # @return [Array<String>]
1806
+ #
1807
+ # @!attribute [rw] last_updated_time
1808
+ # Timestamp of the last time the rule was updated.
1809
+ # @return [String]
1810
+ #
1811
+ # @!attribute [rw] created_time
1812
+ # The timestamp of when the rule was created.
1813
+ # @return [String]
1814
+ #
1815
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/RuleDetail AWS API Documentation
1816
+ #
1817
+ class RuleDetail < Struct.new(
1818
+ :rule_id,
1819
+ :description,
1820
+ :detector_id,
1821
+ :rule_version,
1822
+ :expression,
1823
+ :language,
1824
+ :outcomes,
1825
+ :last_updated_time,
1826
+ :created_time)
1827
+ include Aws::Structure
1828
+ end
1829
+
1830
+ # An exception indicating a throttling error.
1831
+ #
1832
+ # @!attribute [rw] message
1833
+ # @return [String]
1834
+ #
1835
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ThrottlingException AWS API Documentation
1836
+ #
1837
+ class ThrottlingException < Struct.new(
1838
+ :message)
1839
+ include Aws::Structure
1840
+ end
1841
+
1842
+ # The training data source.
1843
+ #
1844
+ # @note When making an API call, you may pass TrainingDataSource
1845
+ # data as a hash:
1846
+ #
1847
+ # {
1848
+ # data_location: "s3BucketLocation", # required
1849
+ # data_access_role_arn: "iamRoleArn", # required
1850
+ # }
1851
+ #
1852
+ # @!attribute [rw] data_location
1853
+ # The data location of the training data source.
1854
+ # @return [String]
1855
+ #
1856
+ # @!attribute [rw] data_access_role_arn
1857
+ # The data access role ARN for the training data source.
1858
+ # @return [String]
1859
+ #
1860
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/TrainingDataSource AWS API Documentation
1861
+ #
1862
+ class TrainingDataSource < Struct.new(
1863
+ :data_location,
1864
+ :data_access_role_arn)
1865
+ include Aws::Structure
1866
+ end
1867
+
1868
+ # @note When making an API call, you may pass UpdateDetectorVersionMetadataRequest
1869
+ # data as a hash:
1870
+ #
1871
+ # {
1872
+ # detector_id: "identifier", # required
1873
+ # detector_version_id: "nonEmptyString", # required
1874
+ # description: "description", # required
1875
+ # }
1876
+ #
1877
+ # @!attribute [rw] detector_id
1878
+ # The detector ID.
1879
+ # @return [String]
1880
+ #
1881
+ # @!attribute [rw] detector_version_id
1882
+ # The detector version ID.
1883
+ # @return [String]
1884
+ #
1885
+ # @!attribute [rw] description
1886
+ # The description.
1887
+ # @return [String]
1888
+ #
1889
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateDetectorVersionMetadataRequest AWS API Documentation
1890
+ #
1891
+ class UpdateDetectorVersionMetadataRequest < Struct.new(
1892
+ :detector_id,
1893
+ :detector_version_id,
1894
+ :description)
1895
+ include Aws::Structure
1896
+ end
1897
+
1898
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateDetectorVersionMetadataResult AWS API Documentation
1899
+ #
1900
+ class UpdateDetectorVersionMetadataResult < Aws::EmptyStructure; end
1901
+
1902
+ # @note When making an API call, you may pass UpdateDetectorVersionRequest
1903
+ # data as a hash:
1904
+ #
1905
+ # {
1906
+ # detector_id: "identifier", # required
1907
+ # detector_version_id: "nonEmptyString", # required
1908
+ # external_model_endpoints: ["string"], # required
1909
+ # rules: [ # required
1910
+ # {
1911
+ # detector_id: "identifier", # required
1912
+ # rule_id: "identifier", # required
1913
+ # rule_version: "nonEmptyString", # required
1914
+ # },
1915
+ # ],
1916
+ # description: "description",
1917
+ # model_versions: [
1918
+ # {
1919
+ # model_id: "identifier", # required
1920
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
1921
+ # model_version_number: "nonEmptyString", # required
1922
+ # },
1923
+ # ],
1924
+ # }
1925
+ #
1926
+ # @!attribute [rw] detector_id
1927
+ # The parent detector ID for the detector version you want to update.
1928
+ # @return [String]
1929
+ #
1930
+ # @!attribute [rw] detector_version_id
1931
+ # The detector version ID.
1932
+ # @return [String]
1933
+ #
1934
+ # @!attribute [rw] external_model_endpoints
1935
+ # The Amazon SageMaker model endpoints to include in the detector
1936
+ # version.
1937
+ # @return [Array<String>]
1938
+ #
1939
+ # @!attribute [rw] rules
1940
+ # The rules to include in the detector version.
1941
+ # @return [Array<Types::Rule>]
1942
+ #
1943
+ # @!attribute [rw] description
1944
+ # The detector version description.
1945
+ # @return [String]
1946
+ #
1947
+ # @!attribute [rw] model_versions
1948
+ # The model versions to include in the detector version.
1949
+ # @return [Array<Types::ModelVersion>]
1950
+ #
1951
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateDetectorVersionRequest AWS API Documentation
1952
+ #
1953
+ class UpdateDetectorVersionRequest < Struct.new(
1954
+ :detector_id,
1955
+ :detector_version_id,
1956
+ :external_model_endpoints,
1957
+ :rules,
1958
+ :description,
1959
+ :model_versions)
1960
+ include Aws::Structure
1961
+ end
1962
+
1963
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateDetectorVersionResult AWS API Documentation
1964
+ #
1965
+ class UpdateDetectorVersionResult < Aws::EmptyStructure; end
1966
+
1967
+ # @note When making an API call, you may pass UpdateDetectorVersionStatusRequest
1968
+ # data as a hash:
1969
+ #
1970
+ # {
1971
+ # detector_id: "identifier", # required
1972
+ # detector_version_id: "nonEmptyString", # required
1973
+ # status: "DRAFT", # required, accepts DRAFT, ACTIVE, INACTIVE
1974
+ # }
1975
+ #
1976
+ # @!attribute [rw] detector_id
1977
+ # The detector ID.
1978
+ # @return [String]
1979
+ #
1980
+ # @!attribute [rw] detector_version_id
1981
+ # The detector version ID.
1982
+ # @return [String]
1983
+ #
1984
+ # @!attribute [rw] status
1985
+ # The new status.
1986
+ # @return [String]
1987
+ #
1988
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateDetectorVersionStatusRequest AWS API Documentation
1989
+ #
1990
+ class UpdateDetectorVersionStatusRequest < Struct.new(
1991
+ :detector_id,
1992
+ :detector_version_id,
1993
+ :status)
1994
+ include Aws::Structure
1995
+ end
1996
+
1997
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateDetectorVersionStatusResult AWS API Documentation
1998
+ #
1999
+ class UpdateDetectorVersionStatusResult < Aws::EmptyStructure; end
2000
+
2001
+ # @note When making an API call, you may pass UpdateModelVersionRequest
2002
+ # data as a hash:
2003
+ #
2004
+ # {
2005
+ # model_id: "identifier", # required
2006
+ # model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
2007
+ # model_version_number: "nonEmptyString", # required
2008
+ # description: "description", # required
2009
+ # status: "TRAINING_IN_PROGRESS", # required, accepts TRAINING_IN_PROGRESS, TRAINING_COMPLETE, ACTIVATE_REQUESTED, ACTIVATE_IN_PROGRESS, ACTIVE, INACTIVATE_IN_PROGRESS, INACTIVE, ERROR
2010
+ # }
2011
+ #
2012
+ # @!attribute [rw] model_id
2013
+ # The model ID.
2014
+ # @return [String]
2015
+ #
2016
+ # @!attribute [rw] model_type
2017
+ # The model type.
2018
+ # @return [String]
2019
+ #
2020
+ # @!attribute [rw] model_version_number
2021
+ # The model version.
2022
+ # @return [String]
2023
+ #
2024
+ # @!attribute [rw] description
2025
+ # The model description.
2026
+ # @return [String]
2027
+ #
2028
+ # @!attribute [rw] status
2029
+ # The new model status.
2030
+ # @return [String]
2031
+ #
2032
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelVersionRequest AWS API Documentation
2033
+ #
2034
+ class UpdateModelVersionRequest < Struct.new(
2035
+ :model_id,
2036
+ :model_type,
2037
+ :model_version_number,
2038
+ :description,
2039
+ :status)
2040
+ include Aws::Structure
2041
+ end
2042
+
2043
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateModelVersionResult AWS API Documentation
2044
+ #
2045
+ class UpdateModelVersionResult < Aws::EmptyStructure; end
2046
+
2047
+ # @note When making an API call, you may pass UpdateRuleMetadataRequest
2048
+ # data as a hash:
2049
+ #
2050
+ # {
2051
+ # rule: { # required
2052
+ # detector_id: "identifier", # required
2053
+ # rule_id: "identifier", # required
2054
+ # rule_version: "nonEmptyString", # required
2055
+ # },
2056
+ # description: "description", # required
2057
+ # }
2058
+ #
2059
+ # @!attribute [rw] rule
2060
+ # The rule to update.
2061
+ # @return [Types::Rule]
2062
+ #
2063
+ # @!attribute [rw] description
2064
+ # The rule description.
2065
+ # @return [String]
2066
+ #
2067
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateRuleMetadataRequest AWS API Documentation
2068
+ #
2069
+ class UpdateRuleMetadataRequest < Struct.new(
2070
+ :rule,
2071
+ :description)
2072
+ include Aws::Structure
2073
+ end
2074
+
2075
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateRuleMetadataResult AWS API Documentation
2076
+ #
2077
+ class UpdateRuleMetadataResult < Aws::EmptyStructure; end
2078
+
2079
+ # @note When making an API call, you may pass UpdateRuleVersionRequest
2080
+ # data as a hash:
2081
+ #
2082
+ # {
2083
+ # rule: { # required
2084
+ # detector_id: "identifier", # required
2085
+ # rule_id: "identifier", # required
2086
+ # rule_version: "nonEmptyString", # required
2087
+ # },
2088
+ # description: "description",
2089
+ # expression: "ruleExpression", # required
2090
+ # language: "DETECTORPL", # required, accepts DETECTORPL
2091
+ # outcomes: ["string"], # required
2092
+ # }
2093
+ #
2094
+ # @!attribute [rw] rule
2095
+ # The rule to update.
2096
+ # @return [Types::Rule]
2097
+ #
2098
+ # @!attribute [rw] description
2099
+ # The description.
2100
+ # @return [String]
2101
+ #
2102
+ # @!attribute [rw] expression
2103
+ # The rule expression.
2104
+ # @return [String]
2105
+ #
2106
+ # @!attribute [rw] language
2107
+ # The language.
2108
+ # @return [String]
2109
+ #
2110
+ # @!attribute [rw] outcomes
2111
+ # The outcomes.
2112
+ # @return [Array<String>]
2113
+ #
2114
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateRuleVersionRequest AWS API Documentation
2115
+ #
2116
+ class UpdateRuleVersionRequest < Struct.new(
2117
+ :rule,
2118
+ :description,
2119
+ :expression,
2120
+ :language,
2121
+ :outcomes)
2122
+ include Aws::Structure
2123
+ end
2124
+
2125
+ # @!attribute [rw] rule
2126
+ # The new rule version that was created.
2127
+ # @return [Types::Rule]
2128
+ #
2129
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateRuleVersionResult AWS API Documentation
2130
+ #
2131
+ class UpdateRuleVersionResult < Struct.new(
2132
+ :rule)
2133
+ include Aws::Structure
2134
+ end
2135
+
2136
+ # @note When making an API call, you may pass UpdateVariableRequest
2137
+ # data as a hash:
2138
+ #
2139
+ # {
2140
+ # name: "string", # required
2141
+ # default_value: "string",
2142
+ # description: "string",
2143
+ # variable_type: "string",
2144
+ # }
2145
+ #
2146
+ # @!attribute [rw] name
2147
+ # The name of the variable.
2148
+ # @return [String]
2149
+ #
2150
+ # @!attribute [rw] default_value
2151
+ # The new default value of the variable.
2152
+ # @return [String]
2153
+ #
2154
+ # @!attribute [rw] description
2155
+ # The new description.
2156
+ # @return [String]
2157
+ #
2158
+ # @!attribute [rw] variable_type
2159
+ # The variable type.
2160
+ # @return [String]
2161
+ #
2162
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateVariableRequest AWS API Documentation
2163
+ #
2164
+ class UpdateVariableRequest < Struct.new(
2165
+ :name,
2166
+ :default_value,
2167
+ :description,
2168
+ :variable_type)
2169
+ include Aws::Structure
2170
+ end
2171
+
2172
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateVariableResult AWS API Documentation
2173
+ #
2174
+ class UpdateVariableResult < Aws::EmptyStructure; end
2175
+
2176
+ # An exception indicating a specified value is not allowed.
2177
+ #
2178
+ # @!attribute [rw] message
2179
+ # @return [String]
2180
+ #
2181
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ValidationException AWS API Documentation
2182
+ #
2183
+ class ValidationException < Struct.new(
2184
+ :message)
2185
+ include Aws::Structure
2186
+ end
2187
+
2188
+ # The variable.
2189
+ #
2190
+ # @!attribute [rw] name
2191
+ # The name of the variable.
2192
+ # @return [String]
2193
+ #
2194
+ # @!attribute [rw] data_type
2195
+ # The data type of the variable.
2196
+ # @return [String]
2197
+ #
2198
+ # @!attribute [rw] data_source
2199
+ # The data source of the variable.
2200
+ # @return [String]
2201
+ #
2202
+ # @!attribute [rw] default_value
2203
+ # The default value of the variable.
2204
+ # @return [String]
2205
+ #
2206
+ # @!attribute [rw] description
2207
+ # The description of the variable.
2208
+ # @return [String]
2209
+ #
2210
+ # @!attribute [rw] variable_type
2211
+ # The variable type of the variable.
2212
+ # @return [String]
2213
+ #
2214
+ # @!attribute [rw] last_updated_time
2215
+ # The time when variable was last updated.
2216
+ # @return [String]
2217
+ #
2218
+ # @!attribute [rw] created_time
2219
+ # The time when the variable was created.
2220
+ # @return [String]
2221
+ #
2222
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/Variable AWS API Documentation
2223
+ #
2224
+ class Variable < Struct.new(
2225
+ :name,
2226
+ :data_type,
2227
+ :data_source,
2228
+ :default_value,
2229
+ :description,
2230
+ :variable_type,
2231
+ :last_updated_time,
2232
+ :created_time)
2233
+ include Aws::Structure
2234
+ end
2235
+
2236
+ # The variable entry in a list.
2237
+ #
2238
+ # @note When making an API call, you may pass VariableEntry
2239
+ # data as a hash:
2240
+ #
2241
+ # {
2242
+ # name: "string",
2243
+ # data_type: "string",
2244
+ # data_source: "string",
2245
+ # default_value: "string",
2246
+ # description: "string",
2247
+ # variable_type: "string",
2248
+ # }
2249
+ #
2250
+ # @!attribute [rw] name
2251
+ # The name of the variable entry.
2252
+ # @return [String]
2253
+ #
2254
+ # @!attribute [rw] data_type
2255
+ # The data type of the variable entry.
2256
+ # @return [String]
2257
+ #
2258
+ # @!attribute [rw] data_source
2259
+ # The data source of the variable entry.
2260
+ # @return [String]
2261
+ #
2262
+ # @!attribute [rw] default_value
2263
+ # The default value of the variable entry.
2264
+ # @return [String]
2265
+ #
2266
+ # @!attribute [rw] description
2267
+ # The description of the variable entry.
2268
+ # @return [String]
2269
+ #
2270
+ # @!attribute [rw] variable_type
2271
+ # The type of the variable entry.
2272
+ # @return [String]
2273
+ #
2274
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/VariableEntry AWS API Documentation
2275
+ #
2276
+ class VariableEntry < Struct.new(
2277
+ :name,
2278
+ :data_type,
2279
+ :data_source,
2280
+ :default_value,
2281
+ :description,
2282
+ :variable_type)
2283
+ include Aws::Structure
2284
+ end
2285
+
2286
+ end
2287
+ end