Skip to content

Starts a recommendation run that is used to generate rules when you don't know what rules to write

Description

Starts a recommendation run that is used to generate rules when you don't know what rules to write. Glue Data Quality analyzes the data and comes up with recommendations for a potential ruleset. You can then triage the ruleset and modify the generated ruleset to your liking.

Recommendation runs are automatically deleted after 90 days.

Usage

glue_start_data_quality_rule_recommendation_run(DataSource, Role,
  NumberOfWorkers, Timeout, CreatedRulesetName,
  DataQualitySecurityConfiguration, ClientToken, AdditionalRunOptions,
  RecommendationMode)

Arguments

  • DataSource

    [required] The data source (Glue table) associated with this run.

  • Role

    [required] The IAM role that Glue assumes to access resources for the run.

    For more information, see Configure IAM permissions for Glue Data Quality.

  • NumberOfWorkers

    The number of G.1X workers to be used in the run. The default is 5.

  • Timeout

    The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

  • CreatedRulesetName

    A name for the ruleset.

  • DataQualitySecurityConfiguration

    The name of the security configuration created with the data quality encryption option.

  • 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.

  • AdditionalRunOptions

    Additional run options you can specify for a recommendation run.

  • RecommendationMode

    The mode that Glue Data Quality uses to recommend rules.

    The default is BASIC.

Value

A list with the following syntax:

list(
  RunId = "string"
)

Request syntax

svc$start_data_quality_rule_recommendation_run(
  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,
  CreatedRulesetName = "string",
  DataQualitySecurityConfiguration = "string",
  ClientToken = "string",
  AdditionalRunOptions = list(
    CustomLogGroupPrefix = "string"
  ),
  RecommendationMode = "BASIC"|"ADVANCED"
)