GetRules - Amazon Fraud Detector

GetRules

Gets all rules available for the specified detector.

Request Syntax

{ "detectorId": "string", "maxResults": number, "nextToken": "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.

detectorId

The detector ID.

Type: String

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

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

Required: Yes

maxResults

The maximum number of rules to return for the request.

Type: Integer

Valid Range: Minimum value of 50. Maximum value of 100.

Required: No

nextToken

The next page token.

Type: String

Required: No

ruleId

The rule ID.

Type: String

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

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

Required: No

ruleVersion

The rule version.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Response Syntax

{ "nextToken": "string", "ruleDetails": [ { "createdTime": "string", "description": "string", "detectorId": "string", "expression": "string", "language": "string", "lastUpdatedTime": "string", "outcomes": [ "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.

nextToken

The next page token to be used in subsequent requests.

Type: String

ruleDetails

The details of the requested rule.

Type: Array of RuleDetail objects

Errors

For information about the errors that are common to all actions, see Common Errors.

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: