DescribeRuleset
Retrieves detailed information about the ruleset.
Request Syntax
GET /rulesets/name HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- name
-
The name of the ruleset to be described.
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"CreateDate": number,
"CreatedBy": "string",
"Description": "string",
"LastModifiedBy": "string",
"LastModifiedDate": number,
"Name": "string",
"ResourceArn": "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"
}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 ruleset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
- CreateDate
-
The date and time that the ruleset was created.
Type: Timestamp
- CreatedBy
-
The Amazon Resource Name (ARN) of the user who created the ruleset.
Type: String
- Description
-
The description of the ruleset.
Type: String
Length Constraints: Maximum length of 1024.
- LastModifiedBy
-
The Amazon Resource Name (ARN) of the user who last modified the ruleset.
Type: String
- LastModifiedDate
-
The modification date and time of the ruleset.
Type: Timestamp
- ResourceArn
-
The Amazon Resource Name (ARN) for the ruleset.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
- 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.
- Tags
-
Metadata tags that have been applied 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.
- 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.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
