POST

/rulesets

http://databrew.{region}.amazonaws.com/rulesets

Creates a new ruleset that can be used in a profile job to validate the data quality of a dataset.

Access Token Required: API Key

Body Params

Namestringrequired

The name of the ruleset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

Tagsobject

Metadata tags to apply to the ruleset.

Rulesarrayrequired

A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset.

TargetArnstringrequired

The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.

Descriptionstring

The description of the ruleset.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://databrew.{region}.amazonaws.com/rulesets' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}