1// Code generated by smithy-go-codegen DO NOT EDIT. 2 3package types 4 5// Provides the error of the batch create variable API. 6type BatchCreateVariableError struct { 7 8 // The error code. 9 Code int32 10 11 // The error message. 12 Message *string 13 14 // The name. 15 Name *string 16} 17 18// Provides the error of the batch get variable API. 19type BatchGetVariableError struct { 20 21 // The error code. 22 Code int32 23 24 // The error message. 25 Message *string 26 27 // The error name. 28 Name *string 29} 30 31// The model training validation messages. 32type DataValidationMetrics struct { 33 34 // The field-specific model training validation messages. 35 FieldLevelMessages []FieldValidationMessage 36 37 // The file-specific model training validation messages. 38 FileLevelMessages []FileValidationMessage 39} 40 41// The detector. 42type Detector struct { 43 44 // The detector ARN. 45 Arn *string 46 47 // Timestamp of when the detector was created. 48 CreatedTime *string 49 50 // The detector description. 51 Description *string 52 53 // The detector ID. 54 DetectorId *string 55 56 // The name of the event type. 57 EventTypeName *string 58 59 // Timestamp of when the detector was last updated. 60 LastUpdatedTime *string 61} 62 63// The summary of the detector version. 64type DetectorVersionSummary struct { 65 66 // The detector version description. 67 Description *string 68 69 // The detector version ID. 70 DetectorVersionId *string 71 72 // Timestamp of when the detector version was last updated. 73 LastUpdatedTime *string 74 75 // The detector version status. 76 Status DetectorVersionStatus 77} 78 79// The entity details. 80type Entity struct { 81 82 // The entity ID. If you do not know the entityId, you can pass unknown, which is 83 // areserved string literal. 84 // 85 // This member is required. 86 EntityId *string 87 88 // The entity type. 89 // 90 // This member is required. 91 EntityType *string 92} 93 94// The entity type details. 95type EntityType struct { 96 97 // The entity type ARN. 98 Arn *string 99 100 // Timestamp of when the entity type was created. 101 CreatedTime *string 102 103 // The entity type description. 104 Description *string 105 106 // Timestamp of when the entity type was last updated. 107 LastUpdatedTime *string 108 109 // The entity type name. 110 Name *string 111} 112 113// The event type details. 114type EventType struct { 115 116 // The entity type ARN. 117 Arn *string 118 119 // Timestamp of when the event type was created. 120 CreatedTime *string 121 122 // The event type description. 123 Description *string 124 125 // The event type entity types. 126 EntityTypes []string 127 128 // The event type event variables. 129 EventVariables []string 130 131 // The event type labels. 132 Labels []string 133 134 // Timestamp of when the event type was last updated. 135 LastUpdatedTime *string 136 137 // The event type name. 138 Name *string 139} 140 141// Details for the external events data used for model version training. 142type ExternalEventsDetail struct { 143 144 // The ARN of the role that provides Amazon Fraud Detector access to the data 145 // location. 146 // 147 // This member is required. 148 DataAccessRoleArn *string 149 150 // The Amazon S3 bucket location for the data. 151 // 152 // This member is required. 153 DataLocation *string 154} 155 156// The Amazon SageMaker model. 157type ExternalModel struct { 158 159 // The model ARN. 160 Arn *string 161 162 // Timestamp of when the model was last created. 163 CreatedTime *string 164 165 // The input configuration. 166 InputConfiguration *ModelInputConfiguration 167 168 // The role used to invoke the model. 169 InvokeModelEndpointRoleArn *string 170 171 // Timestamp of when the model was last updated. 172 LastUpdatedTime *string 173 174 // The Amazon SageMaker model endpoints. 175 ModelEndpoint *string 176 177 // The Amazon Fraud Detector status for the external model endpoint 178 ModelEndpointStatus ModelEndpointStatus 179 180 // The source of the model. 181 ModelSource ModelSource 182 183 // The output configuration. 184 OutputConfiguration *ModelOutputConfiguration 185} 186 187// The message details. 188type FieldValidationMessage struct { 189 190 // The message content. 191 Content *string 192 193 // The field name. 194 FieldName *string 195 196 // The message ID. 197 Identifier *string 198 199 // The message title. 200 Title *string 201 202 // The message type. 203 Type *string 204} 205 206// The message details. 207type FileValidationMessage struct { 208 209 // The message content. 210 Content *string 211 212 // The message title. 213 Title *string 214 215 // The message type. 216 Type *string 217} 218 219// The KMS key details. 220type KMSKey struct { 221 222 // The encryption key ARN. 223 KmsEncryptionKeyArn *string 224} 225 226// The label details. 227type Label struct { 228 229 // The label ARN. 230 Arn *string 231 232 // Timestamp of when the event type was created. 233 CreatedTime *string 234 235 // The label description. 236 Description *string 237 238 // Timestamp of when the label was last updated. 239 LastUpdatedTime *string 240 241 // The label name. 242 Name *string 243} 244 245// The label schema. 246type LabelSchema struct { 247 248 // The label mapper maps the Amazon Fraud Detector supported model classification 249 // labels (FRAUD, LEGIT) to the appropriate event type labels. For example, if 250 // "FRAUD" and "LEGIT" are Amazon Fraud Detector supported labels, this mapper 251 // could be: {"FRAUD" => ["0"], "LEGIT" => ["1"]} or {"FRAUD" => ["false"], "LEGIT" 252 // => ["true"]} or {"FRAUD" => ["fraud", "abuse"], "LEGIT" => ["legit", "safe"]}. 253 // The value part of the mapper is a list, because you may have multiple label 254 // variants from your event type for a single Amazon Fraud Detector label. 255 // 256 // This member is required. 257 LabelMapper map[string][]string 258} 259 260// Model performance metrics data points. 261type MetricDataPoint struct { 262 263 // The false positive rate. This is the percentage of total legitimate events that 264 // are incorrectly predicted as fraud. 265 Fpr *float32 266 267 // The percentage of fraud events correctly predicted as fraudulent as compared to 268 // all events predicted as fraudulent. 269 Precision *float32 270 271 // The model threshold that specifies an acceptable fraud capture rate. For 272 // example, a threshold of 500 means any model score 500 or above is labeled as 273 // fraud. 274 Threshold *float32 275 276 // The true positive rate. This is the percentage of total fraud the model detects. 277 // Also known as capture rate. 278 Tpr *float32 279} 280 281// The model. 282type Model struct { 283 284 // The ARN of the model. 285 Arn *string 286 287 // Timestamp of when the model was created. 288 CreatedTime *string 289 290 // The model description. 291 Description *string 292 293 // The name of the event type. 294 EventTypeName *string 295 296 // Timestamp of last time the model was updated. 297 LastUpdatedTime *string 298 299 // The model ID. 300 ModelId *string 301 302 // The model type. 303 ModelType ModelTypeEnum 304} 305 306// A pre-formed Amazon SageMaker model input you can include if your detector 307// version includes an imported Amazon SageMaker model endpoint with pass-through 308// input configuration. 309type ModelEndpointDataBlob struct { 310 311 // The byte buffer of the Amazon SageMaker model endpoint input data blob. 312 ByteBuffer []byte 313 314 // The content type of the Amazon SageMaker model endpoint input data blob. 315 ContentType *string 316} 317 318// The Amazon SageMaker model input configuration. 319type ModelInputConfiguration struct { 320 321 // The event variables. 322 // 323 // This member is required. 324 UseEventVariables *bool 325 326 // Template for constructing the CSV input-data sent to SageMaker. At 327 // event-evaluation, the placeholders for variable-names in the template will be 328 // replaced with the variable values before being sent to SageMaker. 329 CsvInputTemplate *string 330 331 // The event type name. 332 EventTypeName *string 333 334 // The format of the model input configuration. The format differs depending on if 335 // it is passed through to SageMaker or constructed by Amazon Fraud Detector. 336 Format ModelInputDataFormat 337 338 // Template for constructing the JSON input-data sent to SageMaker. At 339 // event-evaluation, the placeholders for variable names in the template will be 340 // replaced with the variable values before being sent to SageMaker. 341 JsonInputTemplate *string 342} 343 344// Provides the Amazon Sagemaker model output configuration. 345type ModelOutputConfiguration struct { 346 347 // The format of the model output configuration. 348 // 349 // This member is required. 350 Format ModelOutputDataFormat 351 352 // A map of CSV index values in the SageMaker response to the Amazon Fraud Detector 353 // variables. 354 CsvIndexToVariableMap map[string]string 355 356 // A map of JSON keys in response from SageMaker to the Amazon Fraud Detector 357 // variables. 358 JsonKeyToVariableMap map[string]string 359} 360 361// The fraud prediction scores. 362type ModelScores struct { 363 364 // The model version. 365 ModelVersion *ModelVersion 366 367 // The model's fraud prediction scores. 368 Scores map[string]float32 369} 370 371// The model version. 372type ModelVersion struct { 373 374 // The model ID. 375 // 376 // This member is required. 377 ModelId *string 378 379 // The model type. 380 // 381 // This member is required. 382 ModelType ModelTypeEnum 383 384 // The model version number. 385 // 386 // This member is required. 387 ModelVersionNumber *string 388 389 // The model version ARN. 390 Arn *string 391} 392 393// The details of the model version. 394type ModelVersionDetail struct { 395 396 // The model version ARN. 397 Arn *string 398 399 // The timestamp when the model was created. 400 CreatedTime *string 401 402 // The event details. 403 ExternalEventsDetail *ExternalEventsDetail 404 405 // The timestamp when the model was last updated. 406 LastUpdatedTime *string 407 408 // The model ID. 409 ModelId *string 410 411 // The model type. 412 ModelType ModelTypeEnum 413 414 // The model version number. 415 ModelVersionNumber *string 416 417 // The status of the model version. 418 Status *string 419 420 // The training data schema. 421 TrainingDataSchema *TrainingDataSchema 422 423 // The model version training data source. 424 TrainingDataSource TrainingDataSourceEnum 425 426 // The training results. 427 TrainingResult *TrainingResult 428} 429 430// The outcome. 431type Outcome struct { 432 433 // The outcome ARN. 434 Arn *string 435 436 // The timestamp when the outcome was created. 437 CreatedTime *string 438 439 // The outcome description. 440 Description *string 441 442 // The timestamp when the outcome was last updated. 443 LastUpdatedTime *string 444 445 // The outcome name. 446 Name *string 447} 448 449// A rule. 450type Rule struct { 451 452 // The detector for which the rule is associated. 453 // 454 // This member is required. 455 DetectorId *string 456 457 // The rule ID. 458 // 459 // This member is required. 460 RuleId *string 461 462 // The rule version. 463 // 464 // This member is required. 465 RuleVersion *string 466} 467 468// The details of the rule. 469type RuleDetail struct { 470 471 // The rule ARN. 472 Arn *string 473 474 // The timestamp of when the rule was created. 475 CreatedTime *string 476 477 // The rule description. 478 Description *string 479 480 // The detector for which the rule is associated. 481 DetectorId *string 482 483 // The rule expression. 484 Expression *string 485 486 // The rule language. 487 Language Language 488 489 // Timestamp of the last time the rule was updated. 490 LastUpdatedTime *string 491 492 // The rule outcomes. 493 Outcomes []string 494 495 // The rule ID. 496 RuleId *string 497 498 // The rule version. 499 RuleVersion *string 500} 501 502// The rule results. 503type RuleResult struct { 504 505 // The outcomes of the matched rule, based on the rule execution mode. 506 Outcomes []string 507 508 // The rule ID that was matched, based on the rule execution mode. 509 RuleId *string 510} 511 512// A key and value pair. 513type Tag struct { 514 515 // A tag key. 516 // 517 // This member is required. 518 Key *string 519 520 // A value assigned to a tag key. 521 // 522 // This member is required. 523 Value *string 524} 525 526// The training data schema. 527type TrainingDataSchema struct { 528 529 // The label schema. 530 // 531 // This member is required. 532 LabelSchema *LabelSchema 533 534 // The training data schema variables. 535 // 536 // This member is required. 537 ModelVariables []string 538} 539 540// The training metric details. 541type TrainingMetrics struct { 542 543 // The area under the curve. This summarizes true positive rate (TPR) and false 544 // positive rate (FPR) across all possible model score thresholds. A model with no 545 // predictive power has an AUC of 0.5, whereas a perfect model has a score of 1.0. 546 Auc *float32 547 548 // The data points details. 549 MetricDataPoints []MetricDataPoint 550} 551 552// The training result details. 553type TrainingResult struct { 554 555 // The validation metrics. 556 DataValidationMetrics *DataValidationMetrics 557 558 // The training metric details. 559 TrainingMetrics *TrainingMetrics 560} 561 562// The variable. 563type Variable struct { 564 565 // The ARN of the variable. 566 Arn *string 567 568 // The time when the variable was created. 569 CreatedTime *string 570 571 // The data source of the variable. 572 DataSource DataSource 573 574 // The data type of the variable. For more information see Variable types 575 // (https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types). 576 DataType DataType 577 578 // The default value of the variable. 579 DefaultValue *string 580 581 // The description of the variable. 582 Description *string 583 584 // The time when variable was last updated. 585 LastUpdatedTime *string 586 587 // The name of the variable. 588 Name *string 589 590 // The variable type of the variable. Valid Values: AUTH_CODE | AVS | 591 // BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | 592 // BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | 593 // CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | 594 // FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | 595 // PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | 596 // SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | 597 // SHIPPING_STATE | SHIPPING_ZIP | USERAGENT 598 VariableType *string 599} 600 601// A variable in the list of variables for the batch create variable request. 602type VariableEntry struct { 603 604 // The data source of the variable. 605 DataSource *string 606 607 // The data type of the variable. 608 DataType *string 609 610 // The default value of the variable. 611 DefaultValue *string 612 613 // The description of the variable. 614 Description *string 615 616 // The name of the variable. 617 Name *string 618 619 // The type of the variable. For more information see Variable types 620 // (https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types). 621 // Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | 622 // BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | 623 // BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | 624 // FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | 625 // PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | 626 // SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | 627 // SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT 628 VariableType *string 629} 630