batch-get-data-quality-result-v2¶

Description¶

Retrieves a list of data quality results for the specified result IDs. You can specify up to 100 result IDs in a single request.

Synopsis¶

  batch-get-data-quality-result-v2
--result-ids <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>]

Options¶

--result-ids (list) [required]

A list of unique result IDs for the data quality results.

Constraints:

min: 1

max: 100

(string)

Constraints:

min: 1

max: 255

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Syntax:

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

Output¶

Results -> (list)

A list of DataQualityResultV2Item objects representing the data quality results.

Constraints:

min: 0

max: 100

(structure)

Describes a data quality result returned by BatchGetDataQualityResultV2 .

ResultId -> (string) [required]

A unique result ID for the data quality result.

Constraints:

min: 1

max: 255

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

DataSource -> (structure)

The table associated with the data quality result, if any.

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]*

Dimensions -> (map)

A map of platform-specific identifiers, such as cluster, application, workgroup, or project IDs, that identify where the data quality evaluation ran.

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: 1

max: 255

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Tags -> (map)

A map of tags associated with the data quality result.

Constraints:

min: 1

max: 5

key -> (string)

Constraints:

min: 1

max: 255

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

value -> (string)

Constraints:

min: 1

max: 255

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

ExecutionStartedOn -> (timestamp)

The date and time when this data quality run started.

ExecutionCompletedOn -> (timestamp)

The date and time when this data quality run completed.

ResultPublishedOn -> (timestamp)

The date and time when this data quality result was published.

Score -> (double)

An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.

Constraints:

min: 0.0

max: 1.0

RuleResults -> (list)

A list of DataQualityRuleResult objects representing the results for each rule.

Constraints:

min: 0

max: 2000

(structure)

Describes the result of the evaluation of a data quality rule.

Name -> (string)

The name of the data quality rule.

Constraints:

min: 1

max: 255

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Description -> (string)

A description of the data quality rule.

Constraints:

min: 0

max: 2048

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

EvaluationMessage -> (string)

An evaluation message.

Constraints:

min: 0

max: 2048

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Result -> (string)

A pass or fail status for the rule.

Possible values:

PASS

FAIL

ERROR

EvaluatedMetrics -> (map)

A map of metrics associated with the evaluation of the rule.

key -> (string)

Constraints:

min: 1

max: 255

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

value -> (double)

EvaluatedRule -> (string)

The evaluated rule.

Constraints:

min: 0

max: 2048

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

RuleMetrics -> (map)

A map containing metrics associated with the evaluation of the rule based on row-level results.

key -> (string)

Constraints:

min: 1

max: 255

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

value -> (double)

Labels -> (map)

A map containing labels assigned to the data quality rule.

key -> (string)

Constraints:

min: 1

max: 255

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

value -> (string)

Constraints:

min: 1

max: 255

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

AnalyzerResults -> (list)

A list of DataQualityAnalyzerResult objects representing the results for each analyzer.

Constraints:

min: 0

max: 2000

(structure)

Describes the result of the evaluation of a data quality analyzer.

Name -> (string)

The name of the data quality analyzer.

Constraints:

min: 1

max: 255

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Description -> (string)

A description of the data quality analyzer.

Constraints:

min: 0

max: 2048

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

EvaluationMessage -> (string)

An evaluation message.

Constraints:

min: 0

max: 2048

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

EvaluatedMetrics -> (map)

A map of metrics associated with the evaluation of the analyzer.

key -> (string)

Constraints:

min: 1

max: 255

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

value -> (double)

EvaluatedDistributions -> (map)

A map of distribution metrics associated with the evaluation of the analyzer.

key -> (string)

Constraints:

min: 1

max: 255

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

value -> (structure)

The distribution data for a statistic.

BinEdges -> (list)

The bin edge values for the distribution.

(string)

Count -> (list)

The frequency count for each bin in the distribution.

(integer)

DataType -> (string)

The data type of the column for the distribution.

Constraints:

min: 1

max: 255

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Observations -> (list)

A list of DataQualityObservation objects representing the anomaly detection observations generated after evaluating the rules and analyzers.

Constraints:

min: 0

max: 50

(structure)

Describes the observation generated after evaluating the rules and analyzers.

Description -> (string)

A description of the data quality observation.

Constraints:

min: 0

max: 2048

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

MetricBasedObservation -> (structure)

An object of type MetricBasedObservation representing the observation that is based on evaluated data quality metrics.

MetricName -> (string)

The name of the data quality metric used for generating the observation.

Constraints:

min: 1

max: 255

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

StatisticId -> (string)

The Statistic ID.

Constraints:

min: 1

max: 255

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

MetricValues -> (structure)

An object of type DataQualityMetricValues representing the analysis of the data quality metric value.

ActualValue -> (double)

The actual value of the data quality metric.

ExpectedValue -> (double)

The expected value of the data quality metric according to the analysis of historical data.

LowerLimit -> (double)

The lower limit of the data quality metric value according to the analysis of historical data.

UpperLimit -> (double)

The upper limit of the data quality metric value according to the analysis of historical data.

NewRules -> (list)

A list of new data quality rules generated as part of the observation based on the data quality metric value.

(string)

Constraints:

min: 1

max: 255

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

EvaluationContext -> (string)

The evaluation context for the data quality result. This value identifies a specific data quality result, or a series of related results, within a run.

Constraints:

min: 1

max: 255

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Descriptors -> (map)

A map of user-provided descriptors that add contextual metadata and configuration to the data quality result, such as database name, table name, team, or environment.

Constraints:

min: 0

max: 10

key -> (string)

Constraints:

min: 1

max: 255

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

value -> (string)

Constraints:

min: 1

max: 255

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

AggregatedMetrics -> (structure)

A summary of DataQualityAggregatedMetrics objects showing the total counts of processed rows and rules, including their pass/fail statistics based on row-level results.

TotalRowsProcessed -> (double)

The total number of rows that were processed during the data quality evaluation.

TotalRowsPassed -> (double)

The total number of rows that passed all applicable data quality rules.

TotalRowsFailed -> (double)

The total number of rows that failed one or more data quality rules.

TotalRulesProcessed -> (double)

The total number of data quality rules that were evaluated.

TotalRulesPassed -> (double)

The total number of data quality rules that passed their evaluation criteria.

TotalRulesFailed -> (double)

The total number of data quality rules that failed their evaluation criteria.

RulesetName -> (string)

The name of the ruleset associated with the data quality result.

Constraints:

min: 1

max: 255

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

ResultsNotFound -> (list)

A list of result IDs for which results were not found.

Constraints:

min: 1

max: 100

(string)

Constraints:

min: 1

max: 255

pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Table of Contents

Feedback

User Guide