CreateRuleset
Creates a new ruleset that can be used in a profile job to validate the data quality of a dataset.
Request Syntax
POST /rulesets HTTP/1.1
Content-type: application/json
{
"Description": "string
",
"Name": "string
",
"Rules": [
{
"CheckExpression": "string
",
"ColumnSelectors": [
{
"Name": "string
",
"Regex": "string
"
}
],
"Disabled": boolean
,
"Name": "string
",
"SubstitutionMap": {
"string
" : "string
"
},
"Threshold": {
"Type": "string
",
"Unit": "string
",
"Value": number
}
}
],
"Tags": {
"string
" : "string
"
},
"TargetArn": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- Name
-
The name of the ruleset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- Rules
-
A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset.
Type: Array of Rule objects
Array Members: Minimum number of 1 item.
Required: Yes
- TargetArn
-
The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Required: Yes
- Description
-
The description of the ruleset.
Type: String
Length Constraints: Maximum length of 1024.
Required: No
- Tags
-
Metadata tags to apply to the ruleset.
Type: String to string map
Map Entries: Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Maximum length of 256.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Name": "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.
- Name
-
The unique name of the created ruleset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
Updating or deleting a resource can cause an inconsistent state.
HTTP Status Code: 409
- ServiceQuotaExceededException
-
A service quota is exceeded.
HTTP Status Code: 402
- ValidationException
-
The input parameters for this request failed validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: