Once you have a ruleset definition (either recommended or your own), you call this operation to evaluate the ruleset against a data source (Glue table). The evaluation computes results which you can retrieve with the GetDataQualityResult API.

See also: AWS API Documentation

Request Syntax

response = client.start_data_quality_ruleset_evaluation_run(
        'GlueTable': {
            'DatabaseName': 'string',
            'TableName': 'string',
            'CatalogId': 'string',
            'ConnectionName': 'string',
            'AdditionalOptions': {
                'string': 'string'
        'CloudWatchMetricsEnabled': True|False,
        'ResultsS3Prefix': 'string'
  • DataSource (dict) --


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

    • GlueTable (dict) -- [REQUIRED]

      An Glue table.

      • DatabaseName (string) -- [REQUIRED]

        A database name in the Glue Data Catalog.

      • TableName (string) -- [REQUIRED]

        A table name in the Glue Data Catalog.

      • CatalogId (string) --

        A unique identifier for the Glue Data Catalog.

      • ConnectionName (string) --

        The name of the connection to the Glue Data Catalog.

      • AdditionalOptions (dict) --

        Additional options for the table. Currently there are two keys supported:

        • pushDownPredicate : to filter on partitions without having to list and read all the files in your dataset.
        • catalogPartitionPredicate : to use server-side partition pruning using partition indexes in the Glue Data Catalog.
        • (string) --
          • (string) --
  • Role (string) --


    An IAM role supplied to encrypt the results of the run.

  • NumberOfWorkers (integer) -- The number of G.1X workers to be used in the run. The default is 5.
  • Timeout (integer) -- 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).
  • ClientToken (string) -- 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 (dict) --

    Additional run options you can specify for an evaluation run.

    • CloudWatchMetricsEnabled (boolean) --

      Whether or not to enable CloudWatch metrics.

    • ResultsS3Prefix (string) --

      Prefix for Amazon S3 to store results.

  • RulesetNames (list) --


    A list of ruleset names.

    • (string) --
Return type



Response Syntax

    'RunId': 'string'

Response Structure

  • (dict) --

    • RunId (string) --

      The unique run identifier associated with this run.


  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.EntityNotFoundException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.InternalServiceException
  • Glue.Client.exceptions.ConflictException