CreateDataQualityRuleset
Creates a data quality ruleset with DQDL rules applied to a specified AWS Glue table.
You create the ruleset using the Data Quality Definition Language (DQDL). For more information, see the AWS Glue developer guide.
Request Syntax
{
"ClientToken": "string
",
"DataQualitySecurityConfiguration": "string
",
"Description": "string
",
"Name": "string
",
"Ruleset": "string
",
"Tags": {
"string
" : "string
"
},
"TargetTable": {
"CatalogId": "string
",
"DatabaseName": "string
",
"TableName": "string
"
}
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ClientToken
-
Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*
Required: No
- DataQualitySecurityConfiguration
-
The name of the security configuration created with the data quality encryption option.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*
Required: No
- Description
-
A description of the data quality ruleset.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: No
- Name
-
A unique name for the data quality ruleset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*
Required: Yes
- Ruleset
-
A Data Quality Definition Language (DQDL) ruleset. For more information, see the AWS Glue developer guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 65536.
Required: Yes
- Tags
-
A list of tags applied to the data quality ruleset.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
- TargetTable
-
A target table associated with the data quality ruleset.
Type: DataQualityTargetTable object
Required: No
Response Syntax
{
"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
-
A unique name for the data quality ruleset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- AlreadyExistsException
-
A resource to be created or added already exists.
HTTP Status Code: 400
- InternalServiceException
-
An internal service error occurred.
HTTP Status Code: 500
- InvalidInputException
-
The input provided was not valid.
HTTP Status Code: 400
- OperationTimeoutException
-
The operation timed out.
HTTP Status Code: 400
- ResourceNumberLimitExceededException
-
A resource numerical limit was exceeded.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: