UpdateDetectorVersion - Amazon Fraud Detector

UpdateDetectorVersion

Updates a detector version. The detector version attributes that you can update include models, external model endpoints, rules, rule execution mode, and description. You can only update a DRAFT detector version.

Request Syntax

{ "description": "string", "detectorId": "string", "detectorVersionId": "string", "externalModelEndpoints": [ "string" ], "modelVersions": [ { "arn": "string", "modelId": "string", "modelType": "string", "modelVersionNumber": "string" } ], "ruleExecutionMode": "string", "rules": [ { "detectorId": "string", "ruleId": "string", "ruleVersion": "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 detector version description.

Type: String

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

Required: No

detectorId

The parent detector ID for the detector version you want to update.

Type: String

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

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

Required: Yes

detectorVersionId

The detector version ID.

Type: String

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

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

Required: Yes

externalModelEndpoints

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

Type: Array of strings

Required: Yes

modelVersions

The model versions to include in the detector version.

Type: Array of ModelVersion objects

Required: No

ruleExecutionMode

The rule execution mode to add to the detector.

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. You can define and edit the rule mode at the detector version level, when it is in draft status.

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

Response Elements

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

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: