FraudDetector / Client / update_detector_version

update_detector_version#

FraudDetector.Client.update_detector_version(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.update_detector_version(
    detectorId='string',
    detectorVersionId='string',
    externalModelEndpoints=[
        'string',
    ],
    rules=[
        {
            'detectorId': 'string',
            'ruleId': 'string',
            'ruleVersion': 'string'
        },
    ],
    description='string',
    modelVersions=[
        {
            'modelId': 'string',
            'modelType': 'ONLINE_FRAUD_INSIGHTS'|'TRANSACTION_FRAUD_INSIGHTS'|'ACCOUNT_TAKEOVER_INSIGHTS',
            'modelVersionNumber': 'string',
            'arn': 'string'
        },
    ],
    ruleExecutionMode='ALL_MATCHED'|'FIRST_MATCHED'
)
Parameters:

  • detectorId (string) –

    [REQUIRED]

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

  • detectorVersionId (string) –

    [REQUIRED]

    The detector version ID.

  • externalModelEndpoints (list) –

    [REQUIRED]

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

    • (string) –

  • rules (list) –

    [REQUIRED]

    The rules to include in the detector version.

    • (dict) –

      A rule.

      • detectorId (string) – [REQUIRED]

        The detector for which the rule is associated.

      • ruleId (string) – [REQUIRED]

        The rule ID.

      • ruleVersion (string) – [REQUIRED]

        The rule version.

  • description (string) – The detector version description.

  • modelVersions (list) –

    The model versions to include in the detector version.

    • (dict) –

      The model version.

      • modelId (string) – [REQUIRED]

        The model ID.

      • modelType (string) – [REQUIRED]

        The model type.

      • modelVersionNumber (string) – [REQUIRED]

        The model version number.

      • arn (string) –

        The model version ARN.

  • ruleExecutionMode (string) –

    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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions