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 ]

list-data-quality-rulesets

Description

Returns a paginated list of rulesets for the specified list of Glue tables.

See also: AWS API Documentation

Synopsis

  list-data-quality-rulesets
[--next-token <value>]
[--max-results <value>]
[--filter <value>]
[--tags <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

--next-token (string)

A paginated token to offset the results.

--max-results (integer)

The maximum number of results to return.

--filter (structure)

The filter criteria.

Name -> (string)

The name of the ruleset filter criteria.

Description -> (string)

The description of the ruleset filter criteria.

CreatedBefore -> (timestamp)

Filter on rulesets created before this date.

CreatedAfter -> (timestamp)

Filter on rulesets created after this date.

LastModifiedBefore -> (timestamp)

Filter on rulesets last modified before this date.

LastModifiedAfter -> (timestamp)

Filter on rulesets last modified after this date.

TargetTable -> (structure)

The name and database name of the target table.

TableName -> (string)

The name of the Glue table.

DatabaseName -> (string)

The name of the database where the Glue table exists.

CatalogId -> (string)

The catalog id where the Glue table exists.

Shorthand Syntax:

Name=string,Description=string,CreatedBefore=timestamp,CreatedAfter=timestamp,LastModifiedBefore=timestamp,LastModifiedAfter=timestamp,TargetTable={TableName=string,DatabaseName=string,CatalogId=string}

JSON Syntax:

{
  "Name": "string",
  "Description": "string",
  "CreatedBefore": timestamp,
  "CreatedAfter": timestamp,
  "LastModifiedBefore": timestamp,
  "LastModifiedAfter": timestamp,
  "TargetTable": {
    "TableName": "string",
    "DatabaseName": "string",
    "CatalogId": "string"
  }
}

--tags (map)

A list of key-value pair tags.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON 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

Rulesets -> (list)

A paginated list of rulesets for the specified list of Glue tables.

(structure)

Describes a data quality ruleset returned by GetDataQualityRuleset .

Name -> (string)

The name of the data quality ruleset.

Description -> (string)

A description of the data quality ruleset.

CreatedOn -> (timestamp)

The date and time the data quality ruleset was created.

LastModifiedOn -> (timestamp)

The date and time the data quality ruleset was last modified.

TargetTable -> (structure)

An object representing an Glue table.

TableName -> (string)

The name of the Glue table.

DatabaseName -> (string)

The name of the database where the Glue table exists.

CatalogId -> (string)

The catalog id where the Glue table exists.

RecommendationRunId -> (string)

When a ruleset was created from a recommendation run, this run ID is generated to link the two together.

RuleCount -> (integer)

The number of rules in the ruleset.

NextToken -> (string)

A pagination token, if more results are available.