|
8 | 8 | "CreateModelVersion": "<p>Creates a version of the model using the specified model type. </p>", |
9 | 9 | "CreateRule": "<p>Creates a rule for use with the specified detector. </p>", |
10 | 10 | "CreateVariable": "<p>Creates a variable.</p>", |
11 | | - "DeleteDetectorVersion": "<p>Deletes the detector version.</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>", |
12 | 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>", |
13 | 15 | "DescribeDetector": "<p>Gets all versions for a specified detector.</p>", |
14 | 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>", |
15 | 17 | "GetDetectorVersion": "<p>Gets a particular detector version. </p>", |
|
78 | 80 | "refs": { |
79 | 81 | } |
80 | 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 | + }, |
81 | 88 | "CreateDetectorVersionRequest": { |
82 | 89 | "base": null, |
83 | 90 | "refs": { |
|
138 | 145 | "Variable$dataType": "<p>The data type of the variable.</p>" |
139 | 146 | } |
140 | 147 | }, |
| 148 | + "DeleteDetectorRequest": { |
| 149 | + "base": null, |
| 150 | + "refs": { |
| 151 | + } |
| 152 | + }, |
| 153 | + "DeleteDetectorResult": { |
| 154 | + "base": null, |
| 155 | + "refs": { |
| 156 | + } |
| 157 | + }, |
141 | 158 | "DeleteDetectorVersionRequest": { |
142 | 159 | "base": null, |
143 | 160 | "refs": { |
|
158 | 175 | "refs": { |
159 | 176 | } |
160 | 177 | }, |
| 178 | + "DeleteRuleVersionRequest": { |
| 179 | + "base": null, |
| 180 | + "refs": { |
| 181 | + } |
| 182 | + }, |
| 183 | + "DeleteRuleVersionResult": { |
| 184 | + "base": null, |
| 185 | + "refs": { |
| 186 | + } |
| 187 | + }, |
161 | 188 | "DescribeDetectorRequest": { |
162 | 189 | "base": null, |
163 | 190 | "refs": { |
|
396 | 423 | "UpdateDetectorVersionRequest$modelVersions": "<p>The model versions to include in the detector version.</p>" |
397 | 424 | } |
398 | 425 | }, |
| 426 | + "ListOfRuleResults": { |
| 427 | + "base": null, |
| 428 | + "refs": { |
| 429 | + "GetPredictionResult$ruleResults": "<p>The rule results in the prediction.</p>" |
| 430 | + } |
| 431 | + }, |
399 | 432 | "ListOfStrings": { |
400 | 433 | "base": null, |
401 | 434 | "refs": { |
402 | 435 | "CreateDetectorVersionRequest$externalModelEndpoints": "<p>The Amazon Sagemaker model endpoints to include in the detector version.</p>", |
403 | 436 | "GetDetectorVersionResult$externalModelEndpoints": "<p>The Amazon SageMaker model endpoints included in the detector version.</p>", |
404 | 437 | "GetPredictionResult$outcomes": "<p>The prediction outcomes.</p>", |
405 | 438 | "LabelMapper$value": null, |
| 439 | + "RuleResult$outcomes": "<p>The outcomes of the matched rule, based on the rule execution mode.</p>", |
406 | 440 | "UpdateDetectorVersionRequest$externalModelEndpoints": "<p>The Amazon SageMaker model endpoints to include in the detector version.</p>" |
407 | 441 | } |
408 | 442 | }, |
|
657 | 691 | "GetRulesResult$ruleDetails": "<p>The details of the requested rule.</p>" |
658 | 692 | } |
659 | 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 | + }, |
660 | 702 | "RuleList": { |
661 | 703 | "base": null, |
662 | 704 | "refs": { |
|
665 | 707 | "UpdateDetectorVersionRequest$rules": "<p>The rules to include in the detector version.</p>" |
666 | 708 | } |
667 | 709 | }, |
| 710 | + "RuleResult": { |
| 711 | + "base": "<p>The rule results.</p>", |
| 712 | + "refs": { |
| 713 | + "ListOfRuleResults$member": null |
| 714 | + } |
| 715 | + }, |
668 | 716 | "RulesMaxResults": { |
669 | 717 | "base": null, |
670 | 718 | "refs": { |
|
859 | 907 | "CreateModelVersionResult$modelId": "<p>The model ID. </p>", |
860 | 908 | "CreateRuleRequest$ruleId": "<p>The rule ID.</p>", |
861 | 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>", |
862 | 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>", |
863 | 914 | "DescribeDetectorRequest$detectorId": "<p>The detector ID.</p>", |
864 | 915 | "DescribeDetectorResult$detectorId": "<p>The detector ID.</p>", |
865 | 916 | "DescribeModelVersionsRequest$modelId": "<p>The model ID.</p>", |
|
903 | 954 | "CreateDetectorVersionResult$detectorVersionId": "<p>The ID for the created detector. </p>", |
904 | 955 | "CreateModelVersionResult$modelVersionNumber": "<p>The version of the model. </p>", |
905 | 956 | "DeleteDetectorVersionRequest$detectorVersionId": "<p>The ID of the detector version to delete.</p>", |
| 957 | + "DeleteRuleVersionRequest$ruleVersion": "<p>The rule version to delete.</p>", |
906 | 958 | "DescribeModelVersionsRequest$modelVersionNumber": "<p>The model version. </p>", |
907 | 959 | "DetectorVersionSummary$detectorVersionId": "<p>The detector version ID. </p>", |
908 | 960 | "GetDetectorVersionRequest$detectorVersionId": "<p>The detector version ID.</p>", |
|
941 | 993 | "BatchCreateVariableError$message": "<p>The error message.</p>", |
942 | 994 | "BatchGetVariableError$name": "<p>The error name. </p>", |
943 | 995 | "BatchGetVariableError$message": "<p>The error message.</p>", |
| 996 | + "ConflictException$message": null, |
944 | 997 | "CreateModelVersionResult$status": "<p>The model version status. </p>", |
945 | 998 | "CreateVariableRequest$name": "<p>The name of the variable.</p>", |
946 | 999 | "CreateVariableRequest$defaultValue": "<p>The default value for the variable when no value is received.</p>", |
|
992 | 1045 | "ResourceNotFoundException$message": null, |
993 | 1046 | "Role$arn": "<p>The role ARN.</p>", |
994 | 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>", |
995 | 1049 | "ThrottlingException$message": null, |
996 | 1050 | "UpdateVariableRequest$name": "<p>The name of the variable.</p>", |
997 | 1051 | "UpdateVariableRequest$defaultValue": "<p>The new default value of the variable.</p>", |
|
0 commit comments