Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateRule

Creates a rule for use with the specified detector.

Request Syntax


{
   "description": "string",
   "detectorId": "string",
   "expression": "string",
   "language": "string",
   "outcomes": [ "string" ],
   "ruleId": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "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: No

detectorId

The detector ID for the rule's parent detector.

Type: String

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

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

Required: Yes

expression

The rule expression.

Type: String

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

Required: Yes

language

The language of the rule.

Type: String

Valid Values: DETECTORPL

Required: Yes

outcomes

The outcome or outcomes returned when the rule expression matches.

Type: Array of strings

Array Members: Minimum number of 1 item.

Required: Yes

ruleId

The rule ID.

Type: String

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

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

Required: Yes

tags

A collection of key and value pairs.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Syntax


{
   "rule": { 
      "detectorId": "string",
      "ruleId": "string",
      "ruleVersion": "string"
   }
}

Response Elements

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

The following data is returned in JSON format by the service.

rule

The created rule.

Type: Rule object

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

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