start-data-quality-ruleset-evaluation-run¶

Description¶

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.

Synopsis¶

  start-data-quality-ruleset-evaluation-run
--data-source <value>
--role <value>
[--number-of-workers <value>]
[--timeout <value>]
[--client-token <value>]
[--additional-run-options <value>]
--ruleset-names <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]

Options¶

--data-source (structure)

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

GlueTable -> (structure)

An Glue table.

DatabaseName -> (string)

A database name in the Glue Data Catalog.

TableName -> (string)

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

key -> (string)

value -> (string)

Shorthand Syntax:

GlueTable={DatabaseName=string,TableName=string,CatalogId=string,ConnectionName=string,AdditionalOptions={KeyName1=string,KeyName2=string}}

JSON Syntax:

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

--role (string)

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

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

--client-token (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.

--additional-run-options (structure)

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.

CompositeRuleEvaluationMethod -> (string)

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

Shorthand Syntax:

CloudWatchMetricsEnabled=boolean,ResultsS3Prefix=string,CompositeRuleEvaluationMethod=string

JSON Syntax:

{
  "CloudWatchMetricsEnabled": true|false,
  "ResultsS3Prefix": "string",
  "CompositeRuleEvaluationMethod": "COLUMN"|"ROW"
}

--ruleset-names (list)

A list of ruleset names.

(string)

Syntax:

"string" "string" ...

--additional-data-sources (map)

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

key -> (string)

value -> (structure)

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

GlueTable -> (structure)

An Glue table.

DatabaseName -> (string)

A database name in the Glue Data Catalog.

TableName -> (string)

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

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=GlueTable={DatabaseName=string,TableName=string,CatalogId=string,ConnectionName=string,AdditionalOptions={KeyName1=string,KeyName2=string}},KeyName2=GlueTable={DatabaseName=string,TableName=string,CatalogId=string,ConnectionName=string,AdditionalOptions={KeyName1=string,KeyName2=string}}

JSON Syntax:

{"string": {
      "GlueTable": {
        "DatabaseName": "string",
        "TableName": "string",
        "CatalogId": "string",
        "ConnectionName": "string",
        "AdditionalOptions": {"string": "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

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

Output¶

RunId -> (string)

The unique run identifier associated with this run.

Table of Contents

Feedback

User Guide

start-data-quality-ruleset-evaluation-run¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶