aws-sdk-frauddetector 1.29.0 → 1.30.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b4c5c43d1472212ab5cbf168debf3ca4d42a62db20718c416128021a4cc29f9c
4
- data.tar.gz: 2f236abe4aace8b0a829c530586fd716a46332881a141da2a22aebd9cf7b90e1
3
+ metadata.gz: de1040dac4897b7124d1638c45a389f9844599a2957f01d33f9723b774b0dfb0
4
+ data.tar.gz: bf4e2a12f37f89ea886b1e3e25ca7ec1536ac63908a8d2ef8fe29e292f16e003
5
5
  SHA512:
6
- metadata.gz: 5c0dc460184213e92630c27734618096dd9e2f546460b889d4864f9192d18ee81801f656df91ef6c5eea78255dc07da305b4439b5e610607eda3dafb14f00ba3
7
- data.tar.gz: 67de4ebe6c3834ed125c7fb627462cf305f79c65d41613c7b0d2c8064717b0e6c5060393677176aa44079bc456a992d8c2651ed11c8bc832df59de35f8211dc2
6
+ metadata.gz: d7d85fe3b7543f52bf44b77f2d634d56d82e0e56d7333d32c368762c3eeb7753d73cd07e59cab5fd1ea5691a21bf81420d75ed89f9e101c5d8c1d5cb29a30c9d
7
+ data.tar.gz: de017cedc6e66c9577c9c05bd3cbb72d23ccc5c8288d436f0f24f0f87db6a6cc79c427fe6f7b14ab29ddc496ad19313785a6f1940dee73a4eca8f1177c5d8d7c
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.30.0 (2022-01-26)
5
+ ------------------
6
+
7
+ * Feature - Added new APIs for viewing past predictions and obtaining prediction metadata including prediction explanations: ListEventPredictions and GetEventPredictionMetadata
8
+
4
9
  1.29.0 (2021-12-21)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.29.0
1
+ 1.30.0
@@ -1982,6 +1982,109 @@ module Aws::FraudDetector
1982
1982
  req.send_request(options)
1983
1983
  end
1984
1984
 
1985
+ # Gets details of the past fraud predictions for the specified event ID,
1986
+ # event type, detector ID, and detector version ID that was generated in
1987
+ # the specified time period.
1988
+ #
1989
+ # @option params [required, String] :event_id
1990
+ # The event ID.
1991
+ #
1992
+ # @option params [required, String] :event_type_name
1993
+ # The event type associated with the detector specified for the
1994
+ # prediction.
1995
+ #
1996
+ # @option params [required, String] :detector_id
1997
+ # The detector ID.
1998
+ #
1999
+ # @option params [required, String] :detector_version_id
2000
+ # The detector version ID.
2001
+ #
2002
+ # @option params [required, String] :prediction_timestamp
2003
+ # The timestamp that defines when the prediction was generated.
2004
+ #
2005
+ # @return [Types::GetEventPredictionMetadataResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2006
+ #
2007
+ # * {Types::GetEventPredictionMetadataResult#event_id #event_id} => String
2008
+ # * {Types::GetEventPredictionMetadataResult#event_type_name #event_type_name} => String
2009
+ # * {Types::GetEventPredictionMetadataResult#entity_id #entity_id} => String
2010
+ # * {Types::GetEventPredictionMetadataResult#entity_type #entity_type} => String
2011
+ # * {Types::GetEventPredictionMetadataResult#event_timestamp #event_timestamp} => String
2012
+ # * {Types::GetEventPredictionMetadataResult#detector_id #detector_id} => String
2013
+ # * {Types::GetEventPredictionMetadataResult#detector_version_id #detector_version_id} => String
2014
+ # * {Types::GetEventPredictionMetadataResult#detector_version_status #detector_version_status} => String
2015
+ # * {Types::GetEventPredictionMetadataResult#event_variables #event_variables} => Array<Types::EventVariableSummary>
2016
+ # * {Types::GetEventPredictionMetadataResult#rules #rules} => Array<Types::EvaluatedRule>
2017
+ # * {Types::GetEventPredictionMetadataResult#rule_execution_mode #rule_execution_mode} => String
2018
+ # * {Types::GetEventPredictionMetadataResult#outcomes #outcomes} => Array<String>
2019
+ # * {Types::GetEventPredictionMetadataResult#evaluated_model_versions #evaluated_model_versions} => Array<Types::EvaluatedModelVersion>
2020
+ # * {Types::GetEventPredictionMetadataResult#evaluated_external_models #evaluated_external_models} => Array<Types::EvaluatedExternalModel>
2021
+ # * {Types::GetEventPredictionMetadataResult#prediction_timestamp #prediction_timestamp} => String
2022
+ #
2023
+ # @example Request syntax with placeholder values
2024
+ #
2025
+ # resp = client.get_event_prediction_metadata({
2026
+ # event_id: "identifier", # required
2027
+ # event_type_name: "identifier", # required
2028
+ # detector_id: "identifier", # required
2029
+ # detector_version_id: "wholeNumberVersionString", # required
2030
+ # prediction_timestamp: "time", # required
2031
+ # })
2032
+ #
2033
+ # @example Response structure
2034
+ #
2035
+ # resp.event_id #=> String
2036
+ # resp.event_type_name #=> String
2037
+ # resp.entity_id #=> String
2038
+ # resp.entity_type #=> String
2039
+ # resp.event_timestamp #=> String
2040
+ # resp.detector_id #=> String
2041
+ # resp.detector_version_id #=> String
2042
+ # resp.detector_version_status #=> String
2043
+ # resp.event_variables #=> Array
2044
+ # resp.event_variables[0].name #=> String
2045
+ # resp.event_variables[0].value #=> String
2046
+ # resp.event_variables[0].source #=> String
2047
+ # resp.rules #=> Array
2048
+ # resp.rules[0].rule_id #=> String
2049
+ # resp.rules[0].rule_version #=> String
2050
+ # resp.rules[0].expression #=> String
2051
+ # resp.rules[0].expression_with_values #=> String
2052
+ # resp.rules[0].outcomes #=> Array
2053
+ # resp.rules[0].outcomes[0] #=> String
2054
+ # resp.rules[0].evaluated #=> Boolean
2055
+ # resp.rules[0].matched #=> Boolean
2056
+ # resp.rule_execution_mode #=> String, one of "ALL_MATCHED", "FIRST_MATCHED"
2057
+ # resp.outcomes #=> Array
2058
+ # resp.outcomes[0] #=> String
2059
+ # resp.evaluated_model_versions #=> Array
2060
+ # resp.evaluated_model_versions[0].model_id #=> String
2061
+ # resp.evaluated_model_versions[0].model_version #=> String
2062
+ # resp.evaluated_model_versions[0].model_type #=> String
2063
+ # resp.evaluated_model_versions[0].evaluations #=> Array
2064
+ # resp.evaluated_model_versions[0].evaluations[0].output_variable_name #=> String
2065
+ # resp.evaluated_model_versions[0].evaluations[0].evaluation_score #=> String
2066
+ # resp.evaluated_model_versions[0].evaluations[0].prediction_explanations.variable_impact_explanations #=> Array
2067
+ # resp.evaluated_model_versions[0].evaluations[0].prediction_explanations.variable_impact_explanations[0].event_variable_name #=> String
2068
+ # resp.evaluated_model_versions[0].evaluations[0].prediction_explanations.variable_impact_explanations[0].relative_impact #=> String
2069
+ # resp.evaluated_model_versions[0].evaluations[0].prediction_explanations.variable_impact_explanations[0].log_odds_impact #=> Float
2070
+ # resp.evaluated_external_models #=> Array
2071
+ # resp.evaluated_external_models[0].model_endpoint #=> String
2072
+ # resp.evaluated_external_models[0].use_event_variables #=> Boolean
2073
+ # resp.evaluated_external_models[0].input_variables #=> Hash
2074
+ # resp.evaluated_external_models[0].input_variables["string"] #=> String
2075
+ # resp.evaluated_external_models[0].output_variables #=> Hash
2076
+ # resp.evaluated_external_models[0].output_variables["string"] #=> String
2077
+ # resp.prediction_timestamp #=> String
2078
+ #
2079
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventPredictionMetadata AWS API Documentation
2080
+ #
2081
+ # @overload get_event_prediction_metadata(params = {})
2082
+ # @param [Hash] params ({})
2083
+ def get_event_prediction_metadata(params = {}, options = {})
2084
+ req = build_request(:get_event_prediction_metadata, params)
2085
+ req.send_request(options)
2086
+ end
2087
+
1985
2088
  # Gets all event types or a specific event type if name is provided.
1986
2089
  # This is a paginated API. If you provide a null `maxResults`, this
1987
2090
  # action retrieves a maximum of 10 records per page. If you provide a
@@ -2472,6 +2575,94 @@ module Aws::FraudDetector
2472
2575
  req.send_request(options)
2473
2576
  end
2474
2577
 
2578
+ # Gets a list of past predictions. The list can be filtered by detector
2579
+ # ID, detector version ID, event ID, event type, or by specifying a time
2580
+ # period. If filter is not specified, the most recent prediction is
2581
+ # returned.
2582
+ #
2583
+ # For example, the following filter lists all past predictions for `xyz`
2584
+ # event type - `\{ "eventType":\{ "value": "xyz" \}” \} `
2585
+ #
2586
+ # This is a paginated API. If you provide a null `maxResults`, this
2587
+ # action will retrieve a maximum of 10 records per page. If you provide
2588
+ # a `maxResults`, the value must be between 50 and 100. To get the next
2589
+ # page results, provide the `nextToken` from the response as part of
2590
+ # your request. A null `nextToken` fetches the records from the
2591
+ # beginning.
2592
+ #
2593
+ # @option params [Types::FilterCondition] :event_id
2594
+ # The event ID.
2595
+ #
2596
+ # @option params [Types::FilterCondition] :event_type
2597
+ # The event type associated with the detector.
2598
+ #
2599
+ # @option params [Types::FilterCondition] :detector_id
2600
+ # The detector ID.
2601
+ #
2602
+ # @option params [Types::FilterCondition] :detector_version_id
2603
+ # The detector version ID.
2604
+ #
2605
+ # @option params [Types::PredictionTimeRange] :prediction_time_range
2606
+ # The time period for when the predictions were generated.
2607
+ #
2608
+ # @option params [String] :next_token
2609
+ # Identifies the next page of results to return. Use the token to make
2610
+ # the call again to retrieve the next page. Keep all other arguments
2611
+ # unchanged. Each pagination token expires after 24 hours.
2612
+ #
2613
+ # @option params [Integer] :max_results
2614
+ # The maximum number of predictions to return for the request.
2615
+ #
2616
+ # @return [Types::ListEventPredictionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2617
+ #
2618
+ # * {Types::ListEventPredictionsResult#event_prediction_summaries #event_prediction_summaries} => Array<Types::EventPredictionSummary>
2619
+ # * {Types::ListEventPredictionsResult#next_token #next_token} => String
2620
+ #
2621
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2622
+ #
2623
+ # @example Request syntax with placeholder values
2624
+ #
2625
+ # resp = client.list_event_predictions({
2626
+ # event_id: {
2627
+ # value: "filterString",
2628
+ # },
2629
+ # event_type: {
2630
+ # value: "filterString",
2631
+ # },
2632
+ # detector_id: {
2633
+ # value: "filterString",
2634
+ # },
2635
+ # detector_version_id: {
2636
+ # value: "filterString",
2637
+ # },
2638
+ # prediction_time_range: {
2639
+ # start_time: "time", # required
2640
+ # end_time: "time", # required
2641
+ # },
2642
+ # next_token: "string",
2643
+ # max_results: 1,
2644
+ # })
2645
+ #
2646
+ # @example Response structure
2647
+ #
2648
+ # resp.event_prediction_summaries #=> Array
2649
+ # resp.event_prediction_summaries[0].event_id #=> String
2650
+ # resp.event_prediction_summaries[0].event_type_name #=> String
2651
+ # resp.event_prediction_summaries[0].event_timestamp #=> String
2652
+ # resp.event_prediction_summaries[0].prediction_timestamp #=> String
2653
+ # resp.event_prediction_summaries[0].detector_id #=> String
2654
+ # resp.event_prediction_summaries[0].detector_version_id #=> String
2655
+ # resp.next_token #=> String
2656
+ #
2657
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ListEventPredictions AWS API Documentation
2658
+ #
2659
+ # @overload list_event_predictions(params = {})
2660
+ # @param [Hash] params ({})
2661
+ def list_event_predictions(params = {}, options = {})
2662
+ req = build_request(:list_event_predictions, params)
2663
+ req.send_request(options)
2664
+ end
2665
+
2475
2666
  # Lists all tags associated with the resource. This is a paginated API.
2476
2667
  # To get the next page results, provide the pagination token from the
2477
2668
  # response as part of your request. A null pagination token fetches the
@@ -3391,7 +3582,7 @@ module Aws::FraudDetector
3391
3582
  params: params,
3392
3583
  config: config)
3393
3584
  context[:gem_name] = 'aws-sdk-frauddetector'
3394
- context[:gem_version] = '1.29.0'
3585
+ context[:gem_version] = '1.30.0'
3395
3586
  Seahorse::Client::Request.new(handlers, context)
3396
3587
  end
3397
3588
 
@@ -27,6 +27,7 @@ module Aws::FraudDetector
27
27
  BatchImportList = Shapes::ListShape.new(name: 'BatchImportList')
28
28
  BatchPrediction = Shapes::StructureShape.new(name: 'BatchPrediction')
29
29
  BatchPredictionList = Shapes::ListShape.new(name: 'BatchPredictionList')
30
+ Boolean = Shapes::BooleanShape.new(name: 'Boolean')
30
31
  CancelBatchImportJobRequest = Shapes::StructureShape.new(name: 'CancelBatchImportJobRequest')
31
32
  CancelBatchImportJobResult = Shapes::StructureShape.new(name: 'CancelBatchImportJobResult')
32
33
  CancelBatchPredictionJobRequest = Shapes::StructureShape.new(name: 'CancelBatchPredictionJobRequest')
@@ -94,11 +95,18 @@ module Aws::FraudDetector
94
95
  DetectorsMaxResults = Shapes::IntegerShape.new(name: 'DetectorsMaxResults')
95
96
  Entity = Shapes::StructureShape.new(name: 'Entity')
96
97
  EntityType = Shapes::StructureShape.new(name: 'EntityType')
98
+ EvaluatedExternalModel = Shapes::StructureShape.new(name: 'EvaluatedExternalModel')
99
+ EvaluatedModelVersion = Shapes::StructureShape.new(name: 'EvaluatedModelVersion')
100
+ EvaluatedRule = Shapes::StructureShape.new(name: 'EvaluatedRule')
101
+ EvaluatedRuleList = Shapes::ListShape.new(name: 'EvaluatedRuleList')
97
102
  Event = Shapes::StructureShape.new(name: 'Event')
98
103
  EventAttributeMap = Shapes::MapShape.new(name: 'EventAttributeMap')
99
104
  EventIngestion = Shapes::StringShape.new(name: 'EventIngestion')
105
+ EventPredictionSummary = Shapes::StructureShape.new(name: 'EventPredictionSummary')
106
+ EventPredictionsMaxResults = Shapes::IntegerShape.new(name: 'EventPredictionsMaxResults')
100
107
  EventType = Shapes::StructureShape.new(name: 'EventType')
101
108
  EventVariableMap = Shapes::MapShape.new(name: 'EventVariableMap')
109
+ EventVariableSummary = Shapes::StructureShape.new(name: 'EventVariableSummary')
102
110
  ExternalEventsDetail = Shapes::StructureShape.new(name: 'ExternalEventsDetail')
103
111
  ExternalModel = Shapes::StructureShape.new(name: 'ExternalModel')
104
112
  ExternalModelEndpointDataBlobMap = Shapes::MapShape.new(name: 'ExternalModelEndpointDataBlobMap')
@@ -109,6 +117,7 @@ module Aws::FraudDetector
109
117
  ExternalModelsMaxResults = Shapes::IntegerShape.new(name: 'ExternalModelsMaxResults')
110
118
  FieldValidationMessage = Shapes::StructureShape.new(name: 'FieldValidationMessage')
111
119
  FileValidationMessage = Shapes::StructureShape.new(name: 'FileValidationMessage')
120
+ FilterCondition = Shapes::StructureShape.new(name: 'FilterCondition')
112
121
  GetBatchImportJobsRequest = Shapes::StructureShape.new(name: 'GetBatchImportJobsRequest')
113
122
  GetBatchImportJobsResult = Shapes::StructureShape.new(name: 'GetBatchImportJobsResult')
114
123
  GetBatchPredictionJobsRequest = Shapes::StructureShape.new(name: 'GetBatchPredictionJobsRequest')
@@ -121,6 +130,8 @@ module Aws::FraudDetector
121
130
  GetDetectorsResult = Shapes::StructureShape.new(name: 'GetDetectorsResult')
122
131
  GetEntityTypesRequest = Shapes::StructureShape.new(name: 'GetEntityTypesRequest')
123
132
  GetEntityTypesResult = Shapes::StructureShape.new(name: 'GetEntityTypesResult')
133
+ GetEventPredictionMetadataRequest = Shapes::StructureShape.new(name: 'GetEventPredictionMetadataRequest')
134
+ GetEventPredictionMetadataResult = Shapes::StructureShape.new(name: 'GetEventPredictionMetadataResult')
124
135
  GetEventPredictionRequest = Shapes::StructureShape.new(name: 'GetEventPredictionRequest')
125
136
  GetEventPredictionResult = Shapes::StructureShape.new(name: 'GetEventPredictionResult')
126
137
  GetEventRequest = Shapes::StructureShape.new(name: 'GetEventRequest')
@@ -153,9 +164,16 @@ module Aws::FraudDetector
153
164
  Label = Shapes::StructureShape.new(name: 'Label')
154
165
  LabelSchema = Shapes::StructureShape.new(name: 'LabelSchema')
155
166
  Language = Shapes::StringShape.new(name: 'Language')
167
+ ListEventPredictionsRequest = Shapes::StructureShape.new(name: 'ListEventPredictionsRequest')
168
+ ListEventPredictionsResult = Shapes::StructureShape.new(name: 'ListEventPredictionsResult')
169
+ ListOfEvaluatedExternalModels = Shapes::ListShape.new(name: 'ListOfEvaluatedExternalModels')
170
+ ListOfEvaluatedModelVersions = Shapes::ListShape.new(name: 'ListOfEvaluatedModelVersions')
171
+ ListOfEventPredictionSummaries = Shapes::ListShape.new(name: 'ListOfEventPredictionSummaries')
172
+ ListOfEventVariableSummaries = Shapes::ListShape.new(name: 'ListOfEventVariableSummaries')
156
173
  ListOfExternalModelOutputs = Shapes::ListShape.new(name: 'ListOfExternalModelOutputs')
157
174
  ListOfLogOddsMetrics = Shapes::ListShape.new(name: 'ListOfLogOddsMetrics')
158
175
  ListOfModelScores = Shapes::ListShape.new(name: 'ListOfModelScores')
176
+ ListOfModelVersionEvaluations = Shapes::ListShape.new(name: 'ListOfModelVersionEvaluations')
159
177
  ListOfModelVersions = Shapes::ListShape.new(name: 'ListOfModelVersions')
160
178
  ListOfRuleResults = Shapes::ListShape.new(name: 'ListOfRuleResults')
161
179
  ListOfStrings = Shapes::ListShape.new(name: 'ListOfStrings')
@@ -163,6 +181,7 @@ module Aws::FraudDetector
163
181
  ListTagsForResourceResult = Shapes::StructureShape.new(name: 'ListTagsForResourceResult')
164
182
  LogOddsMetric = Shapes::StructureShape.new(name: 'LogOddsMetric')
165
183
  Long = Shapes::IntegerShape.new(name: 'Long')
184
+ MapOfStrings = Shapes::MapShape.new(name: 'MapOfStrings')
166
185
  MetricDataPoint = Shapes::StructureShape.new(name: 'MetricDataPoint')
167
186
  Model = Shapes::StructureShape.new(name: 'Model')
168
187
  ModelEndpointDataBlob = Shapes::StructureShape.new(name: 'ModelEndpointDataBlob')
@@ -177,12 +196,15 @@ module Aws::FraudDetector
177
196
  ModelTypeEnum = Shapes::StringShape.new(name: 'ModelTypeEnum')
178
197
  ModelVersion = Shapes::StructureShape.new(name: 'ModelVersion')
179
198
  ModelVersionDetail = Shapes::StructureShape.new(name: 'ModelVersionDetail')
199
+ ModelVersionEvaluation = Shapes::StructureShape.new(name: 'ModelVersionEvaluation')
180
200
  ModelVersionStatus = Shapes::StringShape.new(name: 'ModelVersionStatus')
181
201
  NameList = Shapes::ListShape.new(name: 'NameList')
182
202
  NonEmptyListOfStrings = Shapes::ListShape.new(name: 'NonEmptyListOfStrings')
183
203
  Outcome = Shapes::StructureShape.new(name: 'Outcome')
184
204
  OutcomeList = Shapes::ListShape.new(name: 'OutcomeList')
185
205
  OutcomesMaxResults = Shapes::IntegerShape.new(name: 'OutcomesMaxResults')
206
+ PredictionExplanations = Shapes::StructureShape.new(name: 'PredictionExplanations')
207
+ PredictionTimeRange = Shapes::StructureShape.new(name: 'PredictionTimeRange')
186
208
  PutDetectorRequest = Shapes::StructureShape.new(name: 'PutDetectorRequest')
187
209
  PutDetectorResult = Shapes::StructureShape.new(name: 'PutDetectorResult')
188
210
  PutEntityTypeRequest = Shapes::StructureShape.new(name: 'PutEntityTypeRequest')
@@ -245,6 +267,7 @@ module Aws::FraudDetector
245
267
  Variable = Shapes::StructureShape.new(name: 'Variable')
246
268
  VariableEntry = Shapes::StructureShape.new(name: 'VariableEntry')
247
269
  VariableEntryList = Shapes::ListShape.new(name: 'VariableEntryList')
270
+ VariableImpactExplanation = Shapes::StructureShape.new(name: 'VariableImpactExplanation')
248
271
  VariableImportanceMetrics = Shapes::StructureShape.new(name: 'VariableImportanceMetrics')
249
272
  VariableList = Shapes::ListShape.new(name: 'VariableList')
250
273
  VariablesMaxResults = Shapes::IntegerShape.new(name: 'VariablesMaxResults')
@@ -262,6 +285,7 @@ module Aws::FraudDetector
262
285
  eventTypesMaxResults = Shapes::IntegerShape.new(name: 'eventTypesMaxResults')
263
286
  fieldValidationMessageList = Shapes::ListShape.new(name: 'fieldValidationMessageList')
264
287
  fileValidationMessageList = Shapes::ListShape.new(name: 'fileValidationMessageList')
288
+ filterString = Shapes::StringShape.new(name: 'filterString')
265
289
  float = Shapes::FloatShape.new(name: 'float')
266
290
  floatVersionString = Shapes::StringShape.new(name: 'floatVersionString')
267
291
  fraudDetectorArn = Shapes::StringShape.new(name: 'fraudDetectorArn')
@@ -272,6 +296,7 @@ module Aws::FraudDetector
272
296
  labelMapper = Shapes::MapShape.new(name: 'labelMapper')
273
297
  labelsMaxResults = Shapes::IntegerShape.new(name: 'labelsMaxResults')
274
298
  listOfEntities = Shapes::ListShape.new(name: 'listOfEntities')
299
+ listOfVariableImpactExplanations = Shapes::ListShape.new(name: 'listOfVariableImpactExplanations')
275
300
  metricDataPointsList = Shapes::ListShape.new(name: 'metricDataPointsList')
276
301
  modelIdentifier = Shapes::StringShape.new(name: 'modelIdentifier')
277
302
  modelInputTemplate = Shapes::StringShape.new(name: 'modelInputTemplate')
@@ -281,6 +306,7 @@ module Aws::FraudDetector
281
306
  ruleExpression = Shapes::StringShape.new(name: 'ruleExpression')
282
307
  s3BucketLocation = Shapes::StringShape.new(name: 's3BucketLocation')
283
308
  sageMakerEndpointIdentifier = Shapes::StringShape.new(name: 'sageMakerEndpointIdentifier')
309
+ sensitiveString = Shapes::StringShape.new(name: 'sensitiveString')
284
310
  string = Shapes::StringShape.new(name: 'string')
285
311
  tagKey = Shapes::StringShape.new(name: 'tagKey')
286
312
  tagKeyList = Shapes::ListShape.new(name: 'tagKeyList')
@@ -596,6 +622,29 @@ module Aws::FraudDetector
596
622
  EntityType.add_member(:arn, Shapes::ShapeRef.new(shape: fraudDetectorArn, location_name: "arn"))
597
623
  EntityType.struct_class = Types::EntityType
598
624
 
625
+ EvaluatedExternalModel.add_member(:model_endpoint, Shapes::ShapeRef.new(shape: string, location_name: "modelEndpoint"))
626
+ EvaluatedExternalModel.add_member(:use_event_variables, Shapes::ShapeRef.new(shape: Boolean, location_name: "useEventVariables"))
627
+ EvaluatedExternalModel.add_member(:input_variables, Shapes::ShapeRef.new(shape: MapOfStrings, location_name: "inputVariables"))
628
+ EvaluatedExternalModel.add_member(:output_variables, Shapes::ShapeRef.new(shape: MapOfStrings, location_name: "outputVariables"))
629
+ EvaluatedExternalModel.struct_class = Types::EvaluatedExternalModel
630
+
631
+ EvaluatedModelVersion.add_member(:model_id, Shapes::ShapeRef.new(shape: string, location_name: "modelId"))
632
+ EvaluatedModelVersion.add_member(:model_version, Shapes::ShapeRef.new(shape: string, location_name: "modelVersion"))
633
+ EvaluatedModelVersion.add_member(:model_type, Shapes::ShapeRef.new(shape: string, location_name: "modelType"))
634
+ EvaluatedModelVersion.add_member(:evaluations, Shapes::ShapeRef.new(shape: ListOfModelVersionEvaluations, location_name: "evaluations"))
635
+ EvaluatedModelVersion.struct_class = Types::EvaluatedModelVersion
636
+
637
+ EvaluatedRule.add_member(:rule_id, Shapes::ShapeRef.new(shape: identifier, location_name: "ruleId"))
638
+ EvaluatedRule.add_member(:rule_version, Shapes::ShapeRef.new(shape: wholeNumberVersionString, location_name: "ruleVersion"))
639
+ EvaluatedRule.add_member(:expression, Shapes::ShapeRef.new(shape: sensitiveString, location_name: "expression"))
640
+ EvaluatedRule.add_member(:expression_with_values, Shapes::ShapeRef.new(shape: sensitiveString, location_name: "expressionWithValues"))
641
+ EvaluatedRule.add_member(:outcomes, Shapes::ShapeRef.new(shape: ListOfStrings, location_name: "outcomes"))
642
+ EvaluatedRule.add_member(:evaluated, Shapes::ShapeRef.new(shape: Boolean, location_name: "evaluated"))
643
+ EvaluatedRule.add_member(:matched, Shapes::ShapeRef.new(shape: Boolean, location_name: "matched"))
644
+ EvaluatedRule.struct_class = Types::EvaluatedRule
645
+
646
+ EvaluatedRuleList.member = Shapes::ShapeRef.new(shape: EvaluatedRule)
647
+
599
648
  Event.add_member(:event_id, Shapes::ShapeRef.new(shape: string, location_name: "eventId"))
600
649
  Event.add_member(:event_type_name, Shapes::ShapeRef.new(shape: string, location_name: "eventTypeName"))
601
650
  Event.add_member(:event_timestamp, Shapes::ShapeRef.new(shape: string, location_name: "eventTimestamp"))
@@ -608,6 +657,14 @@ module Aws::FraudDetector
608
657
  EventAttributeMap.key = Shapes::ShapeRef.new(shape: attributeKey)
609
658
  EventAttributeMap.value = Shapes::ShapeRef.new(shape: attributeValue)
610
659
 
660
+ EventPredictionSummary.add_member(:event_id, Shapes::ShapeRef.new(shape: identifier, location_name: "eventId"))
661
+ EventPredictionSummary.add_member(:event_type_name, Shapes::ShapeRef.new(shape: identifier, location_name: "eventTypeName"))
662
+ EventPredictionSummary.add_member(:event_timestamp, Shapes::ShapeRef.new(shape: time, location_name: "eventTimestamp"))
663
+ EventPredictionSummary.add_member(:prediction_timestamp, Shapes::ShapeRef.new(shape: time, location_name: "predictionTimestamp"))
664
+ EventPredictionSummary.add_member(:detector_id, Shapes::ShapeRef.new(shape: identifier, location_name: "detectorId"))
665
+ EventPredictionSummary.add_member(:detector_version_id, Shapes::ShapeRef.new(shape: wholeNumberVersionString, location_name: "detectorVersionId"))
666
+ EventPredictionSummary.struct_class = Types::EventPredictionSummary
667
+
611
668
  EventType.add_member(:name, Shapes::ShapeRef.new(shape: string, location_name: "name"))
612
669
  EventType.add_member(:description, Shapes::ShapeRef.new(shape: description, location_name: "description"))
613
670
  EventType.add_member(:event_variables, Shapes::ShapeRef.new(shape: ListOfStrings, location_name: "eventVariables"))
@@ -623,6 +680,11 @@ module Aws::FraudDetector
623
680
  EventVariableMap.key = Shapes::ShapeRef.new(shape: variableName)
624
681
  EventVariableMap.value = Shapes::ShapeRef.new(shape: variableValue)
625
682
 
683
+ EventVariableSummary.add_member(:name, Shapes::ShapeRef.new(shape: sensitiveString, location_name: "name"))
684
+ EventVariableSummary.add_member(:value, Shapes::ShapeRef.new(shape: sensitiveString, location_name: "value"))
685
+ EventVariableSummary.add_member(:source, Shapes::ShapeRef.new(shape: sensitiveString, location_name: "source"))
686
+ EventVariableSummary.struct_class = Types::EventVariableSummary
687
+
626
688
  ExternalEventsDetail.add_member(:data_location, Shapes::ShapeRef.new(shape: s3BucketLocation, required: true, location_name: "dataLocation"))
627
689
  ExternalEventsDetail.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: iamRoleArn, required: true, location_name: "dataAccessRoleArn"))
628
690
  ExternalEventsDetail.struct_class = Types::ExternalEventsDetail
@@ -666,6 +728,9 @@ module Aws::FraudDetector
666
728
  FileValidationMessage.add_member(:type, Shapes::ShapeRef.new(shape: string, location_name: "type"))
667
729
  FileValidationMessage.struct_class = Types::FileValidationMessage
668
730
 
731
+ FilterCondition.add_member(:value, Shapes::ShapeRef.new(shape: filterString, location_name: "value"))
732
+ FilterCondition.struct_class = Types::FilterCondition
733
+
669
734
  GetBatchImportJobsRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: identifier, location_name: "jobId"))
670
735
  GetBatchImportJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: batchImportsMaxPageSize, location_name: "maxResults"))
671
736
  GetBatchImportJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: string, location_name: "nextToken"))
@@ -726,6 +791,30 @@ module Aws::FraudDetector
726
791
  GetEntityTypesResult.add_member(:next_token, Shapes::ShapeRef.new(shape: string, location_name: "nextToken"))
727
792
  GetEntityTypesResult.struct_class = Types::GetEntityTypesResult
728
793
 
794
+ GetEventPredictionMetadataRequest.add_member(:event_id, Shapes::ShapeRef.new(shape: identifier, required: true, location_name: "eventId"))
795
+ GetEventPredictionMetadataRequest.add_member(:event_type_name, Shapes::ShapeRef.new(shape: identifier, required: true, location_name: "eventTypeName"))
796
+ GetEventPredictionMetadataRequest.add_member(:detector_id, Shapes::ShapeRef.new(shape: identifier, required: true, location_name: "detectorId"))
797
+ GetEventPredictionMetadataRequest.add_member(:detector_version_id, Shapes::ShapeRef.new(shape: wholeNumberVersionString, required: true, location_name: "detectorVersionId"))
798
+ GetEventPredictionMetadataRequest.add_member(:prediction_timestamp, Shapes::ShapeRef.new(shape: time, required: true, location_name: "predictionTimestamp"))
799
+ GetEventPredictionMetadataRequest.struct_class = Types::GetEventPredictionMetadataRequest
800
+
801
+ GetEventPredictionMetadataResult.add_member(:event_id, Shapes::ShapeRef.new(shape: identifier, location_name: "eventId"))
802
+ GetEventPredictionMetadataResult.add_member(:event_type_name, Shapes::ShapeRef.new(shape: identifier, location_name: "eventTypeName"))
803
+ GetEventPredictionMetadataResult.add_member(:entity_id, Shapes::ShapeRef.new(shape: string, location_name: "entityId"))
804
+ GetEventPredictionMetadataResult.add_member(:entity_type, Shapes::ShapeRef.new(shape: string, location_name: "entityType"))
805
+ GetEventPredictionMetadataResult.add_member(:event_timestamp, Shapes::ShapeRef.new(shape: time, location_name: "eventTimestamp"))
806
+ GetEventPredictionMetadataResult.add_member(:detector_id, Shapes::ShapeRef.new(shape: identifier, location_name: "detectorId"))
807
+ GetEventPredictionMetadataResult.add_member(:detector_version_id, Shapes::ShapeRef.new(shape: wholeNumberVersionString, location_name: "detectorVersionId"))
808
+ GetEventPredictionMetadataResult.add_member(:detector_version_status, Shapes::ShapeRef.new(shape: string, location_name: "detectorVersionStatus"))
809
+ GetEventPredictionMetadataResult.add_member(:event_variables, Shapes::ShapeRef.new(shape: ListOfEventVariableSummaries, location_name: "eventVariables"))
810
+ GetEventPredictionMetadataResult.add_member(:rules, Shapes::ShapeRef.new(shape: EvaluatedRuleList, location_name: "rules"))
811
+ GetEventPredictionMetadataResult.add_member(:rule_execution_mode, Shapes::ShapeRef.new(shape: RuleExecutionMode, location_name: "ruleExecutionMode"))
812
+ GetEventPredictionMetadataResult.add_member(:outcomes, Shapes::ShapeRef.new(shape: ListOfStrings, location_name: "outcomes"))
813
+ GetEventPredictionMetadataResult.add_member(:evaluated_model_versions, Shapes::ShapeRef.new(shape: ListOfEvaluatedModelVersions, location_name: "evaluatedModelVersions"))
814
+ GetEventPredictionMetadataResult.add_member(:evaluated_external_models, Shapes::ShapeRef.new(shape: ListOfEvaluatedExternalModels, location_name: "evaluatedExternalModels"))
815
+ GetEventPredictionMetadataResult.add_member(:prediction_timestamp, Shapes::ShapeRef.new(shape: time, location_name: "predictionTimestamp"))
816
+ GetEventPredictionMetadataResult.struct_class = Types::GetEventPredictionMetadataResult
817
+
729
818
  GetEventPredictionRequest.add_member(:detector_id, Shapes::ShapeRef.new(shape: string, required: true, location_name: "detectorId"))
730
819
  GetEventPredictionRequest.add_member(:detector_version_id, Shapes::ShapeRef.new(shape: wholeNumberVersionString, location_name: "detectorVersionId"))
731
820
  GetEventPredictionRequest.add_member(:event_id, Shapes::ShapeRef.new(shape: string, required: true, location_name: "eventId"))
@@ -867,12 +956,35 @@ module Aws::FraudDetector
867
956
  LabelSchema.add_member(:unlabeled_events_treatment, Shapes::ShapeRef.new(shape: UnlabeledEventsTreatment, location_name: "unlabeledEventsTreatment"))
868
957
  LabelSchema.struct_class = Types::LabelSchema
869
958
 
959
+ ListEventPredictionsRequest.add_member(:event_id, Shapes::ShapeRef.new(shape: FilterCondition, location_name: "eventId"))
960
+ ListEventPredictionsRequest.add_member(:event_type, Shapes::ShapeRef.new(shape: FilterCondition, location_name: "eventType"))
961
+ ListEventPredictionsRequest.add_member(:detector_id, Shapes::ShapeRef.new(shape: FilterCondition, location_name: "detectorId"))
962
+ ListEventPredictionsRequest.add_member(:detector_version_id, Shapes::ShapeRef.new(shape: FilterCondition, location_name: "detectorVersionId"))
963
+ ListEventPredictionsRequest.add_member(:prediction_time_range, Shapes::ShapeRef.new(shape: PredictionTimeRange, location_name: "predictionTimeRange"))
964
+ ListEventPredictionsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: string, location_name: "nextToken"))
965
+ ListEventPredictionsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: EventPredictionsMaxResults, location_name: "maxResults"))
966
+ ListEventPredictionsRequest.struct_class = Types::ListEventPredictionsRequest
967
+
968
+ ListEventPredictionsResult.add_member(:event_prediction_summaries, Shapes::ShapeRef.new(shape: ListOfEventPredictionSummaries, location_name: "eventPredictionSummaries"))
969
+ ListEventPredictionsResult.add_member(:next_token, Shapes::ShapeRef.new(shape: string, location_name: "nextToken"))
970
+ ListEventPredictionsResult.struct_class = Types::ListEventPredictionsResult
971
+
972
+ ListOfEvaluatedExternalModels.member = Shapes::ShapeRef.new(shape: EvaluatedExternalModel)
973
+
974
+ ListOfEvaluatedModelVersions.member = Shapes::ShapeRef.new(shape: EvaluatedModelVersion)
975
+
976
+ ListOfEventPredictionSummaries.member = Shapes::ShapeRef.new(shape: EventPredictionSummary)
977
+
978
+ ListOfEventVariableSummaries.member = Shapes::ShapeRef.new(shape: EventVariableSummary)
979
+
870
980
  ListOfExternalModelOutputs.member = Shapes::ShapeRef.new(shape: ExternalModelOutputs)
871
981
 
872
982
  ListOfLogOddsMetrics.member = Shapes::ShapeRef.new(shape: LogOddsMetric)
873
983
 
874
984
  ListOfModelScores.member = Shapes::ShapeRef.new(shape: ModelScores)
875
985
 
986
+ ListOfModelVersionEvaluations.member = Shapes::ShapeRef.new(shape: ModelVersionEvaluation)
987
+
876
988
  ListOfModelVersions.member = Shapes::ShapeRef.new(shape: ModelVersion)
877
989
 
878
990
  ListOfRuleResults.member = Shapes::ShapeRef.new(shape: RuleResult)
@@ -893,6 +1005,9 @@ module Aws::FraudDetector
893
1005
  LogOddsMetric.add_member(:variable_importance, Shapes::ShapeRef.new(shape: float, required: true, location_name: "variableImportance"))
894
1006
  LogOddsMetric.struct_class = Types::LogOddsMetric
895
1007
 
1008
+ MapOfStrings.key = Shapes::ShapeRef.new(shape: string)
1009
+ MapOfStrings.value = Shapes::ShapeRef.new(shape: string)
1010
+
896
1011
  MetricDataPoint.add_member(:fpr, Shapes::ShapeRef.new(shape: float, location_name: "fpr"))
897
1012
  MetricDataPoint.add_member(:precision, Shapes::ShapeRef.new(shape: float, location_name: "precision"))
898
1013
  MetricDataPoint.add_member(:tpr, Shapes::ShapeRef.new(shape: float, location_name: "tpr"))
@@ -951,6 +1066,11 @@ module Aws::FraudDetector
951
1066
  ModelVersionDetail.add_member(:arn, Shapes::ShapeRef.new(shape: fraudDetectorArn, location_name: "arn"))
952
1067
  ModelVersionDetail.struct_class = Types::ModelVersionDetail
953
1068
 
1069
+ ModelVersionEvaluation.add_member(:output_variable_name, Shapes::ShapeRef.new(shape: string, location_name: "outputVariableName"))
1070
+ ModelVersionEvaluation.add_member(:evaluation_score, Shapes::ShapeRef.new(shape: string, location_name: "evaluationScore"))
1071
+ ModelVersionEvaluation.add_member(:prediction_explanations, Shapes::ShapeRef.new(shape: PredictionExplanations, location_name: "predictionExplanations"))
1072
+ ModelVersionEvaluation.struct_class = Types::ModelVersionEvaluation
1073
+
954
1074
  NameList.member = Shapes::ShapeRef.new(shape: string)
955
1075
 
956
1076
  NonEmptyListOfStrings.member = Shapes::ShapeRef.new(shape: string)
@@ -964,6 +1084,13 @@ module Aws::FraudDetector
964
1084
 
965
1085
  OutcomeList.member = Shapes::ShapeRef.new(shape: Outcome)
966
1086
 
1087
+ PredictionExplanations.add_member(:variable_impact_explanations, Shapes::ShapeRef.new(shape: listOfVariableImpactExplanations, location_name: "variableImpactExplanations"))
1088
+ PredictionExplanations.struct_class = Types::PredictionExplanations
1089
+
1090
+ PredictionTimeRange.add_member(:start_time, Shapes::ShapeRef.new(shape: time, required: true, location_name: "startTime"))
1091
+ PredictionTimeRange.add_member(:end_time, Shapes::ShapeRef.new(shape: time, required: true, location_name: "endTime"))
1092
+ PredictionTimeRange.struct_class = Types::PredictionTimeRange
1093
+
967
1094
  PutDetectorRequest.add_member(:detector_id, Shapes::ShapeRef.new(shape: identifier, required: true, location_name: "detectorId"))
968
1095
  PutDetectorRequest.add_member(:description, Shapes::ShapeRef.new(shape: description, location_name: "description"))
969
1096
  PutDetectorRequest.add_member(:event_type_name, Shapes::ShapeRef.new(shape: identifier, required: true, location_name: "eventTypeName"))
@@ -1205,6 +1332,11 @@ module Aws::FraudDetector
1205
1332
 
1206
1333
  VariableEntryList.member = Shapes::ShapeRef.new(shape: VariableEntry)
1207
1334
 
1335
+ VariableImpactExplanation.add_member(:event_variable_name, Shapes::ShapeRef.new(shape: string, location_name: "eventVariableName"))
1336
+ VariableImpactExplanation.add_member(:relative_impact, Shapes::ShapeRef.new(shape: string, location_name: "relativeImpact"))
1337
+ VariableImpactExplanation.add_member(:log_odds_impact, Shapes::ShapeRef.new(shape: float, location_name: "logOddsImpact"))
1338
+ VariableImpactExplanation.struct_class = Types::VariableImpactExplanation
1339
+
1208
1340
  VariableImportanceMetrics.add_member(:log_odds_metrics, Shapes::ShapeRef.new(shape: ListOfLogOddsMetrics, location_name: "logOddsMetrics"))
1209
1341
  VariableImportanceMetrics.struct_class = Types::VariableImportanceMetrics
1210
1342
 
@@ -1225,6 +1357,8 @@ module Aws::FraudDetector
1225
1357
 
1226
1358
  listOfEntities.member = Shapes::ShapeRef.new(shape: Entity)
1227
1359
 
1360
+ listOfVariableImpactExplanations.member = Shapes::ShapeRef.new(shape: VariableImpactExplanation)
1361
+
1228
1362
  metricDataPointsList.member = Shapes::ShapeRef.new(shape: MetricDataPoint)
1229
1363
 
1230
1364
  modelList.member = Shapes::ShapeRef.new(shape: Model)
@@ -1746,6 +1880,19 @@ module Aws::FraudDetector
1746
1880
  o.errors << Shapes::ShapeRef.new(shape: ResourceUnavailableException)
1747
1881
  end)
1748
1882
 
1883
+ api.add_operation(:get_event_prediction_metadata, Seahorse::Model::Operation.new.tap do |o|
1884
+ o.name = "GetEventPredictionMetadata"
1885
+ o.http_method = "POST"
1886
+ o.http_request_uri = "/"
1887
+ o.input = Shapes::ShapeRef.new(shape: GetEventPredictionMetadataRequest)
1888
+ o.output = Shapes::ShapeRef.new(shape: GetEventPredictionMetadataResult)
1889
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
1890
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1891
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
1892
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
1893
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
1894
+ end)
1895
+
1749
1896
  api.add_operation(:get_event_types, Seahorse::Model::Operation.new.tap do |o|
1750
1897
  o.name = "GetEventTypes"
1751
1898
  o.http_method = "POST"
@@ -1904,6 +2051,24 @@ module Aws::FraudDetector
1904
2051
  )
1905
2052
  end)
1906
2053
 
2054
+ api.add_operation(:list_event_predictions, Seahorse::Model::Operation.new.tap do |o|
2055
+ o.name = "ListEventPredictions"
2056
+ o.http_method = "POST"
2057
+ o.http_request_uri = "/"
2058
+ o.input = Shapes::ShapeRef.new(shape: ListEventPredictionsRequest)
2059
+ o.output = Shapes::ShapeRef.new(shape: ListEventPredictionsResult)
2060
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
2061
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
2062
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
2063
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
2064
+ o[:pager] = Aws::Pager.new(
2065
+ limit_key: "max_results",
2066
+ tokens: {
2067
+ "next_token" => "next_token"
2068
+ }
2069
+ )
2070
+ end)
2071
+
1907
2072
  api.add_operation(:list_tags_for_resource, Seahorse::Model::Operation.new.tap do |o|
1908
2073
  o.name = "ListTagsForResource"
1909
2074
  o.http_method = "POST"
@@ -1597,6 +1597,112 @@ module Aws::FraudDetector
1597
1597
  include Aws::Structure
1598
1598
  end
1599
1599
 
1600
+ # The details of the external (Amazon Sagemaker) model evaluated for
1601
+ # generating predictions.
1602
+ #
1603
+ # @!attribute [rw] model_endpoint
1604
+ # The endpoint of the external (Amazon Sagemaker) model.
1605
+ # @return [String]
1606
+ #
1607
+ # @!attribute [rw] use_event_variables
1608
+ # Indicates whether event variables were used to generate predictions.
1609
+ # @return [Boolean]
1610
+ #
1611
+ # @!attribute [rw] input_variables
1612
+ # Input variables use for generating predictions.
1613
+ # @return [Hash<String,String>]
1614
+ #
1615
+ # @!attribute [rw] output_variables
1616
+ # Output variables.
1617
+ # @return [Hash<String,String>]
1618
+ #
1619
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/EvaluatedExternalModel AWS API Documentation
1620
+ #
1621
+ class EvaluatedExternalModel < Struct.new(
1622
+ :model_endpoint,
1623
+ :use_event_variables,
1624
+ :input_variables,
1625
+ :output_variables)
1626
+ SENSITIVE = [:input_variables, :output_variables]
1627
+ include Aws::Structure
1628
+ end
1629
+
1630
+ # The model version evaluated for generating prediction.
1631
+ #
1632
+ # @!attribute [rw] model_id
1633
+ # The model ID.
1634
+ # @return [String]
1635
+ #
1636
+ # @!attribute [rw] model_version
1637
+ # The model version.
1638
+ # @return [String]
1639
+ #
1640
+ # @!attribute [rw] model_type
1641
+ # The model type.
1642
+ #
1643
+ # Valid values: `ONLINE_FRAUD_INSIGHTS` \|
1644
+ # `TRANSACTION_FRAUD_INSIGHTS`
1645
+ # @return [String]
1646
+ #
1647
+ # @!attribute [rw] evaluations
1648
+ # Evaluations generated for the model version.
1649
+ # @return [Array<Types::ModelVersionEvaluation>]
1650
+ #
1651
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/EvaluatedModelVersion AWS API Documentation
1652
+ #
1653
+ class EvaluatedModelVersion < Struct.new(
1654
+ :model_id,
1655
+ :model_version,
1656
+ :model_type,
1657
+ :evaluations)
1658
+ SENSITIVE = []
1659
+ include Aws::Structure
1660
+ end
1661
+
1662
+ # The details of the rule used for evaluating variable values.
1663
+ #
1664
+ # @!attribute [rw] rule_id
1665
+ # The rule ID.
1666
+ # @return [String]
1667
+ #
1668
+ # @!attribute [rw] rule_version
1669
+ # The rule version.
1670
+ # @return [String]
1671
+ #
1672
+ # @!attribute [rw] expression
1673
+ # The rule expression.
1674
+ # @return [String]
1675
+ #
1676
+ # @!attribute [rw] expression_with_values
1677
+ # The rule expression value.
1678
+ # @return [String]
1679
+ #
1680
+ # @!attribute [rw] outcomes
1681
+ # The rule outcome.
1682
+ # @return [Array<String>]
1683
+ #
1684
+ # @!attribute [rw] evaluated
1685
+ # Indicates whether the rule was evaluated.
1686
+ # @return [Boolean]
1687
+ #
1688
+ # @!attribute [rw] matched
1689
+ # Indicates whether the rule matched.
1690
+ # @return [Boolean]
1691
+ #
1692
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/EvaluatedRule AWS API Documentation
1693
+ #
1694
+ class EvaluatedRule < Struct.new(
1695
+ :rule_id,
1696
+ :rule_version,
1697
+ :expression,
1698
+ :expression_with_values,
1699
+ :outcomes,
1700
+ :evaluated,
1701
+ :matched)
1702
+ SENSITIVE = [:expression, :expression_with_values]
1703
+ include Aws::Structure
1704
+ end
1705
+
1600
1706
  # The event details.
1601
1707
  #
1602
1708
  # @!attribute [rw] event_id
@@ -1645,6 +1751,45 @@ module Aws::FraudDetector
1645
1751
  include Aws::Structure
1646
1752
  end
1647
1753
 
1754
+ # Information about the summary of an event prediction.
1755
+ #
1756
+ # @!attribute [rw] event_id
1757
+ # The event ID.
1758
+ # @return [String]
1759
+ #
1760
+ # @!attribute [rw] event_type_name
1761
+ # The event type.
1762
+ # @return [String]
1763
+ #
1764
+ # @!attribute [rw] event_timestamp
1765
+ # The timestamp of the event.
1766
+ # @return [String]
1767
+ #
1768
+ # @!attribute [rw] prediction_timestamp
1769
+ # The timestamp when the prediction was generated.
1770
+ # @return [String]
1771
+ #
1772
+ # @!attribute [rw] detector_id
1773
+ # The detector ID.
1774
+ # @return [String]
1775
+ #
1776
+ # @!attribute [rw] detector_version_id
1777
+ # The detector version ID.
1778
+ # @return [String]
1779
+ #
1780
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/EventPredictionSummary AWS API Documentation
1781
+ #
1782
+ class EventPredictionSummary < Struct.new(
1783
+ :event_id,
1784
+ :event_type_name,
1785
+ :event_timestamp,
1786
+ :prediction_timestamp,
1787
+ :detector_id,
1788
+ :detector_version_id)
1789
+ SENSITIVE = []
1790
+ include Aws::Structure
1791
+ end
1792
+
1648
1793
  # The event type details.
1649
1794
  #
1650
1795
  # @!attribute [rw] name
@@ -1708,6 +1853,31 @@ module Aws::FraudDetector
1708
1853
  include Aws::Structure
1709
1854
  end
1710
1855
 
1856
+ # Information about the summary of an event variable that was evaluated
1857
+ # for generating prediction.
1858
+ #
1859
+ # @!attribute [rw] name
1860
+ # The event variable name.
1861
+ # @return [String]
1862
+ #
1863
+ # @!attribute [rw] value
1864
+ # The value of the event variable.
1865
+ # @return [String]
1866
+ #
1867
+ # @!attribute [rw] source
1868
+ # The event variable source.
1869
+ # @return [String]
1870
+ #
1871
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/EventVariableSummary AWS API Documentation
1872
+ #
1873
+ class EventVariableSummary < Struct.new(
1874
+ :name,
1875
+ :value,
1876
+ :source)
1877
+ SENSITIVE = [:name, :value, :source]
1878
+ include Aws::Structure
1879
+ end
1880
+
1711
1881
  # Details for the external events data used for model version training.
1712
1882
  #
1713
1883
  # @note When making an API call, you may pass ExternalEventsDetail
@@ -1886,6 +2056,28 @@ module Aws::FraudDetector
1886
2056
  include Aws::Structure
1887
2057
  end
1888
2058
 
2059
+ # A conditional statement for filtering a list of past predictions.
2060
+ #
2061
+ # @note When making an API call, you may pass FilterCondition
2062
+ # data as a hash:
2063
+ #
2064
+ # {
2065
+ # value: "filterString",
2066
+ # }
2067
+ #
2068
+ # @!attribute [rw] value
2069
+ # A statement containing a resource property and a value to specify
2070
+ # filter condition.
2071
+ # @return [String]
2072
+ #
2073
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/FilterCondition AWS API Documentation
2074
+ #
2075
+ class FilterCondition < Struct.new(
2076
+ :value)
2077
+ SENSITIVE = []
2078
+ include Aws::Structure
2079
+ end
2080
+
1889
2081
  # @note When making an API call, you may pass GetBatchImportJobsRequest
1890
2082
  # data as a hash:
1891
2083
  #
@@ -2212,6 +2404,136 @@ module Aws::FraudDetector
2212
2404
  include Aws::Structure
2213
2405
  end
2214
2406
 
2407
+ # @note When making an API call, you may pass GetEventPredictionMetadataRequest
2408
+ # data as a hash:
2409
+ #
2410
+ # {
2411
+ # event_id: "identifier", # required
2412
+ # event_type_name: "identifier", # required
2413
+ # detector_id: "identifier", # required
2414
+ # detector_version_id: "wholeNumberVersionString", # required
2415
+ # prediction_timestamp: "time", # required
2416
+ # }
2417
+ #
2418
+ # @!attribute [rw] event_id
2419
+ # The event ID.
2420
+ # @return [String]
2421
+ #
2422
+ # @!attribute [rw] event_type_name
2423
+ # The event type associated with the detector specified for the
2424
+ # prediction.
2425
+ # @return [String]
2426
+ #
2427
+ # @!attribute [rw] detector_id
2428
+ # The detector ID.
2429
+ # @return [String]
2430
+ #
2431
+ # @!attribute [rw] detector_version_id
2432
+ # The detector version ID.
2433
+ # @return [String]
2434
+ #
2435
+ # @!attribute [rw] prediction_timestamp
2436
+ # The timestamp that defines when the prediction was generated.
2437
+ # @return [String]
2438
+ #
2439
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventPredictionMetadataRequest AWS API Documentation
2440
+ #
2441
+ class GetEventPredictionMetadataRequest < Struct.new(
2442
+ :event_id,
2443
+ :event_type_name,
2444
+ :detector_id,
2445
+ :detector_version_id,
2446
+ :prediction_timestamp)
2447
+ SENSITIVE = []
2448
+ include Aws::Structure
2449
+ end
2450
+
2451
+ # @!attribute [rw] event_id
2452
+ # The event ID.
2453
+ # @return [String]
2454
+ #
2455
+ # @!attribute [rw] event_type_name
2456
+ # The event type associated with the detector specified for this
2457
+ # prediction.
2458
+ # @return [String]
2459
+ #
2460
+ # @!attribute [rw] entity_id
2461
+ # The entity ID.
2462
+ # @return [String]
2463
+ #
2464
+ # @!attribute [rw] entity_type
2465
+ # The entity type.
2466
+ # @return [String]
2467
+ #
2468
+ # @!attribute [rw] event_timestamp
2469
+ # The timestamp for when the prediction was generated for the
2470
+ # associated event ID.
2471
+ # @return [String]
2472
+ #
2473
+ # @!attribute [rw] detector_id
2474
+ # The detector ID.
2475
+ # @return [String]
2476
+ #
2477
+ # @!attribute [rw] detector_version_id
2478
+ # The detector version ID.
2479
+ # @return [String]
2480
+ #
2481
+ # @!attribute [rw] detector_version_status
2482
+ # The status of the detector version.
2483
+ # @return [String]
2484
+ #
2485
+ # @!attribute [rw] event_variables
2486
+ # A list of event variables that influenced the prediction scores.
2487
+ # @return [Array<Types::EventVariableSummary>]
2488
+ #
2489
+ # @!attribute [rw] rules
2490
+ # List of rules associated with the detector version that were used
2491
+ # for evaluating variable values.
2492
+ # @return [Array<Types::EvaluatedRule>]
2493
+ #
2494
+ # @!attribute [rw] rule_execution_mode
2495
+ # The execution mode of the rule used for evaluating variable values.
2496
+ # @return [String]
2497
+ #
2498
+ # @!attribute [rw] outcomes
2499
+ # The outcomes of the matched rule, based on the rule execution mode.
2500
+ # @return [Array<String>]
2501
+ #
2502
+ # @!attribute [rw] evaluated_model_versions
2503
+ # Model versions that were evaluated for generating predictions.
2504
+ # @return [Array<Types::EvaluatedModelVersion>]
2505
+ #
2506
+ # @!attribute [rw] evaluated_external_models
2507
+ # External (Amazon SageMaker) models that were evaluated for
2508
+ # generating predictions.
2509
+ # @return [Array<Types::EvaluatedExternalModel>]
2510
+ #
2511
+ # @!attribute [rw] prediction_timestamp
2512
+ # The timestamp that defines when the prediction was generated.
2513
+ # @return [String]
2514
+ #
2515
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventPredictionMetadataResult AWS API Documentation
2516
+ #
2517
+ class GetEventPredictionMetadataResult < Struct.new(
2518
+ :event_id,
2519
+ :event_type_name,
2520
+ :entity_id,
2521
+ :entity_type,
2522
+ :event_timestamp,
2523
+ :detector_id,
2524
+ :detector_version_id,
2525
+ :detector_version_status,
2526
+ :event_variables,
2527
+ :rules,
2528
+ :rule_execution_mode,
2529
+ :outcomes,
2530
+ :evaluated_model_versions,
2531
+ :evaluated_external_models,
2532
+ :prediction_timestamp)
2533
+ SENSITIVE = []
2534
+ include Aws::Structure
2535
+ end
2536
+
2215
2537
  # @note When making an API call, you may pass GetEventPredictionRequest
2216
2538
  # data as a hash:
2217
2539
  #
@@ -3032,6 +3354,93 @@ module Aws::FraudDetector
3032
3354
  include Aws::Structure
3033
3355
  end
3034
3356
 
3357
+ # @note When making an API call, you may pass ListEventPredictionsRequest
3358
+ # data as a hash:
3359
+ #
3360
+ # {
3361
+ # event_id: {
3362
+ # value: "filterString",
3363
+ # },
3364
+ # event_type: {
3365
+ # value: "filterString",
3366
+ # },
3367
+ # detector_id: {
3368
+ # value: "filterString",
3369
+ # },
3370
+ # detector_version_id: {
3371
+ # value: "filterString",
3372
+ # },
3373
+ # prediction_time_range: {
3374
+ # start_time: "time", # required
3375
+ # end_time: "time", # required
3376
+ # },
3377
+ # next_token: "string",
3378
+ # max_results: 1,
3379
+ # }
3380
+ #
3381
+ # @!attribute [rw] event_id
3382
+ # The event ID.
3383
+ # @return [Types::FilterCondition]
3384
+ #
3385
+ # @!attribute [rw] event_type
3386
+ # The event type associated with the detector.
3387
+ # @return [Types::FilterCondition]
3388
+ #
3389
+ # @!attribute [rw] detector_id
3390
+ # The detector ID.
3391
+ # @return [Types::FilterCondition]
3392
+ #
3393
+ # @!attribute [rw] detector_version_id
3394
+ # The detector version ID.
3395
+ # @return [Types::FilterCondition]
3396
+ #
3397
+ # @!attribute [rw] prediction_time_range
3398
+ # The time period for when the predictions were generated.
3399
+ # @return [Types::PredictionTimeRange]
3400
+ #
3401
+ # @!attribute [rw] next_token
3402
+ # Identifies the next page of results to return. Use the token to make
3403
+ # the call again to retrieve the next page. Keep all other arguments
3404
+ # unchanged. Each pagination token expires after 24 hours.
3405
+ # @return [String]
3406
+ #
3407
+ # @!attribute [rw] max_results
3408
+ # The maximum number of predictions to return for the request.
3409
+ # @return [Integer]
3410
+ #
3411
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ListEventPredictionsRequest AWS API Documentation
3412
+ #
3413
+ class ListEventPredictionsRequest < Struct.new(
3414
+ :event_id,
3415
+ :event_type,
3416
+ :detector_id,
3417
+ :detector_version_id,
3418
+ :prediction_time_range,
3419
+ :next_token,
3420
+ :max_results)
3421
+ SENSITIVE = []
3422
+ include Aws::Structure
3423
+ end
3424
+
3425
+ # @!attribute [rw] event_prediction_summaries
3426
+ # The summary of the past predictions.
3427
+ # @return [Array<Types::EventPredictionSummary>]
3428
+ #
3429
+ # @!attribute [rw] next_token
3430
+ # Identifies the next page of results to return. Use the token to make
3431
+ # the call again to retrieve the next page. Keep all other arguments
3432
+ # unchanged. Each pagination token expires after 24 hours.
3433
+ # @return [String]
3434
+ #
3435
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ListEventPredictionsResult AWS API Documentation
3436
+ #
3437
+ class ListEventPredictionsResult < Struct.new(
3438
+ :event_prediction_summaries,
3439
+ :next_token)
3440
+ SENSITIVE = []
3441
+ include Aws::Structure
3442
+ end
3443
+
3035
3444
  # @note When making an API call, you may pass ListTagsForResourceRequest
3036
3445
  # data as a hash:
3037
3446
  #
@@ -3441,6 +3850,30 @@ module Aws::FraudDetector
3441
3850
  include Aws::Structure
3442
3851
  end
3443
3852
 
3853
+ # The model version evalutions.
3854
+ #
3855
+ # @!attribute [rw] output_variable_name
3856
+ # The output variable name.
3857
+ # @return [String]
3858
+ #
3859
+ # @!attribute [rw] evaluation_score
3860
+ # The evaluation score generated for the model version.
3861
+ # @return [String]
3862
+ #
3863
+ # @!attribute [rw] prediction_explanations
3864
+ # The prediction explanations generated for the model version.
3865
+ # @return [Types::PredictionExplanations]
3866
+ #
3867
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ModelVersionEvaluation AWS API Documentation
3868
+ #
3869
+ class ModelVersionEvaluation < Struct.new(
3870
+ :output_variable_name,
3871
+ :evaluation_score,
3872
+ :prediction_explanations)
3873
+ SENSITIVE = []
3874
+ include Aws::Structure
3875
+ end
3876
+
3444
3877
  # The outcome.
3445
3878
  #
3446
3879
  # @!attribute [rw] name
@@ -3475,6 +3908,50 @@ module Aws::FraudDetector
3475
3908
  include Aws::Structure
3476
3909
  end
3477
3910
 
3911
+ # The prediction explanations that provide insight into how each event
3912
+ # variable impacted the model version's fraud prediction score.
3913
+ #
3914
+ # @!attribute [rw] variable_impact_explanations
3915
+ # The details of the event variable's impact on the prediction score.
3916
+ # @return [Array<Types::VariableImpactExplanation>]
3917
+ #
3918
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PredictionExplanations AWS API Documentation
3919
+ #
3920
+ class PredictionExplanations < Struct.new(
3921
+ :variable_impact_explanations)
3922
+ SENSITIVE = []
3923
+ include Aws::Structure
3924
+ end
3925
+
3926
+ # The time period for when the predictions were generated.
3927
+ #
3928
+ # @note When making an API call, you may pass PredictionTimeRange
3929
+ # data as a hash:
3930
+ #
3931
+ # {
3932
+ # start_time: "time", # required
3933
+ # end_time: "time", # required
3934
+ # }
3935
+ #
3936
+ # @!attribute [rw] start_time
3937
+ # The start time of the time period for when the predictions were
3938
+ # generated.
3939
+ # @return [String]
3940
+ #
3941
+ # @!attribute [rw] end_time
3942
+ # The end time of the time period for when the predictions were
3943
+ # generated.
3944
+ # @return [String]
3945
+ #
3946
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/PredictionTimeRange AWS API Documentation
3947
+ #
3948
+ class PredictionTimeRange < Struct.new(
3949
+ :start_time,
3950
+ :end_time)
3951
+ SENSITIVE = []
3952
+ include Aws::Structure
3953
+ end
3954
+
3478
3955
  # @note When making an API call, you may pass PutDetectorRequest
3479
3956
  # data as a hash:
3480
3957
  #
@@ -4857,6 +5334,41 @@ module Aws::FraudDetector
4857
5334
  include Aws::Structure
4858
5335
  end
4859
5336
 
5337
+ # The details of the event variable's impact on the prediction score.
5338
+ #
5339
+ # @!attribute [rw] event_variable_name
5340
+ # The event variable name.
5341
+ # @return [String]
5342
+ #
5343
+ # @!attribute [rw] relative_impact
5344
+ # The event variable's relative impact in terms of magnitude on the
5345
+ # prediction scores. The relative impact values consist of a numerical
5346
+ # rating (0-5, 5 being the highest) and direction
5347
+ # (increased/decreased) impact of the fraud risk.
5348
+ # @return [String]
5349
+ #
5350
+ # @!attribute [rw] log_odds_impact
5351
+ # The raw, uninterpreted value represented as log-odds of the fraud.
5352
+ # These values are usually between -10 to +10, but range from -
5353
+ # infinity to + infinity.
5354
+ #
5355
+ # * A positive value indicates that the variable drove the risk score
5356
+ # up.
5357
+ #
5358
+ # * A negative value indicates that the variable drove the risk score
5359
+ # down.
5360
+ # @return [Float]
5361
+ #
5362
+ # @see http://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/VariableImpactExplanation AWS API Documentation
5363
+ #
5364
+ class VariableImpactExplanation < Struct.new(
5365
+ :event_variable_name,
5366
+ :relative_impact,
5367
+ :log_odds_impact)
5368
+ SENSITIVE = []
5369
+ include Aws::Structure
5370
+ end
5371
+
4860
5372
  # The variable importance metrics details.
4861
5373
  #
4862
5374
  # @!attribute [rw] log_odds_metrics
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-frauddetector/customizations'
48
48
  # @!group service
49
49
  module Aws::FraudDetector
50
50
 
51
- GEM_VERSION = '1.29.0'
51
+ GEM_VERSION = '1.30.0'
52
52
 
53
53
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-frauddetector
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.29.0
4
+ version: 1.30.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-12-21 00:00:00.000000000 Z
11
+ date: 2022-01-26 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core