Request Syntax Request Parameters Response Elements Errors See Also

UpdateRuleMetadata

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

Request Syntax


{
   "description": "string",
   "rule": { 
      "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 rule description.

Type: String

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

Required: Yes

rule

The rule to update.

Type: Rule object

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

ConflictException

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

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