Skip to content

Retrieves a specific run where a ruleset is evaluated against a data source

Description

Retrieves a specific run where a ruleset is evaluated against a data source.

Usage

glue_get_data_quality_ruleset_evaluation_run(RunId)

Arguments

  • RunId

    [required] The unique run identifier associated with this run.

Value

A list with the following syntax:

list(
  RunId = "string",
  DataSource = list(
    GlueTable = list(
      DatabaseName = "string",
      TableName = "string",
      CatalogId = "string",
      ConnectionName = "string",
      AdditionalOptions = list(
        "string"
      )
    ),
    DataQualityGlueTable = list(
      DatabaseName = "string",
      TableName = "string",
      CatalogId = "string",
      ConnectionName = "string",
      AdditionalOptions = list(
        "string"
      ),
      PreProcessingQuery = "string"
    )
  ),
  Role = "string",
  NumberOfWorkers = 123,
  Timeout = 123,
  AdditionalRunOptions = list(
    CloudWatchMetricsEnabled = TRUE|FALSE,
    ResultsS3Prefix = "string",
    CompositeRuleEvaluationMethod = "COLUMN"|"ROW",
    CustomLogGroupPrefix = "string",
    RowLevelResults = list(
      MaxRowsToWrite = 123,
      ResultType = "ALL"|"PASSED_ONLY"|"FAILED_ONLY",
      CatalogTableConfig = list(
        DatabaseName = "string",
        TableName = "string",
        S3Location = "string",
        CatalogId = "string"
      )
    ),
    ProfilingResults = list(
      WriteProfilingResultsEnabled = TRUE|FALSE,
      CatalogTableConfig = list(
        DatabaseName = "string",
        TableName = "string",
        S3Location = "string",
        CatalogId = "string"
      ),
      DistributionResults = list(
        WriteDistributionResultsEnabled = TRUE|FALSE,
        CatalogTableConfig = list(
          DatabaseName = "string",
          TableName = "string",
          S3Location = "string",
          CatalogId = "string"
        )
      )
    ),
    ObservationScope = "ALL"|"NONE",
    ObservationMode = "SCHEDULED"|"FIXED",
    DataQualityRuleResults = list(
      WriteDataQualityRuleResultsEnabled = TRUE|FALSE,
      CatalogTableConfig = list(
        DatabaseName = "string",
        TableName = "string",
        S3Location = "string",
        CatalogId = "string"
      )
    ),
    ObservationResults = list(
      WriteObservationResultsEnabled = TRUE|FALSE,
      CatalogTableConfig = list(
        DatabaseName = "string",
        TableName = "string",
        S3Location = "string",
        CatalogId = "string"
      )
    )
  ),
  Status = "STARTING"|"RUNNING"|"STOPPING"|"STOPPED"|"SUCCEEDED"|"FAILED"|"TIMEOUT",
  ErrorString = "string",
  StartedOn = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedOn = as.POSIXct(
    "2015-01-01"
  ),
  CompletedOn = as.POSIXct(
    "2015-01-01"
  ),
  ExecutionTime = 123,
  RulesetNames = list(
    "string"
  ),
  ResultIds = list(
    "string"
  ),
  AdditionalDataSources = list(
    list(
      GlueTable = list(
        DatabaseName = "string",
        TableName = "string",
        CatalogId = "string",
        ConnectionName = "string",
        AdditionalOptions = list(
          "string"
        )
      ),
      DataQualityGlueTable = list(
        DatabaseName = "string",
        TableName = "string",
        CatalogId = "string",
        ConnectionName = "string",
        AdditionalOptions = list(
          "string"
        ),
        PreProcessingQuery = "string"
      )
    )
  )
)

Request syntax

svc$get_data_quality_ruleset_evaluation_run(
  RunId = "string"
)