Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetDataQualityResult

Retrieves the result of a data quality rule evaluation.

Request Syntax


{
   "ResultId": "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.

ResultId

A unique result ID for the data quality result.

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


{
   "AnalyzerResults": [ 
      { 
         "Description": "string",
         "EvaluatedMetrics": { 
            "string" : number 
         },
         "EvaluationMessage": "string",
         "Name": "string"
      }
   ],
   "CompletedOn": number,
   "DataSource": { 
      "GlueTable": { 
         "AdditionalOptions": { 
            "string" : "string" 
         },
         "CatalogId": "string",
         "ConnectionName": "string",
         "DatabaseName": "string",
         "TableName": "string"
      }
   },
   "EvaluationContext": "string",
   "JobName": "string",
   "JobRunId": "string",
   "Observations": [ 
      { 
         "Description": "string",
         "MetricBasedObservation": { 
            "MetricName": "string",
            "MetricValues": { 
               "ActualValue": number,
               "ExpectedValue": number,
               "LowerLimit": number,
               "UpperLimit": number
            },
            "NewRules": [ "string" ]
         }
      }
   ],
   "ResultId": "string",
   "RuleResults": [ 
      { 
         "Description": "string",
         "EvaluatedMetrics": { 
            "string" : number 
         },
         "EvaluationMessage": "string",
         "Name": "string",
         "Result": "string"
      }
   ],
   "RulesetEvaluationRunId": "string",
   "RulesetName": "string",
   "Score": number,
   "StartedOn": number
}

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.

AnalyzerResults

A list of DataQualityAnalyzerResult objects representing the results for each analyzer.

Type: Array of DataQualityAnalyzerResult objects

Array Members: Minimum number of 0 items. Maximum number of 2000 items.

CompletedOn

The date and time when the run for this data quality result was completed.

Type: Timestamp

DataSource

The table associated with the data quality result, if any.

Type: DataSource object

EvaluationContext

In the context of a job in AWS Glue Studio, each node in the canvas is typically assigned some sort of name and data quality nodes will have names. In the case of multiple nodes, the evaluationContext can differentiate the nodes.

Type: String

JobName