ListRulesets
List all rulesets available in the current account or rulesets associated with a specific resource (dataset).
Request Syntax
GET /rulesets?maxResults=MaxResults&nextToken=NextToken&targetArn=TargetArn HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- MaxResults
-
The maximum number of results to return in this request.
Valid Range: Minimum value of 1. Maximum value of 100.
- NextToken
-
A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call.
Length Constraints: Minimum length of 1. Maximum length of 2000.
- TargetArn
-
The Amazon Resource Name (ARN) of a resource (dataset). Using this parameter indicates to return only those rulesets that are associated with the specified resource.
Length Constraints: Minimum length of 20. Maximum length of 2048.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Rulesets": [
{
"AccountId": "string",
"CreateDate": number,
"CreatedBy": "string",
"Description": "string",
"LastModifiedBy": "string",
"LastModifiedDate": number,
"Name": "string",
"ResourceArn": "string",
"RuleCount": 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.
- Rulesets
-
A list of RulesetItem. RulesetItem contains meta data of a ruleset.
Type: Array of RulesetItem objects
- NextToken
-
A token that you can use in a subsequent call to retrieve the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
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:
