@aws-sdk/client-frauddetector 3.325.0 → 3.326.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.
Files changed (74) hide show
  1. package/dist-types/commands/BatchCreateVariableCommand.d.ts +12 -0
  2. package/dist-types/commands/BatchGetVariableCommand.d.ts +25 -0
  3. package/dist-types/commands/CancelBatchImportJobCommand.d.ts +4 -0
  4. package/dist-types/commands/CancelBatchPredictionJobCommand.d.ts +4 -0
  5. package/dist-types/commands/CreateBatchImportJobCommand.d.ts +4 -0
  6. package/dist-types/commands/CreateBatchPredictionJobCommand.d.ts +4 -0
  7. package/dist-types/commands/CreateDetectorVersionCommand.d.ts +8 -0
  8. package/dist-types/commands/CreateListCommand.d.ts +4 -0
  9. package/dist-types/commands/CreateModelCommand.d.ts +4 -0
  10. package/dist-types/commands/CreateModelVersionCommand.d.ts +9 -0
  11. package/dist-types/commands/CreateRuleCommand.d.ts +10 -0
  12. package/dist-types/commands/CreateVariableCommand.d.ts +4 -0
  13. package/dist-types/commands/DeleteBatchImportJobCommand.d.ts +4 -0
  14. package/dist-types/commands/DeleteBatchPredictionJobCommand.d.ts +4 -0
  15. package/dist-types/commands/DeleteDetectorCommand.d.ts +4 -0
  16. package/dist-types/commands/DeleteDetectorVersionCommand.d.ts +4 -0
  17. package/dist-types/commands/DeleteEntityTypeCommand.d.ts +4 -0
  18. package/dist-types/commands/DeleteEventCommand.d.ts +4 -0
  19. package/dist-types/commands/DeleteEventTypeCommand.d.ts +4 -0
  20. package/dist-types/commands/DeleteEventsByEventTypeCommand.d.ts +7 -0
  21. package/dist-types/commands/DeleteExternalModelCommand.d.ts +4 -0
  22. package/dist-types/commands/DeleteLabelCommand.d.ts +4 -0
  23. package/dist-types/commands/DeleteListCommand.d.ts +4 -0
  24. package/dist-types/commands/DeleteModelCommand.d.ts +4 -0
  25. package/dist-types/commands/DeleteModelVersionCommand.d.ts +4 -0
  26. package/dist-types/commands/DeleteOutcomeCommand.d.ts +4 -0
  27. package/dist-types/commands/DeleteRuleCommand.d.ts +4 -0
  28. package/dist-types/commands/DeleteVariableCommand.d.ts +4 -0
  29. package/dist-types/commands/DescribeDetectorCommand.d.ts +16 -0
  30. package/dist-types/commands/DescribeModelVersionsCommand.d.ts +167 -0
  31. package/dist-types/commands/GetBatchImportJobsCommand.d.ts +23 -0
  32. package/dist-types/commands/GetBatchPredictionJobsCommand.d.ts +25 -0
  33. package/dist-types/commands/GetDeleteEventsByEventTypeStatusCommand.d.ts +7 -0
  34. package/dist-types/commands/GetDetectorVersionCommand.d.ts +31 -0
  35. package/dist-types/commands/GetDetectorsCommand.d.ts +16 -0
  36. package/dist-types/commands/GetEntityTypesCommand.d.ts +15 -0
  37. package/dist-types/commands/GetEventCommand.d.ts +21 -0
  38. package/dist-types/commands/GetEventPredictionCommand.d.ts +37 -0
  39. package/dist-types/commands/GetEventPredictionMetadataCommand.d.ts +79 -0
  40. package/dist-types/commands/GetEventTypesCommand.d.ts +32 -0
  41. package/dist-types/commands/GetExternalModelsCommand.d.ts +33 -0
  42. package/dist-types/commands/GetKMSEncryptionKeyCommand.d.ts +8 -0
  43. package/dist-types/commands/GetLabelsCommand.d.ts +15 -0
  44. package/dist-types/commands/GetListElementsCommand.d.ts +9 -0
  45. package/dist-types/commands/GetListsMetadataCommand.d.ts +16 -0
  46. package/dist-types/commands/GetModelVersionCommand.d.ts +34 -0
  47. package/dist-types/commands/GetModelsCommand.d.ts +17 -0
  48. package/dist-types/commands/GetOutcomesCommand.d.ts +15 -0
  49. package/dist-types/commands/GetRulesCommand.d.ts +22 -0
  50. package/dist-types/commands/GetVariablesCommand.d.ts +19 -0
  51. package/dist-types/commands/ListEventPredictionsCommand.d.ts +16 -0
  52. package/dist-types/commands/ListTagsForResourceCommand.d.ts +12 -0
  53. package/dist-types/commands/PutDetectorCommand.d.ts +4 -0
  54. package/dist-types/commands/PutEntityTypeCommand.d.ts +4 -0
  55. package/dist-types/commands/PutEventTypeCommand.d.ts +4 -0
  56. package/dist-types/commands/PutExternalModelCommand.d.ts +4 -0
  57. package/dist-types/commands/PutKMSEncryptionKeyCommand.d.ts +4 -0
  58. package/dist-types/commands/PutLabelCommand.d.ts +4 -0
  59. package/dist-types/commands/PutOutcomeCommand.d.ts +4 -0
  60. package/dist-types/commands/SendEventCommand.d.ts +4 -0
  61. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  62. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  63. package/dist-types/commands/UpdateDetectorVersionCommand.d.ts +4 -0
  64. package/dist-types/commands/UpdateDetectorVersionMetadataCommand.d.ts +4 -0
  65. package/dist-types/commands/UpdateDetectorVersionStatusCommand.d.ts +4 -0
  66. package/dist-types/commands/UpdateEventLabelCommand.d.ts +4 -0
  67. package/dist-types/commands/UpdateListCommand.d.ts +4 -0
  68. package/dist-types/commands/UpdateModelCommand.d.ts +4 -0
  69. package/dist-types/commands/UpdateModelVersionCommand.d.ts +9 -0
  70. package/dist-types/commands/UpdateModelVersionStatusCommand.d.ts +4 -0
  71. package/dist-types/commands/UpdateRuleMetadataCommand.d.ts +4 -0
  72. package/dist-types/commands/UpdateRuleVersionCommand.d.ts +10 -0
  73. package/dist-types/commands/UpdateVariableCommand.d.ts +4 -0
  74. package/package.json +3 -3
@@ -35,6 +35,171 @@ export interface DescribeModelVersionsCommandOutput extends DescribeModelVersion
35
35
  * };
36
36
  * const command = new DescribeModelVersionsCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // DescribeModelVersionsResult
39
+ * // modelVersionDetails: [ // modelVersionDetailList
40
+ * // { // ModelVersionDetail
41
+ * // modelId: "STRING_VALUE",
42
+ * // modelType: "ONLINE_FRAUD_INSIGHTS" || "TRANSACTION_FRAUD_INSIGHTS" || "ACCOUNT_TAKEOVER_INSIGHTS",
43
+ * // modelVersionNumber: "STRING_VALUE",
44
+ * // status: "STRING_VALUE",
45
+ * // trainingDataSource: "EXTERNAL_EVENTS" || "INGESTED_EVENTS",
46
+ * // trainingDataSchema: { // TrainingDataSchema
47
+ * // modelVariables: [ // ListOfStrings // required
48
+ * // "STRING_VALUE",
49
+ * // ],
50
+ * // labelSchema: { // LabelSchema
51
+ * // labelMapper: { // labelMapper
52
+ * // "<keys>": [
53
+ * // "STRING_VALUE",
54
+ * // ],
55
+ * // },
56
+ * // unlabeledEventsTreatment: "IGNORE" || "FRAUD" || "LEGIT" || "AUTO",
57
+ * // },
58
+ * // },
59
+ * // externalEventsDetail: { // ExternalEventsDetail
60
+ * // dataLocation: "STRING_VALUE", // required
61
+ * // dataAccessRoleArn: "STRING_VALUE", // required
62
+ * // },
63
+ * // ingestedEventsDetail: { // IngestedEventsDetail
64
+ * // ingestedEventsTimeWindow: { // IngestedEventsTimeWindow
65
+ * // startTime: "STRING_VALUE", // required
66
+ * // endTime: "STRING_VALUE", // required
67
+ * // },
68
+ * // },
69
+ * // trainingResult: { // TrainingResult
70
+ * // dataValidationMetrics: { // DataValidationMetrics
71
+ * // fileLevelMessages: [ // fileValidationMessageList
72
+ * // { // FileValidationMessage
73
+ * // title: "STRING_VALUE",
74
+ * // content: "STRING_VALUE",
75
+ * // type: "STRING_VALUE",
76
+ * // },
77
+ * // ],
78
+ * // fieldLevelMessages: [ // fieldValidationMessageList
79
+ * // { // FieldValidationMessage
80
+ * // fieldName: "STRING_VALUE",
81
+ * // identifier: "STRING_VALUE",
82
+ * // title: "STRING_VALUE",
83
+ * // content: "STRING_VALUE",
84
+ * // type: "STRING_VALUE",
85
+ * // },
86
+ * // ],
87
+ * // },
88
+ * // trainingMetrics: { // TrainingMetrics
89
+ * // auc: Number("float"),
90
+ * // metricDataPoints: [ // metricDataPointsList
91
+ * // { // MetricDataPoint
92
+ * // fpr: Number("float"),
93
+ * // precision: Number("float"),
94
+ * // tpr: Number("float"),
95
+ * // threshold: Number("float"),
96
+ * // },
97
+ * // ],
98
+ * // },
99
+ * // variableImportanceMetrics: { // VariableImportanceMetrics
100
+ * // logOddsMetrics: [ // ListOfLogOddsMetrics
101
+ * // { // LogOddsMetric
102
+ * // variableName: "STRING_VALUE", // required
103
+ * // variableType: "STRING_VALUE", // required
104
+ * // variableImportance: Number("float"), // required
105
+ * // },
106
+ * // ],
107
+ * // },
108
+ * // },
109
+ * // lastUpdatedTime: "STRING_VALUE",
110
+ * // createdTime: "STRING_VALUE",
111
+ * // arn: "STRING_VALUE",
112
+ * // trainingResultV2: { // TrainingResultV2
113
+ * // dataValidationMetrics: {
114
+ * // fileLevelMessages: [
115
+ * // {
116
+ * // title: "STRING_VALUE",
117
+ * // content: "STRING_VALUE",
118
+ * // type: "STRING_VALUE",
119
+ * // },
120
+ * // ],
121
+ * // fieldLevelMessages: [
122
+ * // {
123
+ * // fieldName: "STRING_VALUE",
124
+ * // identifier: "STRING_VALUE",
125
+ * // title: "STRING_VALUE",
126
+ * // content: "STRING_VALUE",
127
+ * // type: "STRING_VALUE",
128
+ * // },
129
+ * // ],
130
+ * // },
131
+ * // trainingMetricsV2: { // TrainingMetricsV2
132
+ * // ofi: { // OFITrainingMetricsValue
133
+ * // metricDataPoints: [ // OFIMetricDataPointsList
134
+ * // { // OFIMetricDataPoint
135
+ * // fpr: Number("float"),
136
+ * // precision: Number("float"),
137
+ * // tpr: Number("float"),
138
+ * // threshold: Number("float"),
139
+ * // },
140
+ * // ],
141
+ * // modelPerformance: { // OFIModelPerformance
142
+ * // auc: Number("float"),
143
+ * // uncertaintyRange: { // UncertaintyRange
144
+ * // lowerBoundValue: Number("float"), // required
145
+ * // upperBoundValue: Number("float"), // required
146
+ * // },
147
+ * // },
148
+ * // },
149
+ * // tfi: { // TFITrainingMetricsValue
150
+ * // metricDataPoints: [ // TFIMetricDataPointsList
151
+ * // { // TFIMetricDataPoint
152
+ * // fpr: Number("float"),
153
+ * // precision: Number("float"),
154
+ * // tpr: Number("float"),
155
+ * // threshold: Number("float"),
156
+ * // },
157
+ * // ],
158
+ * // modelPerformance: { // TFIModelPerformance
159
+ * // auc: Number("float"),
160
+ * // uncertaintyRange: {
161
+ * // lowerBoundValue: Number("float"), // required
162
+ * // upperBoundValue: Number("float"), // required
163
+ * // },
164
+ * // },
165
+ * // },
166
+ * // ati: { // ATITrainingMetricsValue
167
+ * // metricDataPoints: [ // ATIMetricDataPointsList
168
+ * // { // ATIMetricDataPoint
169
+ * // cr: Number("float"),
170
+ * // adr: Number("float"),
171
+ * // threshold: Number("float"),
172
+ * // atodr: Number("float"),
173
+ * // },
174
+ * // ],
175
+ * // modelPerformance: { // ATIModelPerformance
176
+ * // asi: Number("float"),
177
+ * // },
178
+ * // },
179
+ * // },
180
+ * // variableImportanceMetrics: {
181
+ * // logOddsMetrics: [
182
+ * // {
183
+ * // variableName: "STRING_VALUE", // required
184
+ * // variableType: "STRING_VALUE", // required
185
+ * // variableImportance: Number("float"), // required
186
+ * // },
187
+ * // ],
188
+ * // },
189
+ * // aggregatedVariablesImportanceMetrics: { // AggregatedVariablesImportanceMetrics
190
+ * // logOddsMetrics: [ // ListOfAggregatedLogOddsMetrics
191
+ * // { // AggregatedLogOddsMetric
192
+ * // variableNames: "<ListOfStrings>", // required
193
+ * // aggregatedVariablesImportance: Number("float"), // required
194
+ * // },
195
+ * // ],
196
+ * // },
197
+ * // },
198
+ * // },
199
+ * // ],
200
+ * // nextToken: "STRING_VALUE",
201
+ * // };
202
+ *
38
203
  * ```
39
204
  *
40
205
  * @param DescribeModelVersionsCommandInput - {@link DescribeModelVersionsCommandInput}
@@ -58,6 +223,8 @@ export interface DescribeModelVersionsCommandOutput extends DescribeModelVersion
58
223
  * @throws {@link ValidationException} (client fault)
59
224
  * <p>An exception indicating a specified value is not allowed.</p>
60
225
  *
226
+ * @throws {@link FraudDetectorServiceException}
227
+ * <p>Base exception class for all service exceptions from FraudDetector service.</p>
61
228
  *
62
229
  */
63
230
  export declare class DescribeModelVersionsCommand extends $Command<DescribeModelVersionsCommandInput, DescribeModelVersionsCommandOutput, FraudDetectorClientResolvedConfig> {
@@ -36,6 +36,27 @@ export interface GetBatchImportJobsCommandOutput extends GetBatchImportJobsResul
36
36
  * };
37
37
  * const command = new GetBatchImportJobsCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // GetBatchImportJobsResult
40
+ * // batchImports: [ // BatchImportList
41
+ * // { // BatchImport
42
+ * // jobId: "STRING_VALUE",
43
+ * // status: "IN_PROGRESS_INITIALIZING" || "IN_PROGRESS" || "CANCEL_IN_PROGRESS" || "CANCELED" || "COMPLETE" || "FAILED",
44
+ * // failureReason: "STRING_VALUE",
45
+ * // startTime: "STRING_VALUE",
46
+ * // completionTime: "STRING_VALUE",
47
+ * // inputPath: "STRING_VALUE",
48
+ * // outputPath: "STRING_VALUE",
49
+ * // eventTypeName: "STRING_VALUE",
50
+ * // iamRoleArn: "STRING_VALUE",
51
+ * // arn: "STRING_VALUE",
52
+ * // processedRecordsCount: Number("int"),
53
+ * // failedRecordsCount: Number("int"),
54
+ * // totalRecordsCount: Number("int"),
55
+ * // },
56
+ * // ],
57
+ * // nextToken: "STRING_VALUE",
58
+ * // };
59
+ *
39
60
  * ```
40
61
  *
41
62
  * @param GetBatchImportJobsCommandInput - {@link GetBatchImportJobsCommandInput}
@@ -59,6 +80,8 @@ export interface GetBatchImportJobsCommandOutput extends GetBatchImportJobsResul
59
80
  * @throws {@link ValidationException} (client fault)
60
81
  * <p>An exception indicating a specified value is not allowed.</p>
61
82
  *
83
+ * @throws {@link FraudDetectorServiceException}
84
+ * <p>Base exception class for all service exceptions from FraudDetector service.</p>
62
85
  *
63
86
  */
64
87
  export declare class GetBatchImportJobsCommand extends $Command<GetBatchImportJobsCommandInput, GetBatchImportJobsCommandOutput, FraudDetectorClientResolvedConfig> {
@@ -33,6 +33,29 @@ export interface GetBatchPredictionJobsCommandOutput extends GetBatchPredictionJ
33
33
  * };
34
34
  * const command = new GetBatchPredictionJobsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // GetBatchPredictionJobsResult
37
+ * // batchPredictions: [ // BatchPredictionList
38
+ * // { // BatchPrediction
39
+ * // jobId: "STRING_VALUE",
40
+ * // status: "IN_PROGRESS_INITIALIZING" || "IN_PROGRESS" || "CANCEL_IN_PROGRESS" || "CANCELED" || "COMPLETE" || "FAILED",
41
+ * // failureReason: "STRING_VALUE",
42
+ * // startTime: "STRING_VALUE",
43
+ * // completionTime: "STRING_VALUE",
44
+ * // lastHeartbeatTime: "STRING_VALUE",
45
+ * // inputPath: "STRING_VALUE",
46
+ * // outputPath: "STRING_VALUE",
47
+ * // eventTypeName: "STRING_VALUE",
48
+ * // detectorName: "STRING_VALUE",
49
+ * // detectorVersion: "STRING_VALUE",
50
+ * // iamRoleArn: "STRING_VALUE",
51
+ * // arn: "STRING_VALUE",
52
+ * // processedRecordsCount: Number("int"),
53
+ * // totalRecordsCount: Number("int"),
54
+ * // },
55
+ * // ],
56
+ * // nextToken: "STRING_VALUE",
57
+ * // };
58
+ *
36
59
  * ```
37
60
  *
38
61
  * @param GetBatchPredictionJobsCommandInput - {@link GetBatchPredictionJobsCommandInput}
@@ -56,6 +79,8 @@ export interface GetBatchPredictionJobsCommandOutput extends GetBatchPredictionJ
56
79
  * @throws {@link ValidationException} (client fault)
57
80
  * <p>An exception indicating a specified value is not allowed.</p>
58
81
  *
82
+ * @throws {@link FraudDetectorServiceException}
83
+ * <p>Base exception class for all service exceptions from FraudDetector service.</p>
59
84
  *
60
85
  */
61
86
  export declare class GetBatchPredictionJobsCommand extends $Command<GetBatchPredictionJobsCommandInput, GetBatchPredictionJobsCommandOutput, FraudDetectorClientResolvedConfig> {
@@ -31,6 +31,11 @@ export interface GetDeleteEventsByEventTypeStatusCommandOutput extends GetDelete
31
31
  * };
32
32
  * const command = new GetDeleteEventsByEventTypeStatusCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetDeleteEventsByEventTypeStatusResult
35
+ * // eventTypeName: "STRING_VALUE",
36
+ * // eventsDeletionStatus: "IN_PROGRESS_INITIALIZING" || "IN_PROGRESS" || "CANCEL_IN_PROGRESS" || "CANCELED" || "COMPLETE" || "FAILED",
37
+ * // };
38
+ *
34
39
  * ```
35
40
  *
36
41
  * @param GetDeleteEventsByEventTypeStatusCommandInput - {@link GetDeleteEventsByEventTypeStatusCommandInput}
@@ -54,6 +59,8 @@ export interface GetDeleteEventsByEventTypeStatusCommandOutput extends GetDelete
54
59
  * @throws {@link ValidationException} (client fault)
55
60
  * <p>An exception indicating a specified value is not allowed.</p>
56
61
  *
62
+ * @throws {@link FraudDetectorServiceException}
63
+ * <p>Base exception class for all service exceptions from FraudDetector service.</p>
57
64
  *
58
65
  */
59
66
  export declare class GetDeleteEventsByEventTypeStatusCommand extends $Command<GetDeleteEventsByEventTypeStatusCommandInput, GetDeleteEventsByEventTypeStatusCommandOutput, FraudDetectorClientResolvedConfig> {
@@ -32,6 +32,35 @@ export interface GetDetectorVersionCommandOutput extends GetDetectorVersionResul
32
32
  * };
33
33
  * const command = new GetDetectorVersionCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetDetectorVersionResult
36
+ * // detectorId: "STRING_VALUE",
37
+ * // detectorVersionId: "STRING_VALUE",
38
+ * // description: "STRING_VALUE",
39
+ * // externalModelEndpoints: [ // ListOfStrings
40
+ * // "STRING_VALUE",
41
+ * // ],
42
+ * // modelVersions: [ // ListOfModelVersions
43
+ * // { // ModelVersion
44
+ * // modelId: "STRING_VALUE", // required
45
+ * // modelType: "ONLINE_FRAUD_INSIGHTS" || "TRANSACTION_FRAUD_INSIGHTS" || "ACCOUNT_TAKEOVER_INSIGHTS", // required
46
+ * // modelVersionNumber: "STRING_VALUE", // required
47
+ * // arn: "STRING_VALUE",
48
+ * // },
49
+ * // ],
50
+ * // rules: [ // RuleList
51
+ * // { // Rule
52
+ * // detectorId: "STRING_VALUE", // required
53
+ * // ruleId: "STRING_VALUE", // required
54
+ * // ruleVersion: "STRING_VALUE", // required
55
+ * // },
56
+ * // ],
57
+ * // status: "DRAFT" || "ACTIVE" || "INACTIVE",
58
+ * // lastUpdatedTime: "STRING_VALUE",
59
+ * // createdTime: "STRING_VALUE",
60
+ * // ruleExecutionMode: "ALL_MATCHED" || "FIRST_MATCHED",
61
+ * // arn: "STRING_VALUE",
62
+ * // };
63
+ *
35
64
  * ```
36
65
  *
37
66
  * @param GetDetectorVersionCommandInput - {@link GetDetectorVersionCommandInput}
@@ -55,6 +84,8 @@ export interface GetDetectorVersionCommandOutput extends GetDetectorVersionResul
55
84
  * @throws {@link ValidationException} (client fault)
56
85
  * <p>An exception indicating a specified value is not allowed.</p>
57
86
  *
87
+ * @throws {@link FraudDetectorServiceException}
88
+ * <p>Base exception class for all service exceptions from FraudDetector service.</p>
58
89
  *
59
90
  */
60
91
  export declare class GetDetectorVersionCommand extends $Command<GetDetectorVersionCommandInput, GetDetectorVersionCommandOutput, FraudDetectorClientResolvedConfig> {
@@ -38,6 +38,20 @@ export interface GetDetectorsCommandOutput extends GetDetectorsResult, __Metadat
38
38
  * };
39
39
  * const command = new GetDetectorsCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // GetDetectorsResult
42
+ * // detectors: [ // DetectorList
43
+ * // { // Detector
44
+ * // detectorId: "STRING_VALUE",
45
+ * // description: "STRING_VALUE",
46
+ * // eventTypeName: "STRING_VALUE",
47
+ * // lastUpdatedTime: "STRING_VALUE",
48
+ * // createdTime: "STRING_VALUE",
49
+ * // arn: "STRING_VALUE",
50
+ * // },
51
+ * // ],
52
+ * // nextToken: "STRING_VALUE",
53
+ * // };
54
+ *
41
55
  * ```
42
56
  *
43
57
  * @param GetDetectorsCommandInput - {@link GetDetectorsCommandInput}
@@ -61,6 +75,8 @@ export interface GetDetectorsCommandOutput extends GetDetectorsResult, __Metadat
61
75
  * @throws {@link ValidationException} (client fault)
62
76
  * <p>An exception indicating a specified value is not allowed.</p>
63
77
  *
78
+ * @throws {@link FraudDetectorServiceException}
79
+ * <p>Base exception class for all service exceptions from FraudDetector service.</p>
64
80
  *
65
81
  */
66
82
  export declare class GetDetectorsCommand extends $Command<GetDetectorsCommandInput, GetDetectorsCommandOutput, FraudDetectorClientResolvedConfig> {
@@ -38,6 +38,19 @@ export interface GetEntityTypesCommandOutput extends GetEntityTypesResult, __Met
38
38
  * };
39
39
  * const command = new GetEntityTypesCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // GetEntityTypesResult
42
+ * // entityTypes: [ // entityTypeList
43
+ * // { // EntityType
44
+ * // name: "STRING_VALUE",
45
+ * // description: "STRING_VALUE",
46
+ * // lastUpdatedTime: "STRING_VALUE",
47
+ * // createdTime: "STRING_VALUE",
48
+ * // arn: "STRING_VALUE",
49
+ * // },
50
+ * // ],
51
+ * // nextToken: "STRING_VALUE",
52
+ * // };
53
+ *
41
54
  * ```
42
55
  *
43
56
  * @param GetEntityTypesCommandInput - {@link GetEntityTypesCommandInput}
@@ -61,6 +74,8 @@ export interface GetEntityTypesCommandOutput extends GetEntityTypesResult, __Met
61
74
  * @throws {@link ValidationException} (client fault)
62
75
  * <p>An exception indicating a specified value is not allowed.</p>
63
76
  *
77
+ * @throws {@link FraudDetectorServiceException}
78
+ * <p>Base exception class for all service exceptions from FraudDetector service.</p>
64
79
  *
65
80
  */
66
81
  export declare class GetEntityTypesCommand extends $Command<GetEntityTypesCommandInput, GetEntityTypesCommandOutput, FraudDetectorClientResolvedConfig> {
@@ -32,6 +32,25 @@ export interface GetEventCommandOutput extends GetEventResult, __MetadataBearer
32
32
  * };
33
33
  * const command = new GetEventCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetEventResult
36
+ * // event: { // Event
37
+ * // eventId: "STRING_VALUE",
38
+ * // eventTypeName: "STRING_VALUE",
39
+ * // eventTimestamp: "STRING_VALUE",
40
+ * // eventVariables: { // EventAttributeMap
41
+ * // "<keys>": "STRING_VALUE",
42
+ * // },
43
+ * // currentLabel: "STRING_VALUE",
44
+ * // labelTimestamp: "STRING_VALUE",
45
+ * // entities: [ // listOfEntities
46
+ * // { // Entity
47
+ * // entityType: "STRING_VALUE", // required
48
+ * // entityId: "STRING_VALUE", // required
49
+ * // },
50
+ * // ],
51
+ * // },
52
+ * // };
53
+ *
35
54
  * ```
36
55
  *
37
56
  * @param GetEventCommandInput - {@link GetEventCommandInput}
@@ -55,6 +74,8 @@ export interface GetEventCommandOutput extends GetEventResult, __MetadataBearer
55
74
  * @throws {@link ValidationException} (client fault)
56
75
  * <p>An exception indicating a specified value is not allowed.</p>
57
76
  *
77
+ * @throws {@link FraudDetectorServiceException}
78
+ * <p>Base exception class for all service exceptions from FraudDetector service.</p>
58
79
  *
59
80
  */
60
81
  export declare class GetEventCommand extends $Command<GetEventCommandInput, GetEventCommandOutput, FraudDetectorClientResolvedConfig> {
@@ -50,6 +50,41 @@ export interface GetEventPredictionCommandOutput extends GetEventPredictionResul
50
50
  * };
51
51
  * const command = new GetEventPredictionCommand(input);
52
52
  * const response = await client.send(command);
53
+ * // { // GetEventPredictionResult
54
+ * // modelScores: [ // ListOfModelScores
55
+ * // { // ModelScores
56
+ * // modelVersion: { // ModelVersion
57
+ * // modelId: "STRING_VALUE", // required
58
+ * // modelType: "ONLINE_FRAUD_INSIGHTS" || "TRANSACTION_FRAUD_INSIGHTS" || "ACCOUNT_TAKEOVER_INSIGHTS", // required
59
+ * // modelVersionNumber: "STRING_VALUE", // required
60
+ * // arn: "STRING_VALUE",
61
+ * // },
62
+ * // scores: { // ModelPredictionMap
63
+ * // "<keys>": Number("float"),
64
+ * // },
65
+ * // },
66
+ * // ],
67
+ * // ruleResults: [ // ListOfRuleResults
68
+ * // { // RuleResult
69
+ * // ruleId: "STRING_VALUE",
70
+ * // outcomes: [ // ListOfStrings
71
+ * // "STRING_VALUE",
72
+ * // ],
73
+ * // },
74
+ * // ],
75
+ * // externalModelOutputs: [ // ListOfExternalModelOutputs
76
+ * // { // ExternalModelOutputs
77
+ * // externalModel: { // ExternalModelSummary
78
+ * // modelEndpoint: "STRING_VALUE",
79
+ * // modelSource: "SAGEMAKER",
80
+ * // },
81
+ * // outputs: { // ExternalModelPredictionMap
82
+ * // "<keys>": "STRING_VALUE",
83
+ * // },
84
+ * // },
85
+ * // ],
86
+ * // };
87
+ *
53
88
  * ```
54
89
  *
55
90
  * @param GetEventPredictionCommandInput - {@link GetEventPredictionCommandInput}
@@ -79,6 +114,8 @@ export interface GetEventPredictionCommandOutput extends GetEventPredictionResul
79
114
  * @throws {@link ValidationException} (client fault)
80
115
  * <p>An exception indicating a specified value is not allowed.</p>
81
116
  *
117
+ * @throws {@link FraudDetectorServiceException}
118
+ * <p>Base exception class for all service exceptions from FraudDetector service.</p>
82
119
  *
83
120
  */
84
121
  export declare class GetEventPredictionCommand extends $Command<GetEventPredictionCommandInput, GetEventPredictionCommandOutput, FraudDetectorClientResolvedConfig> {
@@ -37,6 +37,83 @@ export interface GetEventPredictionMetadataCommandOutput extends GetEventPredict
37
37
  * };
38
38
  * const command = new GetEventPredictionMetadataCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // GetEventPredictionMetadataResult
41
+ * // eventId: "STRING_VALUE",
42
+ * // eventTypeName: "STRING_VALUE",
43
+ * // entityId: "STRING_VALUE",
44
+ * // entityType: "STRING_VALUE",
45
+ * // eventTimestamp: "STRING_VALUE",
46
+ * // detectorId: "STRING_VALUE",
47
+ * // detectorVersionId: "STRING_VALUE",
48
+ * // detectorVersionStatus: "STRING_VALUE",
49
+ * // eventVariables: [ // ListOfEventVariableSummaries
50
+ * // { // EventVariableSummary
51
+ * // name: "STRING_VALUE",
52
+ * // value: "STRING_VALUE",
53
+ * // source: "STRING_VALUE",
54
+ * // },
55
+ * // ],
56
+ * // rules: [ // EvaluatedRuleList
57
+ * // { // EvaluatedRule
58
+ * // ruleId: "STRING_VALUE",
59
+ * // ruleVersion: "STRING_VALUE",
60
+ * // expression: "STRING_VALUE",
61
+ * // expressionWithValues: "STRING_VALUE",
62
+ * // outcomes: [ // ListOfStrings
63
+ * // "STRING_VALUE",
64
+ * // ],
65
+ * // evaluated: true || false,
66
+ * // matched: true || false,
67
+ * // },
68
+ * // ],
69
+ * // ruleExecutionMode: "ALL_MATCHED" || "FIRST_MATCHED",
70
+ * // outcomes: [
71
+ * // "STRING_VALUE",
72
+ * // ],
73
+ * // evaluatedModelVersions: [ // ListOfEvaluatedModelVersions
74
+ * // { // EvaluatedModelVersion
75
+ * // modelId: "STRING_VALUE",
76
+ * // modelVersion: "STRING_VALUE",
77
+ * // modelType: "STRING_VALUE",
78
+ * // evaluations: [ // ListOfModelVersionEvaluations
79
+ * // { // ModelVersionEvaluation
80
+ * // outputVariableName: "STRING_VALUE",
81
+ * // evaluationScore: "STRING_VALUE",
82
+ * // predictionExplanations: { // PredictionExplanations
83
+ * // variableImpactExplanations: [ // listOfVariableImpactExplanations
84
+ * // { // VariableImpactExplanation
85
+ * // eventVariableName: "STRING_VALUE",
86
+ * // relativeImpact: "STRING_VALUE",
87
+ * // logOddsImpact: Number("float"),
88
+ * // },
89
+ * // ],
90
+ * // aggregatedVariablesImpactExplanations: [ // ListOfAggregatedVariablesImpactExplanations
91
+ * // { // AggregatedVariablesImpactExplanation
92
+ * // eventVariableNames: "<ListOfStrings>",
93
+ * // relativeImpact: "STRING_VALUE",
94
+ * // logOddsImpact: Number("float"),
95
+ * // },
96
+ * // ],
97
+ * // },
98
+ * // },
99
+ * // ],
100
+ * // },
101
+ * // ],
102
+ * // evaluatedExternalModels: [ // ListOfEvaluatedExternalModels
103
+ * // { // EvaluatedExternalModel
104
+ * // modelEndpoint: "STRING_VALUE",
105
+ * // useEventVariables: true || false,
106
+ * // inputVariables: { // MapOfStrings
107
+ * // "<keys>": "STRING_VALUE",
108
+ * // },
109
+ * // outputVariables: {
110
+ * // "<keys>": "STRING_VALUE",
111
+ * // },
112
+ * // },
113
+ * // ],
114
+ * // predictionTimestamp: "STRING_VALUE",
115
+ * // };
116
+ *
40
117
  * ```
41
118
  *
42
119
  * @param GetEventPredictionMetadataCommandInput - {@link GetEventPredictionMetadataCommandInput}
@@ -60,6 +137,8 @@ export interface GetEventPredictionMetadataCommandOutput extends GetEventPredict
60
137
  * @throws {@link ValidationException} (client fault)
61
138
  * <p>An exception indicating a specified value is not allowed.</p>
62
139
  *
140
+ * @throws {@link FraudDetectorServiceException}
141
+ * <p>Base exception class for all service exceptions from FraudDetector service.</p>
63
142
  *
64
143
  */
65
144
  export declare class GetEventPredictionMetadataCommand extends $Command<GetEventPredictionMetadataCommandInput, GetEventPredictionMetadataCommandOutput, FraudDetectorClientResolvedConfig> {
@@ -38,6 +38,36 @@ export interface GetEventTypesCommandOutput extends GetEventTypesResult, __Metad
38
38
  * };
39
39
  * const command = new GetEventTypesCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // GetEventTypesResult
42
+ * // eventTypes: [ // eventTypeList
43
+ * // { // EventType
44
+ * // name: "STRING_VALUE",
45
+ * // description: "STRING_VALUE",
46
+ * // eventVariables: [ // ListOfStrings
47
+ * // "STRING_VALUE",
48
+ * // ],
49
+ * // labels: [
50
+ * // "STRING_VALUE",
51
+ * // ],
52
+ * // entityTypes: [ // NonEmptyListOfStrings
53
+ * // "STRING_VALUE",
54
+ * // ],
55
+ * // eventIngestion: "ENABLED" || "DISABLED",
56
+ * // ingestedEventStatistics: { // IngestedEventStatistics
57
+ * // numberOfEvents: Number("long"),
58
+ * // eventDataSizeInBytes: Number("long"),
59
+ * // leastRecentEvent: "STRING_VALUE",
60
+ * // mostRecentEvent: "STRING_VALUE",
61
+ * // lastUpdatedTime: "STRING_VALUE",
62
+ * // },
63
+ * // lastUpdatedTime: "STRING_VALUE",
64
+ * // createdTime: "STRING_VALUE",
65
+ * // arn: "STRING_VALUE",
66
+ * // },
67
+ * // ],
68
+ * // nextToken: "STRING_VALUE",
69
+ * // };
70
+ *
41
71
  * ```
42
72
  *
43
73
  * @param GetEventTypesCommandInput - {@link GetEventTypesCommandInput}
@@ -61,6 +91,8 @@ export interface GetEventTypesCommandOutput extends GetEventTypesResult, __Metad
61
91
  * @throws {@link ValidationException} (client fault)
62
92
  * <p>An exception indicating a specified value is not allowed.</p>
63
93
  *
94
+ * @throws {@link FraudDetectorServiceException}
95
+ * <p>Base exception class for all service exceptions from FraudDetector service.</p>
64
96
  *
65
97
  */
66
98
  export declare class GetEventTypesCommand extends $Command<GetEventTypesCommandInput, GetEventTypesCommandOutput, FraudDetectorClientResolvedConfig> {
@@ -38,6 +38,37 @@ export interface GetExternalModelsCommandOutput extends GetExternalModelsResult,
38
38
  * };
39
39
  * const command = new GetExternalModelsCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // GetExternalModelsResult
42
+ * // externalModels: [ // ExternalModelList
43
+ * // { // ExternalModel
44
+ * // modelEndpoint: "STRING_VALUE",
45
+ * // modelSource: "SAGEMAKER",
46
+ * // invokeModelEndpointRoleArn: "STRING_VALUE",
47
+ * // inputConfiguration: { // ModelInputConfiguration
48
+ * // eventTypeName: "STRING_VALUE",
49
+ * // format: "TEXT_CSV" || "APPLICATION_JSON",
50
+ * // useEventVariables: true || false, // required
51
+ * // jsonInputTemplate: "STRING_VALUE",
52
+ * // csvInputTemplate: "STRING_VALUE",
53
+ * // },
54
+ * // outputConfiguration: { // ModelOutputConfiguration
55
+ * // format: "TEXT_CSV" || "APPLICATION_JSONLINES", // required
56
+ * // jsonKeyToVariableMap: { // JsonKeyToVariableMap
57
+ * // "<keys>": "STRING_VALUE",
58
+ * // },
59
+ * // csvIndexToVariableMap: { // CsvIndexToVariableMap
60
+ * // "<keys>": "STRING_VALUE",
61
+ * // },
62
+ * // },
63
+ * // modelEndpointStatus: "ASSOCIATED" || "DISSOCIATED",
64
+ * // lastUpdatedTime: "STRING_VALUE",
65
+ * // createdTime: "STRING_VALUE",
66
+ * // arn: "STRING_VALUE",
67
+ * // },
68
+ * // ],
69
+ * // nextToken: "STRING_VALUE",
70
+ * // };
71
+ *
41
72
  * ```
42
73
  *
43
74
  * @param GetExternalModelsCommandInput - {@link GetExternalModelsCommandInput}
@@ -61,6 +92,8 @@ export interface GetExternalModelsCommandOutput extends GetExternalModelsResult,
61
92
  * @throws {@link ValidationException} (client fault)
62
93
  * <p>An exception indicating a specified value is not allowed.</p>
63
94
  *
95
+ * @throws {@link FraudDetectorServiceException}
96
+ * <p>Base exception class for all service exceptions from FraudDetector service.</p>
64
97
  *
65
98
  */
66
99
  export declare class GetExternalModelsCommand extends $Command<GetExternalModelsCommandInput, GetExternalModelsCommandOutput, FraudDetectorClientResolvedConfig> {