1{ 2 "version": "2.0", 3 "service": "<p>This is the Amazon Fraud Detector API Reference. This guide is for developers who need detailed information about Amazon Fraud Detector API actions, data types, and errors. For more information about Amazon Fraud Detector features, see the <a href=\"https://docs.aws.amazon.com/frauddetector/latest/ug/\">Amazon Fraud Detector User Guide</a>.</p>", 4 "operations": { 5 "BatchCreateVariable": "<p>Creates a batch of variables.</p>", 6 "BatchGetVariable": "<p>Gets a batch of variables.</p>", 7 "CreateDetectorVersion": "<p>Creates a detector version. The detector version starts in a <code>DRAFT</code> status.</p>", 8 "CreateModelVersion": "<p>Creates a version of the model using the specified model type. </p>", 9 "CreateRule": "<p>Creates a rule for use with the specified detector. </p>", 10 "CreateVariable": "<p>Creates a variable.</p>", 11 "DeleteDetector": "<p>Deletes the detector. Before deleting a detector, you must first delete all detector versions and rule versions associated with the detector.</p>", 12 "DeleteDetectorVersion": "<p>Deletes the detector version. You cannot delete detector versions that are in <code>ACTIVE</code> status.</p>", 13 "DeleteEvent": "<p>Deletes the specified event.</p>", 14 "DeleteRuleVersion": "<p>Deletes the rule version. You cannot delete a rule version if it is used by an <code>ACTIVE</code> or <code>INACTIVE</code> detector version.</p>", 15 "DescribeDetector": "<p>Gets all versions for a specified detector.</p>", 16 "DescribeModelVersions": "<p>Gets all of the model versions for the specified model type or for the specified model type and model ID. You can also get details for a single, specified model version. </p>", 17 "GetDetectorVersion": "<p>Gets a particular detector version. </p>", 18 "GetDetectors": "<p>Gets all of detectors. This is a paginated API. If you provide a null <code>maxSizePerPage</code>, this actions retrieves a maximum of 10 records per page. If you provide a <code>maxSizePerPage</code>, the value must be between 5 and 10. To get the next page results, provide the pagination token from the <code>GetEventTypesResponse</code> as part of your request. A null pagination token fetches the records from the beginning. </p>", 19 "GetExternalModels": "<p>Gets the details for one or more Amazon SageMaker models that have been imported into the service. This is a paginated API. If you provide a null <code>maxSizePerPage</code>, this actions retrieves a maximum of 10 records per page. If you provide a <code>maxSizePerPage</code>, the value must be between 5 and 10. To get the next page results, provide the pagination token from the <code>GetExternalModelsResult</code> as part of your request. A null pagination token fetches the records from the beginning. </p>", 20 "GetModelVersion": "<p>Gets a model version. </p>", 21 "GetModels": "<p>Gets all of the models for the AWS account, or the specified model type, or gets a single model for the specified model type, model ID combination. </p>", 22 "GetOutcomes": "<p>Gets one or more outcomes. This is a paginated API. If you provide a null <code>maxSizePerPage</code>, this actions retrieves a maximum of 10 records per page. If you provide a <code>maxSizePerPage</code>, the value must be between 50 and 100. To get the next page results, provide the pagination token from the <code>GetOutcomesResult</code> as part of your request. A null pagination token fetches the records from the beginning. </p>", 23 "GetPrediction": "<p>Evaluates an event against a detector version. If a version ID is not provided, the detector’s (<code>ACTIVE</code>) version is used. </p>", 24 "GetRules": "<p>Gets all rules available for the specified detector.</p>", 25 "GetVariables": "<p>Gets all of the variables or the specific variable. This is a paginated API. Providing null <code>maxSizePerPage</code> results in retrieving maximum of 100 records per page. If you provide <code>maxSizePerPage</code> the value must be between 50 and 100. To get the next page result, a provide a pagination token from <code>GetVariablesResult</code> as part of your request. Null pagination token fetches the records from the beginning. </p>", 26 "PutDetector": "<p>Creates or updates a detector. </p>", 27 "PutExternalModel": "<p>Creates or updates an Amazon SageMaker model endpoint. You can also use this action to update the configuration of the model endpoint, including the IAM role and/or the mapped variables. </p>", 28 "PutModel": "<p>Creates or updates a model. </p>", 29 "PutOutcome": "<p>Creates or updates an outcome. </p>", 30 "UpdateDetectorVersion": "<p> Updates a detector version. The detector version attributes that you can update include models, external model endpoints, rules, and description. You can only update a <code>DRAFT</code> detector version.</p>", 31 "UpdateDetectorVersionMetadata": "<p>Updates the detector version's description. You can update the metadata for any detector version (<code>DRAFT, ACTIVE,</code> or <code>INACTIVE</code>). </p>", 32 "UpdateDetectorVersionStatus": "<p>Updates the detector version’s status. You can perform the following promotions or demotions using <code>UpdateDetectorVersionStatus</code>: <code>DRAFT</code> to <code>ACTIVE</code>, <code>ACTIVE</code> to <code>INACTIVE</code>, and <code>INACTIVE</code> to <code>ACTIVE</code>.</p>", 33 "UpdateModelVersion": "<p>Updates a model version. You can update the description and status attributes using this action. You can perform the following status updates: </p> <ol> <li> <p>Change the <code>TRAINING_COMPLETE</code> status to <code>ACTIVE</code> </p> </li> <li> <p>Change <code>ACTIVE</code> back to <code>TRAINING_COMPLETE</code> </p> </li> </ol>", 34 "UpdateRuleMetadata": "<p>Updates a rule's metadata. </p>", 35 "UpdateRuleVersion": "<p>Updates a rule version resulting in a new rule version. </p>", 36 "UpdateVariable": "<p>Updates a variable.</p>" 37 }, 38 "shapes": { 39 "BatchCreateVariableError": { 40 "base": "<p>Provides the error of the batch create variable API.</p>", 41 "refs": { 42 "BatchCreateVariableErrorList$member": null 43 } 44 }, 45 "BatchCreateVariableErrorList": { 46 "base": null, 47 "refs": { 48 "BatchCreateVariableResult$errors": "<p>Provides the errors for the <code>BatchCreateVariable</code> request.</p>" 49 } 50 }, 51 "BatchCreateVariableRequest": { 52 "base": null, 53 "refs": { 54 } 55 }, 56 "BatchCreateVariableResult": { 57 "base": null, 58 "refs": { 59 } 60 }, 61 "BatchGetVariableError": { 62 "base": "<p>Provides the error of the batch get variable API.</p>", 63 "refs": { 64 "BatchGetVariableErrorList$member": null 65 } 66 }, 67 "BatchGetVariableErrorList": { 68 "base": null, 69 "refs": { 70 "BatchGetVariableResult$errors": "<p>The errors from the request.</p>" 71 } 72 }, 73 "BatchGetVariableRequest": { 74 "base": null, 75 "refs": { 76 } 77 }, 78 "BatchGetVariableResult": { 79 "base": null, 80 "refs": { 81 } 82 }, 83 "ConflictException": { 84 "base": "<p>An exception indicating there was a conflict during a delete operation. The following delete operations can cause a conflict exception:</p> <ul> <li> <p>DeleteDetector: A conflict exception will occur if the detector has associated <code>Rules</code> or <code>DetectorVersions</code>. You can only delete a detector if it has no <code>Rules</code> or <code>DetectorVersions</code>.</p> </li> <li> <p>DeleteDetectorVersion: A conflict exception will occur if the <code>DetectorVersion</code> status is <code>ACTIVE</code>.</p> </li> <li> <p>DeleteRuleVersion: A conflict exception will occur if the <code>RuleVersion</code> is in use by an associated <code>ACTIVE</code> or <code>INACTIVE DetectorVersion</code>.</p> </li> </ul>", 85 "refs": { 86 } 87 }, 88 "CreateDetectorVersionRequest": { 89 "base": null, 90 "refs": { 91 } 92 }, 93 "CreateDetectorVersionResult": { 94 "base": null, 95 "refs": { 96 } 97 }, 98 "CreateModelVersionRequest": { 99 "base": null, 100 "refs": { 101 } 102 }, 103 "CreateModelVersionResult": { 104 "base": null, 105 "refs": { 106 } 107 }, 108 "CreateRuleRequest": { 109 "base": null, 110 "refs": { 111 } 112 }, 113 "CreateRuleResult": { 114 "base": null, 115 "refs": { 116 } 117 }, 118 "CreateVariableRequest": { 119 "base": null, 120 "refs": { 121 } 122 }, 123 "CreateVariableResult": { 124 "base": null, 125 "refs": { 126 } 127 }, 128 "CsvIndexToVariableMap": { 129 "base": null, 130 "refs": { 131 "ModelOutputConfiguration$csvIndexToVariableMap": "<p>A map of CSV index values in the SageMaker response to the Amazon Fraud Detector variables. </p>" 132 } 133 }, 134 "DataSource": { 135 "base": null, 136 "refs": { 137 "CreateVariableRequest$dataSource": "<p>The source of the data.</p>", 138 "Variable$dataSource": "<p>The data source of the variable.</p>" 139 } 140 }, 141 "DataType": { 142 "base": null, 143 "refs": { 144 "CreateVariableRequest$dataType": "<p>The data type.</p>", 145 "Variable$dataType": "<p>The data type of the variable.</p>" 146 } 147 }, 148 "DeleteDetectorRequest": { 149 "base": null, 150 "refs": { 151 } 152 }, 153 "DeleteDetectorResult": { 154 "base": null, 155 "refs": { 156 } 157 }, 158 "DeleteDetectorVersionRequest": { 159 "base": null, 160 "refs": { 161 } 162 }, 163 "DeleteDetectorVersionResult": { 164 "base": null, 165 "refs": { 166 } 167 }, 168 "DeleteEventRequest": { 169 "base": null, 170 "refs": { 171 } 172 }, 173 "DeleteEventResult": { 174 "base": null, 175 "refs": { 176 } 177 }, 178 "DeleteRuleVersionRequest": { 179 "base": null, 180 "refs": { 181 } 182 }, 183 "DeleteRuleVersionResult": { 184 "base": null, 185 "refs": { 186 } 187 }, 188 "DescribeDetectorRequest": { 189 "base": null, 190 "refs": { 191 } 192 }, 193 "DescribeDetectorResult": { 194 "base": null, 195 "refs": { 196 } 197 }, 198 "DescribeModelVersionsRequest": { 199 "base": null, 200 "refs": { 201 } 202 }, 203 "DescribeModelVersionsResult": { 204 "base": null, 205 "refs": { 206 } 207 }, 208 "Detector": { 209 "base": "<p>The detector.</p>", 210 "refs": { 211 "DetectorList$member": null 212 } 213 }, 214 "DetectorList": { 215 "base": null, 216 "refs": { 217 "GetDetectorsResult$detectors": "<p>The detectors.</p>" 218 } 219 }, 220 "DetectorVersionMaxResults": { 221 "base": null, 222 "refs": { 223 "DescribeDetectorRequest$maxResults": "<p>The maximum number of results to return for the request.</p>" 224 } 225 }, 226 "DetectorVersionStatus": { 227 "base": null, 228 "refs": { 229 "CreateDetectorVersionResult$status": "<p>The status of the detector version.</p>", 230 "DetectorVersionSummary$status": "<p>The detector version status. </p>", 231 "GetDetectorVersionResult$status": "<p>The status of the detector version.</p>", 232 "UpdateDetectorVersionStatusRequest$status": "<p>The new status.</p>" 233 } 234 }, 235 "DetectorVersionSummary": { 236 "base": "<p>The summary of the detector version.</p>", 237 "refs": { 238 "DetectorVersionSummaryList$member": null 239 } 240 }, 241 "DetectorVersionSummaryList": { 242 "base": null, 243 "refs": { 244 "DescribeDetectorResult$detectorVersionSummaries": "<p>The status and description for each detector version.</p>" 245 } 246 }, 247 "DetectorsMaxResults": { 248 "base": null, 249 "refs": { 250 "GetDetectorsRequest$maxResults": "<p>The maximum number of objects to return for the request.</p>" 251 } 252 }, 253 "EventAttributeMap": { 254 "base": null, 255 "refs": { 256 "GetPredictionRequest$eventAttributes": "<p>Names of variables you defined in Amazon Fraud Detector to represent event data elements and their corresponding values for the event you are sending for evaluation.</p>" 257 } 258 }, 259 "ExternalModel": { 260 "base": "<p>The Amazon SageMaker model.</p>", 261 "refs": { 262 "ExternalModelList$member": null 263 } 264 }, 265 "ExternalModelEndpointDataBlobMap": { 266 "base": null, 267 "refs": { 268 "GetPredictionRequest$externalModelEndpointDataBlobs": "<p>The Amazon SageMaker model endpoint input data blobs.</p>" 269 } 270 }, 271 "ExternalModelList": { 272 "base": null, 273 "refs": { 274 "GetExternalModelsResult$externalModels": "<p>Gets the Amazon SageMaker models.</p>" 275 } 276 }, 277 "ExternalModelsMaxResults": { 278 "base": null, 279 "refs": { 280 "GetExternalModelsRequest$maxResults": "<p>The maximum number of objects to return for the request.</p>" 281 } 282 }, 283 "GetDetectorVersionRequest": { 284 "base": null, 285 "refs": { 286 } 287 }, 288 "GetDetectorVersionResult": { 289 "base": null, 290 "refs": { 291 } 292 }, 293 "GetDetectorsRequest": { 294 "base": null, 295 "refs": { 296 } 297 }, 298 "GetDetectorsResult": { 299 "base": null, 300 "refs": { 301 } 302 }, 303 "GetExternalModelsRequest": { 304 "base": null, 305 "refs": { 306 } 307 }, 308 "GetExternalModelsResult": { 309 "base": null, 310 "refs": { 311 } 312 }, 313 "GetModelVersionRequest": { 314 "base": null, 315 "refs": { 316 } 317 }, 318 "GetModelVersionResult": { 319 "base": null, 320 "refs": { 321 } 322 }, 323 "GetModelsRequest": { 324 "base": null, 325 "refs": { 326 } 327 }, 328 "GetModelsResult": { 329 "base": null, 330 "refs": { 331 } 332 }, 333 "GetOutcomesRequest": { 334 "base": null, 335 "refs": { 336 } 337 }, 338 "GetOutcomesResult": { 339 "base": null, 340 "refs": { 341 } 342 }, 343 "GetPredictionRequest": { 344 "base": null, 345 "refs": { 346 } 347 }, 348 "GetPredictionResult": { 349 "base": null, 350 "refs": { 351 } 352 }, 353 "GetRulesRequest": { 354 "base": null, 355 "refs": { 356 } 357 }, 358 "GetRulesResult": { 359 "base": null, 360 "refs": { 361 } 362 }, 363 "GetVariablesRequest": { 364 "base": null, 365 "refs": { 366 } 367 }, 368 "GetVariablesResult": { 369 "base": null, 370 "refs": { 371 } 372 }, 373 "InternalServerException": { 374 "base": "<p>An exception indicating an internal server error.</p>", 375 "refs": { 376 } 377 }, 378 "IsOpaque": { 379 "base": null, 380 "refs": { 381 "ModelInputConfiguration$isOpaque": "<p> For an opaque-model, the input to the model will be a ByteBuffer blob provided in the getPrediction request, and will be passed to SageMaker as-is. For non-opaque models, the input will be constructed by Amazon Fraud Detector based on the model-configuration. </p>" 382 } 383 }, 384 "JsonKeyToVariableMap": { 385 "base": null, 386 "refs": { 387 "ModelOutputConfiguration$jsonKeyToVariableMap": "<p>A map of JSON keys in response from SageMaker to the Amazon Fraud Detector variables. </p>" 388 } 389 }, 390 "LabelMapper": { 391 "base": null, 392 "refs": { 393 "LabelSchema$labelMapper": "<p>The label mapper maps the Amazon Fraud Detector supported label to the appropriate source labels. For example, if <code>\"FRAUD\"</code> and <code>\"LEGIT\"</code> are Amazon Fraud Detector supported labels, this mapper could be: <code>{\"FRAUD\" => [\"0\"]</code>, \"LEGIT\" => [\"1\"]} or <code>{\"FRAUD\" => [\"false\"], \"LEGIT\" => [\"true\"]}</code> or <code>{\"FRAUD\" => [\"fraud\", \"abuse\"], \"LEGIT\" => [\"legit\", \"safe\"]}</code>. The value part of the mapper is a list, because you may have multiple variants for a single Amazon Fraud Detector label. </p>" 394 } 395 }, 396 "LabelSchema": { 397 "base": "<p>The label schema.</p>", 398 "refs": { 399 "Model$labelSchema": "<p>The model label schema.</p>", 400 "ModelVersionDetail$labelSchema": "<p>The model label schema.</p>", 401 "PutModelRequest$labelSchema": "<p>The label schema.</p>" 402 } 403 }, 404 "Language": { 405 "base": null, 406 "refs": { 407 "CreateRuleRequest$language": "<p>The language of the rule.</p>", 408 "RuleDetail$language": "<p>The rule language.</p>", 409 "UpdateRuleVersionRequest$language": "<p>The language.</p>" 410 } 411 }, 412 "ListOfModelScores": { 413 "base": null, 414 "refs": { 415 "GetPredictionResult$modelScores": "<p>The model scores for models used in the detector version.</p>" 416 } 417 }, 418 "ListOfModelVersions": { 419 "base": null, 420 "refs": { 421 "CreateDetectorVersionRequest$modelVersions": "<p>The model versions to include in the detector version.</p>", 422 "GetDetectorVersionResult$modelVersions": "<p>The model versions included in the detector version. </p>", 423 "UpdateDetectorVersionRequest$modelVersions": "<p>The model versions to include in the detector version.</p>" 424 } 425 }, 426 "ListOfRuleResults": { 427 "base": null, 428 "refs": { 429 "GetPredictionResult$ruleResults": "<p>The rule results in the prediction.</p>" 430 } 431 }, 432 "ListOfStrings": { 433 "base": null, 434 "refs": { 435 "CreateDetectorVersionRequest$externalModelEndpoints": "<p>The Amazon Sagemaker model endpoints to include in the detector version.</p>", 436 "GetDetectorVersionResult$externalModelEndpoints": "<p>The Amazon SageMaker model endpoints included in the detector version.</p>", 437 "GetPredictionResult$outcomes": "<p>The prediction outcomes.</p>", 438 "LabelMapper$value": null, 439 "RuleResult$outcomes": "<p>The outcomes of the matched rule, based on the rule execution mode.</p>", 440 "UpdateDetectorVersionRequest$externalModelEndpoints": "<p>The Amazon SageMaker model endpoints to include in the detector version.</p>" 441 } 442 }, 443 "MaxResults": { 444 "base": null, 445 "refs": { 446 "DescribeModelVersionsRequest$maxResults": "<p>The maximum number of results to return.</p>", 447 "GetModelsRequest$maxResults": "<p>The maximum results to return for the request.</p>" 448 } 449 }, 450 "MetricsMap": { 451 "base": null, 452 "refs": { 453 "ModelVersionDetail$validationMetrics": "<p>The model validation metrics.</p>", 454 "ModelVersionDetail$trainingMetrics": "<p>The model training metrics.</p>" 455 } 456 }, 457 "Model": { 458 "base": "<p>The model.</p>", 459 "refs": { 460 "ModelList$member": null 461 } 462 }, 463 "ModelEndpointDataBlob": { 464 "base": "<p>A pre-formed Amazon SageMaker model input you can include if your detector version includes an imported Amazon SageMaker model endpoint with pass-through input configuration.</p>", 465 "refs": { 466 "ExternalModelEndpointDataBlobMap$value": null 467 } 468 }, 469 "ModelEndpointStatus": { 470 "base": null, 471 "refs": { 472 "ExternalModel$modelEndpointStatus": "<p>The Amazon Fraud Detector status for the external model endpoint</p>", 473 "PutExternalModelRequest$modelEndpointStatus": "<p>The model endpoint’s status in Amazon Fraud Detector.</p>" 474 } 475 }, 476 "ModelInputConfiguration": { 477 "base": "<p>The model input configuration.</p>", 478 "refs": { 479 "ExternalModel$inputConfiguration": "<p>The input configuration.</p>", 480 "PutExternalModelRequest$inputConfiguration": "<p>The model endpoint input configuration.</p>" 481 } 482 }, 483 "ModelInputDataFormat": { 484 "base": null, 485 "refs": { 486 "ModelInputConfiguration$format": "<p> The format of the model input configuration. The format differs depending on if it is passed through to SageMaker or constructed by Amazon Fraud Detector.</p>" 487 } 488 }, 489 "ModelList": { 490 "base": null, 491 "refs": { 492 "GetModelsResult$models": "<p>The returned models. </p>" 493 } 494 }, 495 "ModelOutputConfiguration": { 496 "base": "<p>Provides the model output configuration.</p>", 497 "refs": { 498 "ExternalModel$outputConfiguration": "<p>The output configuration.</p>", 499 "PutExternalModelRequest$outputConfiguration": "<p>The model endpoint output configuration.</p>" 500 } 501 }, 502 "ModelOutputDataFormat": { 503 "base": null, 504 "refs": { 505 "ModelOutputConfiguration$format": "<p>The format of the model output configuration.</p>" 506 } 507 }, 508 "ModelPredictionMap": { 509 "base": null, 510 "refs": { 511 "ModelScores$scores": "<p>The model's fraud prediction scores.</p>" 512 } 513 }, 514 "ModelScores": { 515 "base": "<p>The fraud prediction scores.</p>", 516 "refs": { 517 "ListOfModelScores$member": null 518 } 519 }, 520 "ModelSource": { 521 "base": null, 522 "refs": { 523 "ExternalModel$modelSource": "<p>The source of the model.</p>", 524 "PutExternalModelRequest$modelSource": "<p>The source of the model.</p>" 525 } 526 }, 527 "ModelTypeEnum": { 528 "base": null, 529 "refs": { 530 "CreateModelVersionRequest$modelType": "<p>The model type.</p>", 531 "CreateModelVersionResult$modelType": "<p>The model type.</p>", 532 "DescribeModelVersionsRequest$modelType": "<p>The model type.</p>", 533 "GetModelVersionRequest$modelType": "<p>The model type. </p>", 534 "GetModelVersionResult$modelType": "<p>The model type. </p>", 535 "GetModelsRequest$modelType": "<p>The model type.</p>", 536 "Model$modelType": "<p>The model type.</p>", 537 "ModelVersion$modelType": "<p>The model type.</p>", 538 "ModelVersionDetail$modelType": "<p>The model type.</p>", 539 "PutModelRequest$modelType": "<p>The model type. </p>", 540 "UpdateModelVersionRequest$modelType": "<p>The model type.</p>" 541 } 542 }, 543 "ModelVariable": { 544 "base": "<p>The model variable.></p>", 545 "refs": { 546 "ModelVariablesList$member": null 547 } 548 }, 549 "ModelVariableIndex": { 550 "base": null, 551 "refs": { 552 "ModelVariable$index": "<p>The model variable's index.></p>" 553 } 554 }, 555 "ModelVariablesList": { 556 "base": null, 557 "refs": { 558 "Model$modelVariables": "<p>The model input variables.</p>", 559 "ModelVersionDetail$modelVariables": "<p>The model variables.</p>", 560 "PutModelRequest$modelVariables": "<p>The model input variables.</p>" 561 } 562 }, 563 "ModelVersion": { 564 "base": "<p>The model version.</p>", 565 "refs": { 566 "ListOfModelVersions$member": null, 567 "ModelScores$modelVersion": "<p>The model version.</p>" 568 } 569 }, 570 "ModelVersionDetail": { 571 "base": "<p>Provides the model version details. </p>", 572 "refs": { 573 "ModelVersionDetailList$member": null 574 } 575 }, 576 "ModelVersionDetailList": { 577 "base": null, 578 "refs": { 579 "DescribeModelVersionsResult$modelVersionDetails": "<p>The model version details.</p>" 580 } 581 }, 582 "ModelVersionStatus": { 583 "base": null, 584 "refs": { 585 "UpdateModelVersionRequest$status": "<p>The new model status.</p>" 586 } 587 }, 588 "NameList": { 589 "base": null, 590 "refs": { 591 "BatchGetVariableRequest$names": "<p>The list of variable names to get.</p>" 592 } 593 }, 594 "NonEmptyListOfStrings": { 595 "base": null, 596 "refs": { 597 "CreateRuleRequest$outcomes": "<p>The outcome or outcomes returned when the rule expression matches.</p>", 598 "RuleDetail$outcomes": "<p>The rule outcomes.</p>", 599 "UpdateRuleVersionRequest$outcomes": "<p>The outcomes.</p>" 600 } 601 }, 602 "Outcome": { 603 "base": "<p>The outcome.</p>", 604 "refs": { 605 "OutcomeList$member": null 606 } 607 }, 608 "OutcomeList": { 609 "base": null, 610 "refs": { 611 "GetOutcomesResult$outcomes": "<p>The outcomes. </p>" 612 } 613 }, 614 "OutcomesMaxResults": { 615 "base": null, 616 "refs": { 617 "GetOutcomesRequest$maxResults": "<p>The maximum number of objects to return for the request. </p>" 618 } 619 }, 620 "PutDetectorRequest": { 621 "base": null, 622 "refs": { 623 } 624 }, 625 "PutDetectorResult": { 626 "base": null, 627 "refs": { 628 } 629 }, 630 "PutExternalModelRequest": { 631 "base": null, 632 "refs": { 633 } 634 }, 635 "PutExternalModelResult": { 636 "base": null, 637 "refs": { 638 } 639 }, 640 "PutModelRequest": { 641 "base": null, 642 "refs": { 643 } 644 }, 645 "PutModelResult": { 646 "base": null, 647 "refs": { 648 } 649 }, 650 "PutOutcomeRequest": { 651 "base": null, 652 "refs": { 653 } 654 }, 655 "PutOutcomeResult": { 656 "base": null, 657 "refs": { 658 } 659 }, 660 "ResourceNotFoundException": { 661 "base": "<p>An exception indicating the specified resource was not found.</p>", 662 "refs": { 663 } 664 }, 665 "Role": { 666 "base": "<p>The role used to invoke external model endpoints.</p>", 667 "refs": { 668 "ExternalModel$role": "<p>The role used to invoke the model. </p>", 669 "PutExternalModelRequest$role": "<p>The IAM role used to invoke the model endpoint.</p>" 670 } 671 }, 672 "Rule": { 673 "base": "<p>A rule.</p>", 674 "refs": { 675 "CreateRuleResult$rule": "<p>The created rule.</p>", 676 "RuleList$member": null, 677 "UpdateRuleMetadataRequest$rule": "<p>The rule to update.</p>", 678 "UpdateRuleVersionRequest$rule": "<p>The rule to update.</p>", 679 "UpdateRuleVersionResult$rule": "<p>The new rule version that was created.</p>" 680 } 681 }, 682 "RuleDetail": { 683 "base": "<p>The details of the rule.</p>", 684 "refs": { 685 "RuleDetailList$member": null 686 } 687 }, 688 "RuleDetailList": { 689 "base": null, 690 "refs": { 691 "GetRulesResult$ruleDetails": "<p>The details of the requested rule.</p>" 692 } 693 }, 694 "RuleExecutionMode": { 695 "base": null, 696 "refs": { 697 "CreateDetectorVersionRequest$ruleExecutionMode": "<p>The rule execution mode for the rules included in the detector version.</p> <p>You can define and edit the rule mode at the detector version level, when it is in draft status.</p> <p>If you specify <code>FIRST_MATCHED</code>, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.</p> <p>If you specifiy <code>ALL_MATCHED</code>, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. </p> <p>The default behavior is <code>FIRST_MATCHED</code>.</p>", 698 "GetDetectorVersionResult$ruleExecutionMode": "<p>The execution mode of the rule in the dectector</p> <p> <code>FIRST_MATCHED</code> indicates that Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.</p> <p> <code>ALL_MATCHED</code> indicates that Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status.</p>", 699 "UpdateDetectorVersionRequest$ruleExecutionMode": "<p>The rule execution mode to add to the detector.</p> <p>If you specify <code>FIRST_MATCHED</code>, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.</p> <p>If you specifiy <code>ALL_MATCHED</code>, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status.</p> <p>The default behavior is <code>FIRST_MATCHED</code>.</p>" 700 } 701 }, 702 "RuleList": { 703 "base": null, 704 "refs": { 705 "CreateDetectorVersionRequest$rules": "<p>The rules to include in the detector version.</p>", 706 "GetDetectorVersionResult$rules": "<p>The rules included in the detector version.</p>", 707 "UpdateDetectorVersionRequest$rules": "<p>The rules to include in the detector version.</p>" 708 } 709 }, 710 "RuleResult": { 711 "base": "<p>The rule results.</p>", 712 "refs": { 713 "ListOfRuleResults$member": null 714 } 715 }, 716 "RulesMaxResults": { 717 "base": null, 718 "refs": { 719 "GetRulesRequest$maxResults": "<p>The maximum number of rules to return for the request.</p>" 720 } 721 }, 722 "ThrottlingException": { 723 "base": "<p>An exception indicating a throttling error.</p>", 724 "refs": { 725 } 726 }, 727 "TrainingDataSource": { 728 "base": "<p>The training data source.</p>", 729 "refs": { 730 "Model$trainingDataSource": "<p>The model training data source in Amazon S3.</p>", 731 "ModelVersionDetail$trainingDataSource": "<p>The model training data source.</p>", 732 "PutModelRequest$trainingDataSource": "<p>The training data source location in Amazon S3. </p>" 733 } 734 }, 735 "UpdateDetectorVersionMetadataRequest": { 736 "base": null, 737 "refs": { 738 } 739 }, 740 "UpdateDetectorVersionMetadataResult": { 741 "base": null, 742 "refs": { 743 } 744 }, 745 "UpdateDetectorVersionRequest": { 746 "base": null, 747 "refs": { 748 } 749 }, 750 "UpdateDetectorVersionResult": { 751 "base": null, 752 "refs": { 753 } 754 }, 755 "UpdateDetectorVersionStatusRequest": { 756 "base": null, 757 "refs": { 758 } 759 }, 760 "UpdateDetectorVersionStatusResult": { 761 "base": null, 762 "refs": { 763 } 764 }, 765 "UpdateModelVersionRequest": { 766 "base": null, 767 "refs": { 768 } 769 }, 770 "UpdateModelVersionResult": { 771 "base": null, 772 "refs": { 773 } 774 }, 775 "UpdateRuleMetadataRequest": { 776 "base": null, 777 "refs": { 778 } 779 }, 780 "UpdateRuleMetadataResult": { 781 "base": null, 782 "refs": { 783 } 784 }, 785 "UpdateRuleVersionRequest": { 786 "base": null, 787 "refs": { 788 } 789 }, 790 "UpdateRuleVersionResult": { 791 "base": null, 792 "refs": { 793 } 794 }, 795 "UpdateVariableRequest": { 796 "base": null, 797 "refs": { 798 } 799 }, 800 "UpdateVariableResult": { 801 "base": null, 802 "refs": { 803 } 804 }, 805 "ValidationException": { 806 "base": "<p>An exception indicating a specified value is not allowed.</p>", 807 "refs": { 808 } 809 }, 810 "Variable": { 811 "base": "<p>The variable.</p>", 812 "refs": { 813 "VariableList$member": null 814 } 815 }, 816 "VariableEntry": { 817 "base": "<p>The variable entry in a list.</p>", 818 "refs": { 819 "VariableEntryList$member": null 820 } 821 }, 822 "VariableEntryList": { 823 "base": null, 824 "refs": { 825 "BatchCreateVariableRequest$variableEntries": "<p>The list of variables for the batch create variable request.</p>" 826 } 827 }, 828 "VariableList": { 829 "base": null, 830 "refs": { 831 "BatchGetVariableResult$variables": "<p>The returned variables.</p>", 832 "GetVariablesResult$variables": "<p>The names of the variables returned. </p>" 833 } 834 }, 835 "VariablesMaxResults": { 836 "base": null, 837 "refs": { 838 "GetVariablesRequest$maxResults": "<p>The max size per page determined for the get variable request. </p>" 839 } 840 }, 841 "attributeKey": { 842 "base": null, 843 "refs": { 844 "EventAttributeMap$key": null 845 } 846 }, 847 "attributeValue": { 848 "base": null, 849 "refs": { 850 "EventAttributeMap$value": null 851 } 852 }, 853 "blob": { 854 "base": null, 855 "refs": { 856 "ModelEndpointDataBlob$byteBuffer": "<p>The byte buffer of the Amazon SageMaker model endpoint input data blob.</p>" 857 } 858 }, 859 "contentType": { 860 "base": null, 861 "refs": { 862 "ModelEndpointDataBlob$contentType": "<p>The content type of the Amazon SageMaker model endpoint input data blob. </p>" 863 } 864 }, 865 "description": { 866 "base": null, 867 "refs": { 868 "CreateDetectorVersionRequest$description": "<p>The description of the detector version.</p>", 869 "CreateModelVersionRequest$description": "<p>The model version description.</p>", 870 "CreateRuleRequest$description": "<p>The rule description.</p>", 871 "Detector$description": "<p>The detector description.</p>", 872 "DetectorVersionSummary$description": "<p>The detector version description. </p>", 873 "GetDetectorVersionResult$description": "<p>The detector version description.</p>", 874 "GetModelVersionResult$description": "<p>The model version description.</p>", 875 "Model$description": "<p>The model description.</p>", 876 "ModelVersionDetail$description": "<p>The model description.</p>", 877 "Outcome$description": "<p>The outcome description.</p>", 878 "PutDetectorRequest$description": "<p>The description of the detector.</p>", 879 "PutModelRequest$description": "<p>The model description. </p>", 880 "PutOutcomeRequest$description": "<p>The outcome description.</p>", 881 "RuleDetail$description": "<p>The rule description.</p>", 882 "UpdateDetectorVersionMetadataRequest$description": "<p>The description.</p>", 883 "UpdateDetectorVersionRequest$description": "<p>The detector version description. </p>", 884 "UpdateModelVersionRequest$description": "<p>The model description.</p>", 885 "UpdateRuleMetadataRequest$description": "<p>The rule description.</p>", 886 "UpdateRuleVersionRequest$description": "<p>The description.</p>" 887 } 888 }, 889 "float": { 890 "base": null, 891 "refs": { 892 "ModelPredictionMap$value": null 893 } 894 }, 895 "iamRoleArn": { 896 "base": null, 897 "refs": { 898 "TrainingDataSource$dataAccessRoleArn": "<p>The data access role ARN for the training data source.</p>" 899 } 900 }, 901 "identifier": { 902 "base": null, 903 "refs": { 904 "CreateDetectorVersionRequest$detectorId": "<p>The ID of the detector under which you want to create a new version.</p>", 905 "CreateDetectorVersionResult$detectorId": "<p>The ID for the created version's parent detector.</p>", 906 "CreateModelVersionRequest$modelId": "<p>The model ID. </p>", 907 "CreateModelVersionResult$modelId": "<p>The model ID. </p>", 908 "CreateRuleRequest$ruleId": "<p>The rule ID.</p>", 909 "CreateRuleRequest$detectorId": "<p>The detector ID for the rule's parent detector.</p>", 910 "DeleteDetectorRequest$detectorId": "<p>The ID of the detector to delete.</p>", 911 "DeleteDetectorVersionRequest$detectorId": "<p>The ID of the parent detector for the detector version to delete.</p>", 912 "DeleteRuleVersionRequest$detectorId": "<p>The ID of the detector that includes the rule version to delete.</p>", 913 "DeleteRuleVersionRequest$ruleId": "<p>The rule ID of the rule version to delete.</p>", 914 "DescribeDetectorRequest$detectorId": "<p>The detector ID.</p>", 915 "DescribeDetectorResult$detectorId": "<p>The detector ID.</p>", 916 "DescribeModelVersionsRequest$modelId": "<p>The model ID.</p>", 917 "Detector$detectorId": "<p>The detector ID.</p>", 918 "GetDetectorVersionRequest$detectorId": "<p>The detector ID.</p>", 919 "GetDetectorVersionResult$detectorId": "<p>The detector ID.</p>", 920 "GetDetectorsRequest$detectorId": "<p>The detector ID.</p>", 921 "GetModelVersionRequest$modelId": "<p>The model ID. </p>", 922 "GetModelVersionResult$modelId": "<p>The model ID. </p>", 923 "GetModelsRequest$modelId": "<p>The model ID.</p>", 924 "GetOutcomesRequest$name": "<p>The name of the outcome or outcomes to get.</p>", 925 "GetRulesRequest$ruleId": "<p>The rule ID.</p>", 926 "GetRulesRequest$detectorId": "<p>The detector ID.</p>", 927 "Model$modelId": "<p>The model ID.</p>", 928 "ModelVersion$modelId": "<p>The parent model ID.</p>", 929 "ModelVersionDetail$modelId": "<p>The model ID.</p>", 930 "Outcome$name": "<p>The outcome name.</p>", 931 "PutDetectorRequest$detectorId": "<p>The detector ID. </p>", 932 "PutModelRequest$modelId": "<p>The model ID.</p>", 933 "PutOutcomeRequest$name": "<p>The name of the outcome.</p>", 934 "Rule$detectorId": "<p>The detector for which the rule is associated.</p>", 935 "Rule$ruleId": "<p>The rule ID.</p>", 936 "RuleDetail$ruleId": "<p>The rule ID.</p>", 937 "RuleDetail$detectorId": "<p>The detector for which the rule is associated.</p>", 938 "UpdateDetectorVersionMetadataRequest$detectorId": "<p>The detector ID.</p>", 939 "UpdateDetectorVersionRequest$detectorId": "<p>The parent detector ID for the detector version you want to update.</p>", 940 "UpdateDetectorVersionStatusRequest$detectorId": "<p>The detector ID. </p>", 941 "UpdateModelVersionRequest$modelId": "<p>The model ID.</p>" 942 } 943 }, 944 "integer": { 945 "base": null, 946 "refs": { 947 "BatchCreateVariableError$code": "<p>The error code. </p>", 948 "BatchGetVariableError$code": "<p>The error code. </p>" 949 } 950 }, 951 "nonEmptyString": { 952 "base": null, 953 "refs": { 954 "CreateDetectorVersionResult$detectorVersionId": "<p>The ID for the created detector. </p>", 955 "CreateModelVersionResult$modelVersionNumber": "<p>The version of the model. </p>", 956 "DeleteDetectorVersionRequest$detectorVersionId": "<p>The ID of the detector version to delete.</p>", 957 "DeleteRuleVersionRequest$ruleVersion": "<p>The rule version to delete.</p>", 958 "DescribeModelVersionsRequest$modelVersionNumber": "<p>The model version. </p>", 959 "DetectorVersionSummary$detectorVersionId": "<p>The detector version ID. </p>", 960 "GetDetectorVersionRequest$detectorVersionId": "<p>The detector version ID.</p>", 961 "GetDetectorVersionResult$detectorVersionId": "<p>The detector version ID.</p>", 962 "GetModelVersionRequest$modelVersionNumber": "<p>The model version. </p>", 963 "GetModelVersionResult$modelVersionNumber": "<p>The model version. </p>", 964 "GetRulesRequest$ruleVersion": "<p>The rule version.</p>", 965 "ModelVersion$modelVersionNumber": "<p>The model version.</p>", 966 "ModelVersionDetail$modelVersionNumber": "<p>The model version.</p>", 967 "Rule$ruleVersion": "<p>The rule version.</p>", 968 "RuleDetail$ruleVersion": "<p>The rule version.</p>", 969 "UpdateDetectorVersionMetadataRequest$detectorVersionId": "<p>The detector version ID. </p>", 970 "UpdateDetectorVersionRequest$detectorVersionId": "<p>The detector version ID. </p>", 971 "UpdateDetectorVersionStatusRequest$detectorVersionId": "<p>The detector version ID. </p>", 972 "UpdateModelVersionRequest$modelVersionNumber": "<p>The model version.</p>" 973 } 974 }, 975 "ruleExpression": { 976 "base": null, 977 "refs": { 978 "CreateRuleRequest$expression": "<p>The rule expression.</p>", 979 "RuleDetail$expression": "<p>The rule expression.</p>", 980 "UpdateRuleVersionRequest$expression": "<p>The rule expression.</p>" 981 } 982 }, 983 "s3BucketLocation": { 984 "base": null, 985 "refs": { 986 "TrainingDataSource$dataLocation": "<p>The data location of the training data source.</p>" 987 } 988 }, 989 "string": { 990 "base": null, 991 "refs": { 992 "BatchCreateVariableError$name": "<p>The name.</p>", 993 "BatchCreateVariableError$message": "<p>The error message.</p>", 994 "BatchGetVariableError$name": "<p>The error name. </p>", 995 "BatchGetVariableError$message": "<p>The error message.</p>", 996 "ConflictException$message": null, 997 "CreateModelVersionResult$status": "<p>The model version status. </p>", 998 "CreateVariableRequest$name": "<p>The name of the variable.</p>", 999 "CreateVariableRequest$defaultValue": "<p>The default value for the variable when no value is received.</p>", 1000 "CreateVariableRequest$description": "<p>The description.</p>", 1001 "CreateVariableRequest$variableType": "<p>The variable type.</p>", 1002 "CsvIndexToVariableMap$key": null, 1003 "CsvIndexToVariableMap$value": null, 1004 "DeleteEventRequest$eventId": "<p>The ID of the event to delete.</p>", 1005 "DescribeDetectorRequest$nextToken": "<p>The next token from the previous response.</p>", 1006 "DescribeDetectorResult$nextToken": "<p>The next token to be used for subsequent requests.</p>", 1007 "DescribeModelVersionsRequest$nextToken": "<p>The next token from the previous results.</p>", 1008 "DescribeModelVersionsResult$nextToken": "<p>The next token.</p>", 1009 "ExternalModel$modelEndpoint": "<p>The Amazon SageMaker model endpoints.</p>", 1010 "ExternalModelEndpointDataBlobMap$key": null, 1011 "GetDetectorsRequest$nextToken": "<p>The next token for the subsequent request.</p>", 1012 "GetDetectorsResult$nextToken": "<p>The next page token.</p>", 1013 "GetExternalModelsRequest$modelEndpoint": "<p>The Amazon SageMaker model endpoint.</p>", 1014 "GetExternalModelsRequest$nextToken": "<p>The next page token for the request.</p>", 1015 "GetExternalModelsResult$nextToken": "<p>The next page token to be used in subsequent requests.</p>", 1016 "GetModelVersionResult$status": "<p>The model version status. </p>", 1017 "GetModelsRequest$nextToken": "<p>The next token for the request.</p>", 1018 "GetModelsResult$nextToken": "<p>The next token for subsequent requests. </p>", 1019 "GetOutcomesRequest$nextToken": "<p>The next page token for the request. </p>", 1020 "GetOutcomesResult$nextToken": "<p>The next page token for subsequent requests.</p>", 1021 "GetPredictionRequest$detectorId": "<p>The detector ID. </p>", 1022 "GetPredictionRequest$detectorVersionId": "<p>The detector version ID.</p>", 1023 "GetPredictionRequest$eventId": "<p>The unique ID used to identify the event.</p>", 1024 "GetRulesRequest$nextToken": "<p>The next page token.</p>", 1025 "GetRulesResult$nextToken": "<p>The next page token to be used in subsequent requests.</p>", 1026 "GetVariablesRequest$name": "<p>The name of the variable. </p>", 1027 "GetVariablesRequest$nextToken": "<p>The next page token of the get variable request. </p>", 1028 "GetVariablesResult$nextToken": "<p>The next page token to be used in subsequent requests. </p>", 1029 "InternalServerException$message": null, 1030 "JsonKeyToVariableMap$key": null, 1031 "JsonKeyToVariableMap$value": null, 1032 "LabelMapper$key": null, 1033 "LabelSchema$labelKey": "<p>The label key.</p>", 1034 "ListOfStrings$member": null, 1035 "MetricsMap$key": null, 1036 "MetricsMap$value": null, 1037 "ModelInputConfiguration$jsonInputTemplate": "<p> Template for constructing the JSON input-data sent to SageMaker. At event-evaluation, the placeholders for variable names in the template will be replaced with the variable values before being sent to SageMaker. </p>", 1038 "ModelInputConfiguration$csvInputTemplate": "<p> Template for constructing the CSV input-data sent to SageMaker. At event-evaluation, the placeholders for variable-names in the template will be replaced with the variable values before being sent to SageMaker. </p>", 1039 "ModelPredictionMap$key": null, 1040 "ModelVariable$name": "<p>The model variable's name.></p>", 1041 "ModelVersionDetail$status": "<p>The model status.</p>", 1042 "NameList$member": null, 1043 "NonEmptyListOfStrings$member": null, 1044 "PutExternalModelRequest$modelEndpoint": "<p>The model endpoints name.</p>", 1045 "ResourceNotFoundException$message": null, 1046 "Role$arn": "<p>The role ARN.</p>", 1047 "Role$name": "<p>The role name.</p>", 1048 "RuleResult$ruleId": "<p>The rule ID that was matched, based on the rule execution mode.</p>", 1049 "ThrottlingException$message": null, 1050 "UpdateVariableRequest$name": "<p>The name of the variable.</p>", 1051 "UpdateVariableRequest$defaultValue": "<p>The new default value of the variable.</p>", 1052 "UpdateVariableRequest$description": "<p>The new description.</p>", 1053 "UpdateVariableRequest$variableType": "<p>The variable type.</p>", 1054 "ValidationException$message": null, 1055 "Variable$name": "<p>The name of the variable.</p>", 1056 "Variable$defaultValue": "<p>The default value of the variable.</p>", 1057 "Variable$description": "<p>The description of the variable. </p>", 1058 "Variable$variableType": "<p>The variable type of the variable.</p>", 1059 "VariableEntry$name": "<p>The name of the variable entry.</p>", 1060 "VariableEntry$dataType": "<p>The data type of the variable entry.</p>", 1061 "VariableEntry$dataSource": "<p>The data source of the variable entry.</p>", 1062 "VariableEntry$defaultValue": "<p>The default value of the variable entry.</p>", 1063 "VariableEntry$description": "<p>The description of the variable entry.</p>", 1064 "VariableEntry$variableType": "<p>The type of the variable entry.</p>" 1065 } 1066 }, 1067 "time": { 1068 "base": null, 1069 "refs": { 1070 "Detector$lastUpdatedTime": "<p>Timestamp of when the detector was last updated.</p>", 1071 "Detector$createdTime": "<p>Timestamp of when the detector was created.</p>", 1072 "DetectorVersionSummary$lastUpdatedTime": "<p>Timestamp of when the detector version was last updated.</p>", 1073 "ExternalModel$lastUpdatedTime": "<p>Timestamp of when the model was last updated.</p>", 1074 "ExternalModel$createdTime": "<p>Timestamp of when the model was last created.</p>", 1075 "GetDetectorVersionResult$lastUpdatedTime": "<p>The timestamp when the detector version was last updated. </p>", 1076 "GetDetectorVersionResult$createdTime": "<p>The timestamp when the detector version was created. </p>", 1077 "Model$lastUpdatedTime": "<p>Timestamp of last time the model was updated.</p>", 1078 "Model$createdTime": "<p>Timestamp of when the model was created.</p>", 1079 "ModelVersionDetail$lastUpdatedTime": "<p>The timestamp when the model was last updated.</p>", 1080 "ModelVersionDetail$createdTime": "<p>The timestamp when the model was created.</p>", 1081 "Outcome$lastUpdatedTime": "<p>The timestamp when the outcome was last updated.</p>", 1082 "Outcome$createdTime": "<p>The timestamp when the outcome was created.</p>", 1083 "RuleDetail$lastUpdatedTime": "<p>Timestamp of the last time the rule was updated.</p>", 1084 "RuleDetail$createdTime": "<p>The timestamp of when the rule was created.</p>", 1085 "Variable$lastUpdatedTime": "<p>The time when variable was last updated.</p>", 1086 "Variable$createdTime": "<p>The time when the variable was created.</p>" 1087 } 1088 } 1089 } 1090} 1091