AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . glue ]

batch-get-data-quality-result

Description

Retrieves a list of data quality results for the specified result IDs.

See also: AWS API Documentation

Synopsis

  batch-get-data-quality-result
--result-ids <value>
[--cli-input-json <value>]
[--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>]

Options

--result-ids (list)

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

(string)

Syntax:

"string" "string" ...

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

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

Output

Results -> (list)

A list of DataQualityResult objects representing the data quality results.

(structure)

Describes a data quality result.

ResultId -> (string)

A unique result ID for the data quality result.

Score -> (double)

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

DataSource -> (structure)

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

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)

RulesetName -> (string)

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

EvaluationContext -> (string)

In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data quality nodes will have names. In the case of multiple nodes, the evaluationContext can differentiate the nodes.

StartedOn -> (timestamp)

The date and time when this data quality run started.

CompletedOn -> (timestamp)

The date and time when this data quality run completed.

JobName -> (string)

The job name associated with the data quality result, if any.

JobRunId -> (string)

The job run ID associated with the data quality result, if any.

RulesetEvaluationRunId -> (string)

The unique run ID for the ruleset evaluation for this data quality result.

RuleResults -> (list)

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

(structure)

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

Name -> (string)

The name of the data quality rule.

Description -> (string)

A description of the data quality rule.

EvaluationMessage -> (string)

An evaluation message.

Result -> (string)

A pass or fail status for the rule.

EvaluatedMetrics -> (map)

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

key -> (string)

value -> (double)

AnalyzerResults -> (list)

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

(structure)

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

Name -> (string)

The name of the data quality analyzer.

Description -> (string)

A description of the data quality analyzer.

EvaluationMessage -> (string)

An evaluation message.

EvaluatedMetrics -> (map)

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

key -> (string)

value -> (double)

Observations -> (list)

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

(structure)

Describes the observation generated after evaluating the rules and analyzers.

Description -> (string)

A description of the data quality observation.

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.

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)

ResultsNotFound -> (list)

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

(string)