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.
Lists all the runs meeting the filter criteria, where a ruleset is evaluated against a data source.
See also: AWS API Documentation
list-data-quality-ruleset-evaluation-runs
[--filter <value>]
[--next-token <value>]
[--max-results <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>]
--filter
(structure)
The filter criteria.
DataSource -> (structure)
Filter based on a data source (an Glue table) associated with the 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)
StartedBefore -> (timestamp)
Filter results by runs that started before this time.StartedAfter -> (timestamp)
Filter results by runs that started after this time.
Shorthand Syntax:
DataSource={GlueTable={DatabaseName=string,TableName=string,CatalogId=string,ConnectionName=string,AdditionalOptions={KeyName1=string,KeyName2=string}}},StartedBefore=timestamp,StartedAfter=timestamp
JSON Syntax:
{
"DataSource": {
"GlueTable": {
"DatabaseName": "string",
"TableName": "string",
"CatalogId": "string",
"ConnectionName": "string",
"AdditionalOptions": {"string": "string"
...}
}
},
"StartedBefore": timestamp,
"StartedAfter": timestamp
}
--next-token
(string)
A paginated token to offset the results.
--max-results
(integer)
The maximum number of results to return.
--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.
--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.
--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.
--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.
Runs -> (list)
A list of
DataQualityRulesetEvaluationRunDescription
objects representing data quality ruleset runs.(structure)
Describes the result of a data quality ruleset evaluation run.
RunId -> (string)
The unique run identifier associated with this run.Status -> (string)
The status for this run.StartedOn -> (timestamp)
The date and time when the run started.DataSource -> (structure)
The data source (an Glue table) associated with the 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)
NextToken -> (string)
A pagination token, if more results are available.