AWS CLI Command Reference

[ aws . glue ]

update-data-quality-evaluation-config

Description

Updates a data quality evaluation configuration. Fields that you don’t specify keep their current values.

See also: AWS API Documentation

Synopsis

  update-data-quality-evaluation-config
--name <value>
[--data-source <value>]
[--ruleset-name <value>]
[--managed-ruleset-name <value>]
[--triggers <value>]
[--schedule-expression <value>]
[--start-at <value>]
[--end-at <value>]
[--pause-runs | --no-pause-runs]
[--role <value>]
[--number-of-workers <value>]
[--timeout <value>]
[--additional-run-options <value>]
[--additional-data-sources <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]

Options

--name (string) [required]

The name of the data quality evaluation configuration to update.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

--data-source (structure)

The database or table that the configuration applies to. Replaces the current data source.

GlueTables -> (structure)

The Glue Data Catalog tables that the configuration applies to.

CatalogId -> (string) [required]

A unique identifier for the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

DatabaseName -> (string)

A database name in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

TableNamePattern -> (string)

For the CATALOG and DATABASE levels, a glob pattern, such as orders_* , that selects tables. If you don’t specify a pattern, every table at the level is in scope. For the TABLE level, the name of the table.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

PreProcessingQuery -> (string)

SQL Query of SparkSQL format that can be used to pre-process the data for the table in Glue Data Catalog, before running the Data Quality Operation.

For the CATALOG and DATABASE levels, use the {{DATABASE_NAME}} and {{TABLE_NAME}} placeholders, which are filled in for each table.

Constraints:

  • min: 0
  • max: 51200
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

ConnectionName -> (string)

The name of the connection to the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

AdditionalOptions -> (map)

Options for reading the table. The following keys are 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.

Constraints:

  • min: 1
  • max: 10

key -> (string)

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

value -> (string)

Constraints:

  • min: 0
  • max: 2048
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Shorthand Syntax:

GlueTables={CatalogId=string,DatabaseName=string,TableNamePattern=string,PreProcessingQuery=string,ConnectionName=string,AdditionalOptions={KeyName1=string,KeyName2=string}}

JSON Syntax:

{
  "GlueTables": {
    "CatalogId": "string",
    "DatabaseName": "string",
    "TableNamePattern": "string",
    "PreProcessingQuery": "string",
    "ConnectionName": "string",
    "AdditionalOptions": {"string": "string"
      ...}
  }
}

--ruleset-name (string)

The name of a Data Quality Definition Language (DQDL) ruleset, containing analyzers, rules, or both, to evaluate tables with. You create the ruleset using the CreateDataQualityRuleset API. Specify either RulesetName or ManagedRulesetName , not both.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

--managed-ruleset-name (string)

A built-in ruleset, SIMPLE or ADVANCED , that profiles each table.

Possible values:

  • SIMPLE
  • ADVANCED

--triggers (list)

When the configuration evaluates tables. Replaces the current triggers. Choose from the following triggers:

ONCE

Evaluates each table one time, including when tables are added to a database or catalog.

SCHEDULE

Evaluates each table on the cron or rate expression in ScheduleExpression , between the optional StartAt and EndAt times.

METADATA_CHANGE

Evaluates a table whenever its Glue Data Catalog metadata changes, such as a schema change or an Apache Iceberg commit.

Constraints:

  • min: 1
  • max: 3

(string)

Possible values:

  • ONCE
  • SCHEDULE
  • METADATA_CHANGE

Syntax:

"string" "string" ...

--schedule-expression (string)

A cron or rate expression, in UTC, for the SCHEDULE trigger, for example cron(0 6 * * ? *) . The schedule can run at most once an hour.

Constraints:

  • min: 1
  • max: 256

--start-at (timestamp)

The time from which the schedule runs, inclusive.

--end-at (timestamp)

The time at which the schedule stops running, exclusive.

--pause-runs | --no-pause-runs (boolean)

Specifies whether to pause the configuration. While paused, the configuration evaluates nothing, including tables added to the catalog or database.

--role (string)

The IAM role that evaluations assume. You can specify the role name or the role Amazon Resource Name (ARN). The role needs the trust policy and permissions described for CreateDataQualityEvaluationConfig .

--number-of-workers (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).

Constraints:

  • min: 1

--additional-run-options (structure)

Additional run options you can specify for an evaluation run.

CloudWatchMetricsEnabled -> (boolean)

Specifies whether to enable CloudWatch metrics.

ResultsS3Prefix -> (string)

Prefix for Amazon S3 to store results.

CompositeRuleEvaluationMethod -> (string)

Set the evaluation method for composite rules in the ruleset to ROW/COLUMN

Possible values:

  • COLUMN
  • ROW

RowLevelResults -> (structure)

The configuration for writing row-level evaluation results to a Glue Data Catalog table.

MaxRowsToWrite -> (integer)

The maximum number of rows to write in the results.

ResultType -> (string)

The result type to include in the row-level results output.

Possible values:

  • ALL
  • PASSED_ONLY
  • FAILED_ONLY

CatalogTableConfig -> (structure)

The Glue Data Catalog table configuration for storing the results.

DatabaseName -> (string)

The name of the database in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

TableName -> (string)

The name of the table in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

S3Location -> (string)

The Amazon S3 location for storing the results.

CatalogId -> (string)

A unique identifier for the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

ProfilingResults -> (structure)

The configuration for writing profiling results to a Glue Data Catalog table.

WriteProfilingResultsEnabled -> (boolean)

Set to true to write profiling results.

CatalogTableConfig -> (structure)

The Glue Data Catalog table configuration for storing the profiling results.

DatabaseName -> (string)

The name of the database in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

TableName -> (string)

The name of the table in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

S3Location -> (string)

The Amazon S3 location for storing the results.

CatalogId -> (string)

A unique identifier for the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

DistributionResults -> (structure)

The configuration for writing distribution results.

WriteDistributionResultsEnabled -> (boolean)

Set to true to write distribution results.

CatalogTableConfig -> (structure)

The Glue Data Catalog table configuration for storing the distribution results.

DatabaseName -> (string)

The name of the database in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

TableName -> (string)

The name of the table in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

S3Location -> (string)

The Amazon S3 location for storing the results.

CatalogId -> (string)

A unique identifier for the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

ObservationScope -> (string)

The scope of the observation for the evaluation run. Specifies whether anomaly detection is enabled or disabled.

Possible values:

  • ALL
  • NONE

ObservationMode -> (string)

The observation mode for the evaluation run. Specifies how anomaly detection bounds are calculated.

Possible values:

  • SCHEDULED
  • FIXED

DataQualityRuleResults -> (structure)

The configuration for writing rule results to a Glue Data Catalog table.

WriteDataQualityRuleResultsEnabled -> (boolean)

Set to true to write data quality rule results.

CatalogTableConfig -> (structure)

The Glue Data Catalog table configuration for storing the rule results.

DatabaseName -> (string)

The name of the database in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

TableName -> (string)

The name of the table in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

S3Location -> (string)

The Amazon S3 location for storing the results.

CatalogId -> (string)

A unique identifier for the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

ObservationResults -> (structure)

The configuration for writing observation results to a Glue Data Catalog table.

WriteObservationResultsEnabled -> (boolean)

Set to true to write observation results.

CatalogTableConfig -> (structure)

The Glue Data Catalog table configuration for storing the observation results.

DatabaseName -> (string)

The name of the database in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

TableName -> (string)

The name of the table in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

S3Location -> (string)

The Amazon S3 location for storing the results.

CatalogId -> (string)

A unique identifier for the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

CustomLogGroupPrefix -> (string)

A custom prefix for the CloudWatch log group names. When specified, evaluation run logs are written to <CustomLogGroupPrefix>/error and <CustomLogGroupPrefix>/output instead of the default /aws-glue/data-quality/error and /aws-glue/data-quality/output log groups.

JSON Syntax:

{
  "CloudWatchMetricsEnabled": true|false,
  "ResultsS3Prefix": "string",
  "CompositeRuleEvaluationMethod": "COLUMN"|"ROW",
  "RowLevelResults": {
    "MaxRowsToWrite": integer,
    "ResultType": "ALL"|"PASSED_ONLY"|"FAILED_ONLY",
    "CatalogTableConfig": {
      "DatabaseName": "string",
      "TableName": "string",
      "S3Location": "string",
      "CatalogId": "string"
    }
  },
  "ProfilingResults": {
    "WriteProfilingResultsEnabled": true|false,
    "CatalogTableConfig": {
      "DatabaseName": "string",
      "TableName": "string",
      "S3Location": "string",
      "CatalogId": "string"
    },
    "DistributionResults": {
      "WriteDistributionResultsEnabled": true|false,
      "CatalogTableConfig": {
        "DatabaseName": "string",
        "TableName": "string",
        "S3Location": "string",
        "CatalogId": "string"
      }
    }
  },
  "ObservationScope": "ALL"|"NONE",
  "ObservationMode": "SCHEDULED"|"FIXED",
  "DataQualityRuleResults": {
    "WriteDataQualityRuleResultsEnabled": true|false,
    "CatalogTableConfig": {
      "DatabaseName": "string",
      "TableName": "string",
      "S3Location": "string",
      "CatalogId": "string"
    }
  },
  "ObservationResults": {
    "WriteObservationResultsEnabled": true|false,
    "CatalogTableConfig": {
      "DatabaseName": "string",
      "TableName": "string",
      "S3Location": "string",
      "CatalogId": "string"
    }
  },
  "CustomLogGroupPrefix": "string"
}

--additional-data-sources (map)

A map of reference strings to additional data sources you can specify for an evaluation run.

key -> (string)

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

value -> (structure)

A data source (an Glue table) for which you want data quality results.

GlueTable -> (structure)

An Glue table.

DatabaseName -> (string) [required]

A database name in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

TableName -> (string) [required]

A table name in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

CatalogId -> (string)

A unique identifier for the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

ConnectionName -> (string)

The name of the connection to the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

AdditionalOptions -> (map)

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.

Constraints:

  • min: 1
  • max: 10

key -> (string)

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

value -> (string)

Constraints:

  • min: 0
  • max: 2048
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

DataQualityGlueTable -> (structure)

An Glue table for Data Quality Operations.

DatabaseName -> (string) [required]

A database name in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

TableName -> (string) [required]

A table name in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

CatalogId -> (string)

A unique identifier for the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

ConnectionName -> (string)

The name of the connection to the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

AdditionalOptions -> (map)

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.

Constraints:

  • min: 1
  • max: 10

key -> (string)

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

value -> (string)

Constraints:

  • min: 0
  • max: 2048
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

PreProcessingQuery -> (string)

SQL Query of SparkSQL format that can be used to pre-process the data for the table in Glue Data Catalog, before running the Data Quality Operation.

Constraints:

  • min: 0
  • max: 51200
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

JSON Syntax:

{"string": {
      "GlueTable": {
        "DatabaseName": "string",
        "TableName": "string",
        "CatalogId": "string",
        "ConnectionName": "string",
        "AdditionalOptions": {"string": "string"
          ...}
      },
      "DataQualityGlueTable": {
        "DatabaseName": "string",
        "TableName": "string",
        "CatalogId": "string",
        "ConnectionName": "string",
        "AdditionalOptions": {"string": "string"
          ...},
        "PreProcessingQuery": "string"
      }
    }
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Output

Name -> (string)

The name of the data quality evaluation configuration.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

EvaluationRunMode -> (string)

The evaluation run mode of the configuration’s results, which is EVALUATION_CONFIG .

Possible values:

  • ON_DEMAND
  • EVALUATION_CONFIG

CreatedOn -> (timestamp)

The time when the configuration was created.

LastModifiedOn -> (timestamp)

The time when the configuration was last modified.

Level -> (string)

The Glue Data Catalog hierarchical level that the configuration applies to.

Possible values:

  • CATALOG
  • DATABASE
  • TABLE

DataSource -> (structure)

The catalog, database, or table that the configuration applies to.

GlueTables -> (structure)

The Glue Data Catalog tables that the configuration applies to.

CatalogId -> (string) [required]

A unique identifier for the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

DatabaseName -> (string)

A database name in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

TableNamePattern -> (string)

For the CATALOG and DATABASE levels, a glob pattern, such as orders_* , that selects tables. If you don’t specify a pattern, every table at the level is in scope. For the TABLE level, the name of the table.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

PreProcessingQuery -> (string)

SQL Query of SparkSQL format that can be used to pre-process the data for the table in Glue Data Catalog, before running the Data Quality Operation.

For the CATALOG and DATABASE levels, use the {{DATABASE_NAME}} and {{TABLE_NAME}} placeholders, which are filled in for each table.

Constraints:

  • min: 0
  • max: 51200
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

ConnectionName -> (string)

The name of the connection to the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

AdditionalOptions -> (map)

Options for reading the table. The following keys are 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.

Constraints:

  • min: 1
  • max: 10

key -> (string)

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

value -> (string)

Constraints:

  • min: 0
  • max: 2048
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

RulesetName -> (string)

The name of the data quality ruleset that tables are evaluated with.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

ManagedRulesetName -> (string)

The built-in ruleset that tables are evaluated with.

Possible values:

  • SIMPLE
  • ADVANCED

Triggers -> (list)

When the configuration evaluates tables:

ONCE

Each table is evaluated one time, including when tables are added to a database or catalog.

SCHEDULE

Each table is evaluated on the cron or rate expression in ScheduleExpression .

METADATA_CHANGE

A table is evaluated whenever its Glue Data Catalog metadata changes.

Constraints:

  • min: 1
  • max: 3

(string)

Possible values:

  • ONCE
  • SCHEDULE
  • METADATA_CHANGE

ScheduleExpression -> (string)

The cron or rate expression, in UTC, for the SCHEDULE trigger.

Constraints:

  • min: 1
  • max: 256

StartAt -> (timestamp)

The time from which the schedule runs, inclusive.

EndAt -> (timestamp)

The time at which the schedule stops running, exclusive.

PauseRuns -> (boolean)

Specifies whether evaluations are paused.

Role -> (string)

The Amazon Resource Name (ARN) of the IAM role that evaluation runs assume.

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

Constraints:

  • min: 1

AdditionalRunOptions -> (structure)

Additional run options you can specify for an evaluation run.

CloudWatchMetricsEnabled -> (boolean)

Specifies whether to enable CloudWatch metrics.

ResultsS3Prefix -> (string)

Prefix for Amazon S3 to store results.

CompositeRuleEvaluationMethod -> (string)

Set the evaluation method for composite rules in the ruleset to ROW/COLUMN

Possible values:

  • COLUMN
  • ROW

RowLevelResults -> (structure)

The configuration for writing row-level evaluation results to a Glue Data Catalog table.

MaxRowsToWrite -> (integer)

The maximum number of rows to write in the results.

ResultType -> (string)

The result type to include in the row-level results output.

Possible values:

  • ALL
  • PASSED_ONLY
  • FAILED_ONLY

CatalogTableConfig -> (structure)

The Glue Data Catalog table configuration for storing the results.

DatabaseName -> (string)

The name of the database in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

TableName -> (string)

The name of the table in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

S3Location -> (string)

The Amazon S3 location for storing the results.

CatalogId -> (string)

A unique identifier for the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

ProfilingResults -> (structure)

The configuration for writing profiling results to a Glue Data Catalog table.

WriteProfilingResultsEnabled -> (boolean)

Set to true to write profiling results.

CatalogTableConfig -> (structure)

The Glue Data Catalog table configuration for storing the profiling results.

DatabaseName -> (string)

The name of the database in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

TableName -> (string)

The name of the table in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

S3Location -> (string)

The Amazon S3 location for storing the results.

CatalogId -> (string)

A unique identifier for the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

DistributionResults -> (structure)

The configuration for writing distribution results.

WriteDistributionResultsEnabled -> (boolean)

Set to true to write distribution results.

CatalogTableConfig -> (structure)

The Glue Data Catalog table configuration for storing the distribution results.

DatabaseName -> (string)

The name of the database in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

TableName -> (string)

The name of the table in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

S3Location -> (string)

The Amazon S3 location for storing the results.

CatalogId -> (string)

A unique identifier for the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

ObservationScope -> (string)

The scope of the observation for the evaluation run. Specifies whether anomaly detection is enabled or disabled.

Possible values:

  • ALL
  • NONE

ObservationMode -> (string)

The observation mode for the evaluation run. Specifies how anomaly detection bounds are calculated.

Possible values:

  • SCHEDULED
  • FIXED

DataQualityRuleResults -> (structure)

The configuration for writing rule results to a Glue Data Catalog table.

WriteDataQualityRuleResultsEnabled -> (boolean)

Set to true to write data quality rule results.

CatalogTableConfig -> (structure)

The Glue Data Catalog table configuration for storing the rule results.

DatabaseName -> (string)

The name of the database in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

TableName -> (string)

The name of the table in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

S3Location -> (string)

The Amazon S3 location for storing the results.

CatalogId -> (string)

A unique identifier for the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

ObservationResults -> (structure)

The configuration for writing observation results to a Glue Data Catalog table.

WriteObservationResultsEnabled -> (boolean)

Set to true to write observation results.

CatalogTableConfig -> (structure)

The Glue Data Catalog table configuration for storing the observation results.

DatabaseName -> (string)

The name of the database in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

TableName -> (string)

The name of the table in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

S3Location -> (string)

The Amazon S3 location for storing the results.

CatalogId -> (string)

A unique identifier for the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

CustomLogGroupPrefix -> (string)

A custom prefix for the CloudWatch log group names. When specified, evaluation run logs are written to <CustomLogGroupPrefix>/error and <CustomLogGroupPrefix>/output instead of the default /aws-glue/data-quality/error and /aws-glue/data-quality/output log groups.

AdditionalDataSources -> (map)

A map of reference strings to additional data sources you can specify for an evaluation run.

key -> (string)

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

value -> (structure)

A data source (an Glue table) for which you want data quality results.

GlueTable -> (structure)

An Glue table.

DatabaseName -> (string) [required]

A database name in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

TableName -> (string) [required]

A table name in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

CatalogId -> (string)

A unique identifier for the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

ConnectionName -> (string)

The name of the connection to the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

AdditionalOptions -> (map)

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.

Constraints:

  • min: 1
  • max: 10

key -> (string)

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

value -> (string)

Constraints:

  • min: 0
  • max: 2048
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

DataQualityGlueTable -> (structure)

An Glue table for Data Quality Operations.

DatabaseName -> (string) [required]

A database name in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

TableName -> (string) [required]

A table name in the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

CatalogId -> (string)

A unique identifier for the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

ConnectionName -> (string)

The name of the connection to the Glue Data Catalog.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

AdditionalOptions -> (map)

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.

Constraints:

  • min: 1
  • max: 10

key -> (string)

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

value -> (string)

Constraints:

  • min: 0
  • max: 2048
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

PreProcessingQuery -> (string)

SQL Query of SparkSQL format that can be used to pre-process the data for the table in Glue Data Catalog, before running the Data Quality Operation.

Constraints:

  • min: 0
  • max: 51200
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
© Copyright 2026, Amazon Web Services. Created using Sphinx.