Skip to content

Get Data Quality Result

glue_get_data_quality_result R Documentation

Retrieves the result of a data quality rule evaluation

Description

Retrieves the result of a data quality rule evaluation.

Usage

glue_get_data_quality_result(ResultId)

Arguments

ResultId

[required] A unique result ID for the data quality result.

Value

A list with the following syntax:

list(
  ResultId = "string",
  ProfileId = "string",
  Score = 123.0,
  DataSource = list(
    GlueTable = list(
      DatabaseName = "string",
      TableName = "string",
      CatalogId = "string",
      ConnectionName = "string",
      AdditionalOptions = list(
        "string"
      )
    )
  ),
  RulesetName = "string",
  EvaluationContext = "string",
  StartedOn = as.POSIXct(
    "2015-01-01"
  ),
  CompletedOn = as.POSIXct(
    "2015-01-01"
  ),
  JobName = "string",
  JobRunId = "string",
  RulesetEvaluationRunId = "string",
  RuleResults = list(
    list(
      Name = "string",
      Description = "string",
      EvaluationMessage = "string",
      Result = "PASS"|"FAIL"|"ERROR",
      EvaluatedMetrics = list(
        123.0
      ),
      EvaluatedRule = "string"
    )
  ),
  AnalyzerResults = list(
    list(
      Name = "string",
      Description = "string",
      EvaluationMessage = "string",
      EvaluatedMetrics = list(
        123.0
      )
    )
  ),
  Observations = list(
    list(
      Description = "string",
      MetricBasedObservation = list(
        MetricName = "string",
        StatisticId = "string",
        MetricValues = list(
          ActualValue = 123.0,
          ExpectedValue = 123.0,
          LowerLimit = 123.0,
          UpperLimit = 123.0
        ),
        NewRules = list(
          "string"
        )
      )
    )
  )
)

Request syntax

svc$get_data_quality_result(
  ResultId = "string"
)