UpdateRuleVersionCommand

Suggest an Edit

Updates a rule version resulting in a new rule version. Updates a rule version resulting in a new rule version (version 1, 2, 3 ...).

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { FraudDetectorClient, UpdateRuleVersionCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import
// const { FraudDetectorClient, UpdateRuleVersionCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import
const client = new FraudDetectorClient(config);
const input = { // UpdateRuleVersionRequest
  rule: { // Rule
    detectorId: "STRING_VALUE", // required
    ruleId: "STRING_VALUE", // required
    ruleVersion: "STRING_VALUE", // required
  },
  description: "STRING_VALUE",
  expression: "STRING_VALUE", // required
  language: "DETECTORPL", // required
  outcomes: [ // NonEmptyListOfStrings // required
    "STRING_VALUE",
  ],
  tags: [ // tagList
    { // Tag
      key: "STRING_VALUE", // required
      value: "STRING_VALUE", // required
    },
  ],
};
const command = new UpdateRuleVersionCommand(input);
const response = await client.send(command);
// { // UpdateRuleVersionResult
//   rule: { // Rule
//     detectorId: "STRING_VALUE", // required
//     ruleId: "STRING_VALUE", // required
//     ruleVersion: "STRING_VALUE", // required
//   },
// };

UpdateRuleVersionCommand Input

See UpdateRuleVersionCommandInput for more details

Parameter
Type
Description
expression
Required
string | undefined

The rule expression.

language
Required
Language | undefined

The language.

outcomes
Required
string[] | undefined

The outcomes.

rule
Required
Rule | undefined

The rule to update.

description
string | undefined

The description.

tags
Tag[] | undefined

The tags to assign to the rule version.

UpdateRuleVersionCommand Output

See UpdateRuleVersionCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
rule
Rule | undefined

The new rule version that was created.

Throws

Name
Fault
Details
AccessDeniedException
client

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.

ConflictException
client

An exception indicating there was a conflict during a delete operation.

InternalServerException
server

An exception indicating an internal server error.

ResourceNotFoundException
client

An exception indicating the specified resource was not found.

ThrottlingException
client

An exception indicating a throttling error.

ValidationException
client

An exception indicating a specified value is not allowed.

FraudDetectorServiceException
Base exception class for all service exceptions from FraudDetector service.