Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateRuleset

Updates specified ruleset.

Request Syntax


PUT /rulesets/name HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Rules": [ 
      { 
         "CheckExpression": "string",
         "ColumnSelectors": [ 
            { 
               "Name": "string",
               "Regex": "string"
            }
         ],
         "Disabled": boolean,
         "Name": "string",
         "SubstitutionMap": { 
            "string" : "string" 
         },
         "Threshold": { 
            "Type": "string",
            "Unit": "string",
            "Value": number
         }
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

name

The name of the ruleset to be updated.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

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

Description

The description of the ruleset.

Type: String

Length Constraints: Maximum length of 1024.

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 name of the updated 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.

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ValidationException

The input parameters for this request failed validation.

HTTP Status Code: 400