Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class UpdateRuleMetadataCommandProtected

Updates a rule's metadata. The description attribute can be updated.

Example

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

import { FraudDetectorClient, UpdateRuleMetadataCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import
// const { FraudDetectorClient, UpdateRuleMetadataCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import
const client = new FraudDetectorClient(config);
const input = { // UpdateRuleMetadataRequest
rule: { // Rule
detectorId: "STRING_VALUE", // required
ruleId: "STRING_VALUE", // required
ruleVersion: "STRING_VALUE", // required
},
description: "STRING_VALUE", // required
};
const command = new UpdateRuleMetadataCommand(input);
const response = await client.send(command);
// {};

Param

UpdateRuleMetadataCommandInput

Returns

UpdateRuleMetadataCommandOutput

See

Throws

AccessDeniedException (client fault)

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.

Throws

ConflictException (client fault)

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

Throws

InternalServerException (server fault)

An exception indicating an internal server error.

Throws

ResourceNotFoundException (client fault)

An exception indicating the specified resource was not found.

Throws

ThrottlingException (client fault)

An exception indicating a throttling error.

Throws

ValidationException (client fault)

An exception indicating a specified value is not allowed.

Throws

FraudDetectorServiceException

Base exception class for all service exceptions from FraudDetector service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods