Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateDetectorVersion

Creates a detector version. The detector version starts in a DRAFT status.

Request Syntax


{
   "description": "string",
   "detectorId": "string",
   "externalModelEndpoints": [ "string" ],
   "modelVersions": [ 
      { 
         "arn": "string",
         "modelId": "string",
         "modelType": "string",
         "modelVersionNumber": "string"
      }
   ],
   "ruleExecutionMode": "string",
   "rules": [ 
      { 
         "detectorId": "string",
         "ruleId": "string",
         "ruleVersion": "string"
      }
   ],
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

description

The description of the detector version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

detectorId

The ID of the detector under which you want to create a new version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[0-9a-z_-]+$

Required: Yes

externalModelEndpoints

The Amazon Sagemaker model endpoints to include in the detector version.

Type: Array of strings

Required: No

modelVersions

The model versions to include in the detector version.

Type: Array of ModelVersion objects

Required: No

ruleExecutionMode

The rule execution mode for the rules included in the detector version.

You can define and edit the rule mode at the detector version level, when it is in draft status.

If you specify FIRST_MATCHED, 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.

If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules.

The default behavior is FIRST_MATCHED.

Type: String

Valid Values: ALL_MATCHED | FIRST_MATCHED

Required: No

rules

The rules to include in the detector version.

Type: Array of Rule objects

Required: Yes

tags

A collection of key and value pairs.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Syntax


{
   "detectorId": "string",
   "detectorVersionId": "string",
   "status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

detectorId

The ID for the created version's parent detector.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[0-9a-z_-]+$

detectorVersionId

The ID for the created detector.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 5.

Pattern: ^([1-9][0-9]*)$

status

The status of the detector version.

Type: String

Valid Values: DRAFT | ACTIVE | INACTIVE

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

HTTP Status Code: 400

InternalServerException

An exception indicating an internal server error.

HTTP Status Code: 500

ResourceNotFoundException

An exception indicating the specified resource was not found.

HTTP Status Code: 400

ThrottlingException

An exception indicating a throttling error.

HTTP Status Code: 400

ValidationException

An exception indicating a specified value is not allowed.

HTTP Status Code: 400