GetDataQualityRuleset
Returns an existing ruleset by identifier or name.
Request Syntax
{
"Name": "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.
- Name
-
The name of the 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
Response Syntax
{
"CreatedOn": number,
"DataQualitySecurityConfiguration": "string",
"Description": "string",
"LastModifiedOn": number,
"Name": "string",
"RecommendationRunId": "string",
"Ruleset": "string",
"TargetTable": {
"CatalogId": "string",
"DatabaseName": "string",
"TableName": "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.
- CreatedOn
-
A timestamp. The time and date that this data quality ruleset was created.
Type: Timestamp
- 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]* - Description
-
A description of the 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]* - LastModifiedOn
-
A timestamp. The last point in time when this data quality ruleset was modified.
Type: Timestamp
- Name
-
The name of the ruleset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]* - RecommendationRunId
-
When a ruleset was created from a recommendation run, this run ID is generated to link the two together.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]* - 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.
- TargetTable
-
The name and database name of the target table.
Type: DataQualityTargetTable object
Errors
For information about the errors that are common to all actions, see Common Errors.
- EntityNotFoundException
-
A specified entity does not exist
- FromFederationSource
-
Indicates whether or not the exception relates to a federated source.
- Message
-
A message describing the problem.
HTTP Status Code: 400
- InternalServiceException
-
An internal service error occurred.
- Message
-
A message describing the problem.
HTTP Status Code: 500
- InvalidInputException
-
The input provided was not valid.
- FromFederationSource
-
Indicates whether or not the exception relates to a federated source.
- Message
-
A message describing the problem.
HTTP Status Code: 400
- OperationTimeoutException
-
The operation timed out.
- Message
-
A message describing the problem.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
